Skip to main content
A Tool is a published workflow that can be dropped into other workflows as a single node, used by the agent, or called via the Runchat API. For an overview of how Tools fit alongside Apps, see Tools and Apps.

Publishing a Tool

You choose which inputs and outputs to expose in the Publish panel, then click publish. The published Tool can be dropped into other canvases as a node, called by the agent and the API, and run from Apps.
  1. Open the workflow’s title menu (the workflow name, top left) and choose Publish app or tool. The Publish panel opens on the right. You can also ask the agent to publish the workflow for you.
  2. Decide what you’re publishing:
    • Nothing selected: you release a new version of the whole workflow. The button reads Publish v2, Publish v3 and so on.
    • Some nodes selected: you publish just those nodes as a new tool. The button reads Publish.
  3. Choose which inputs and outputs to publish by clicking the puzzle piece on the parameter handles themselves:
    • Click an empty puzzle piece (Add to app) to expose that parameter. It fills in, and the parameter appears in the panel
    • Click a filled puzzle piece (Remove from app) to take it back off, or hover the parameter in the panel and click the X
    • The panel lists everything you’ve exposed, inputs and outputs together, in the order a user of the Tool will see them
  4. Pick a thumbnail and add a description at the bottom of the panel. You’ll also see a credit estimate (~/run). Then click the publish button.
Close the panel with the X in its header, or choose Hide publish panel from the title menu. Most Tools should expose only a few inputs and often only a single output. Publishing every parameter usually makes the Tool too cluttered to use.
A workflow with puzzle-piece icons on its parameter handles and the exposed input and output listed in the Publish panel

Adding parameter descriptions

Rename a parameter by editing its label in the Publish panel, and click the label to expand it and add a description. Descriptions are essential when the Tool will be used by an agent, the agent reads them to decide what to pass in. They’re also useful for your future self: you will forget what your inputs do.

Adding the Tool to your nodes

To make the Tool show up in the node picker in every workflow, open its menu on the dashboard and choose Add to my nodes. See Tools and Apps.
Published Tools are saved as workflows. Turn on the Published filter on the dashboard to see only the workflows you’ve published.

Writing a good description

The description on a Tool is what the agent reads when deciding whether to use it. Treat it like you’re describing the Tool to a smart assistant who has no context. Answer:
  • What does it take in?
  • What does it give back?
  • When would you reach for it?
Bad: “Style transfer tool” Good: “Takes an input image and applies the visual style from a reference image. Use when you want to transfer the look of one image (a sketch, a painting, a brand reference) onto a new subject. Returns a single image.”

Next steps