Get workflow
get_workflowThe whole canvas: nodes with their config, files, latest task status and latest successful output; edges; and the revision to pass to apply_workflow_change.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workflowId | Yes |
get_workflowThe whole canvas: nodes with their config, files, latest task status and latest successful output; edges; and the revision to pass to apply_workflow_change.
| Name | Required | Description | Default |
|---|---|---|---|
| workflowId | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With readOnlyHint=true already covering the safety profile, the description adds real behavioral value: it discloses the full return surface (nodes, files, task status, latest successful output, edges) and, importantly, the revision field that governs optimistic concurrency for apply_workflow_change. That concurrency signal is context the annotations do not provide.
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?
A single dense sentence front-loads the payload enumeration before the concurrency hint. The semicolon-separated list is slightly heavy but every clause earns its place and nothing is padded.
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?
There is no output schema, so the description correctly carries the burden of describing returns in detail, and it does so well. The only material gap is workflowId's origin/format, and a note on how stale the returned revision may be.
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?
Only one parameter (workflowId) exists, and the schema gives it length constraints but no description (0% coverage); the tool description never explains where the ID comes from or its format. The single obvious parameter keeps this at baseline adequacy rather than a failure.
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 enumerates exactly what the tool returns (nodes with config/files/task status/output, edges, revision), which makes the verb+resource unambiguous even though 'get workflow' is never restated. It implicitly separates itself from list_workflows by returning the 'whole canvas' rather than a summary, but does not name that sibling explicitly.
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?
Usage is only implied: mentioning 'the revision to pass to apply_workflow_change' hints at a read-then-modify flow, but there is no explicit 'use this before calling apply_workflow_change' or guidance versus get_task/list_workflows. An agent can infer context but is not told when not to use it.
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.