get_workflow
Get full workflow details including all nodes, edges, and their configs. Use node_ids to fetch only specific nodes (reduces token usage for large workflows).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| node_ids | No | ||
| workflow_id | Yes |
Get full workflow details including all nodes, edges, and their configs. Use node_ids to fetch only specific nodes (reduces token usage for large workflows).
| Name | Required | Description | Default |
|---|---|---|---|
| node_ids | No | ||
| workflow_id | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds behavioral context beyond the readOnlyHint annotation by mentioning the token reduction benefit of node_ids. It implies a read-only operation consistent with the annotation, and provides a hint about the default behavior (fetching all nodes and edges) without enumerating side effects or errors.
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 two sentences: the first states the primary purpose, and the second gives a practical usage tip. It is concise, front-loaded with the main action, and contains no redundant or extraneous information.
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?
Given that no output schema is provided, the description adequately covers the tool's core functionality and an important parameter option. It does not need to explain return formats or error handling for this simple read operation, so it is sufficiently complete for its complexity.
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?
The description clarifies the semantics of node_ids as an optional filter to limit fetched nodes, which is not evident from the schema alone. It does not explicitly describe workflow_id, but that parameter is self-explanatory given the tool's purpose. Overall, it compensates well for the lack of schema descriptions.
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 verb 'Get' and the resource 'workflow details', specifying the content as 'all nodes, edges, and their configs'. This distinguishes it from sibling tools like get_node or get_current_workflow by indicating it returns the full workflow structure.
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?
The description gives guidance on when to use the node_ids parameter ('to fetch only specific nodes (reduces token usage for large workflows)'), but does not explicitly compare this tool to alternatives like get_node or get_current_workflow. It implies a use case but lacks direct when/when-not guidance.
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.