Skip to main content
Glama

get_workflow

Read the editable workflow graph, including exact existing node sockets, data and connections. Run history is omitted by default; use includeExecutionState only to diagnose execution.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspaceId": "<workspaceId>",
      "workflowId": "<workflowId>"
    },
    "name": "get_workflow"
  }
}

Input Schema

NameRequiredDescriptionDefault
workflowIdYesThe workflow ID
workspaceIdYesThe workspace ID
includeExecutionStateNoInclude cached outputs, partial execution rows and full output history for execution diagnosis.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / includeExecutionState
      Added value: +{
      +  "default": false,
      +  "description": "Include cached outputs, partial execution rows and full output history for execution diagnosis.",
      +  "type": "boolean"
      +}
  2. First observed

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations supplied, the description carries the full behavioral burden. It usefully discloses the default omission of run history and the diagnostic purpose of includeExecutionState, but it does not cover permissions, error behavior, or output size/format.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two compact sentences front-load the core action and then explain the main default/flag behavior. There is no repetitive or wasted wording.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple three-parameter read tool with no output schema, the description adequately says what the returned graph includes and what is omitted by default. It is nearly complete, though it could mention the expected graph output structure or permissions more explicitly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the parameter meanings are already documented in the input schema. The description adds useful context that includeExecutionState is intended only for diagnosis, but it does not add much beyond that baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: "Read the editable workflow graph," and specifies that the result includes node sockets, data, and connections. It distinguishes the default read from execution-history retrieval, though it does not explicitly contrast itself with sibling tools such as get_workflow_summary.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives clear guidance for the includeExecutionState parameter: run history is omitted by default and the flag should be used only to diagnose execution. However, it does not say when to use get_workflow versus get_workflow_summary, list_workflows, or execute_workflow, so tool-selection guidance is only implied.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.