Skip to main content
Glama

workflow_get

Read-only

Read only. Returns one workflow's definition: its steps (nodes), the connections between them, its inputs and its version information. Without versionId it returns the version that serves runs. It does not run or change the workflow.

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": {
      "workflowId": "<workflowId>"
    },
    "name": "workflow_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
versionIdNoOptional version UUID (from workflow_versions_list). If omitted, returns the version that serves runs: the trial version while a trial runs, otherwise the active version, and the latest saved version only when no version is active yet. The result names the version it returned.
workflowIdYesThe workflow ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so 'Read only' and 'does not run or change the workflow' are largely confirmations rather than new information. What the description does add is the resolution rule for which version is returned when no versionId is supplied, which matters behaviorally for interpreting the result. It says nothing about errors for a missing workflowId or unknown versionId, leaving a small gap.

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

Conciseness4/5

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

Front-loaded with the read-only nature and the returned payload before the version-resolution caveat, with no filler sentences. The opening 'Read only.' is mildly redundant against readOnlyHint=true, but it costs little and frames the rest.

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

Completeness5/5

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 takes on the job of describing the return value, and it does so by naming the returned components (steps, connections, inputs, version info). Combined with the version-resolution rule and the explicit exclusion of side effects, an agent has everything needed to call this correctly.

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%, and the versionId property already spells out the trial/active/latest-saved resolution order in more detail than the description does. The description's one sentence on versionId therefore largely restates the schema rather than adding format, constraints, or examples. Baseline 3 is appropriate when the schema carries the parameter burden.

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

Purpose5/5

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

States a specific verb and resource ('Returns one workflow's definition') and enumerates exactly what comes back: nodes, connections, inputs, and version information. The closing sentence ('does not run or change the workflow') separates it from the execution siblings such as workflow_execute and workflow_test_run, and the singular scope separates it from workflow_list and workflow_get_node.

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

Usage Guidelines4/5

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

Gives a clear when-to-use condition by explaining the default version resolution when versionId is omitted, and a clear when-not by ruling out execution or mutation. It stops short of naming the alternative tools (workflow_execute, workflow_get_versions, workflow_list), so the routing is implied rather than explicit.

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.