publish_workflow
Publish a workflow version to an environment.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| env | Yes | ||
| snippet_id | No | Deprecated alias for workflow_id. | |
| workflow_id | Yes | Workflow ID. | |
| version_number | Yes |
Publish a workflow version to an environment.
| Name | Required | Description | Default |
|---|---|---|---|
| env | Yes | ||
| snippet_id | No | Deprecated alias for workflow_id. | |
| workflow_id | Yes | Workflow ID. | |
| version_number | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. 'Publish' implies a mutation, but the description does not disclose whether the operation overwrites an existing deployment, whether it is reversible, whether approvals or permissions are needed, or what happens to the source version after publication.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, concise sentence with no filler or repetition. It says what the tool does in a direct and front-loaded manner.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has four parameters, no annotations, and no output schema, yet the description offers only minimal information. A complete definition would clarify the meaning of version_number, the practical difference between environments, the deprecation of snippet_id, and the likely outcome or return value of publishing. The current description leaves these important operational details unspecified.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 50%, and the description does not compensate. It conveys that a version number is published to an environment but adds no meaning beyond the field names and existing schema descriptions. The semantics of version_number and env are left entirely to the schema's enum and type declarations, and the deprecated snippet_id alias is only clarified in the schema, not in the description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action (publish), the resource (a workflow version), and the destination (an environment). This distinguishes it from sibling tools like create_workflow and invoke_workflow, which address creation and execution rather than deployment.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives such as update_draft or invoke_workflow. The tool's role as a deployment step is implied by the name and description, but there is no explicit context about prerequisites, sequencing, or conditions under which a sibling tool would be more appropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Every tool has a clearly distinct purpose: workflow lifecycle, invocation, logging, metrics, KV store, secrets, connections, and documentation. Even similar tools like get_logs vs get_invocation are well-differentiated by descriptions.
Most tools follow a consistent verb_noun pattern (create_workflow, get_workflow, list_workflows). The KV tools (kv_get, kv_set, kv_list, kv_delete) are internally consistent but deviate from the dominant verb_noun style by using a noun_verb prefix.
With 18 tools, the count is slightly above the typical 3-15 range, but the broad platform scope (workflow management, invocation, logging, metrics, KV, secrets, connections, docs) justifies each tool's existence. No tool feels redundant.
Workflows have create, read, update (via update_draft), list, and publish, but lack a delete operation. Secrets support create and list but no delete/update, and connections only have list. These lifecycle gaps create potential dead ends for agents.