Skip to main content
Glama

Get workflow

get_workflow
Read-onlyIdempotent

Get one workflow's editable graph (nodes, edges, settings) and metadata, including the updatedAt value update_workflow requires. Pass versionNumber to instead get that deployed version's frozen graph together with the version before it (previousVersion, null for version 1), so you can see what changed; list_workflow_versions gives the numbers.

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": "get_workflow"
  }
}

Input Schema

NameRequiredDescriptionDefault
workflowIdYesThe workflow's id, from list_workflows or create_workflow.
versionNumberNoA saved version to read instead of the current draft. Omit for the draft.

Output Schema

NameRequiredDescriptionDefault
idYes
nameYes
edgesNo
nodesNo
statusYes
ownerIdYes
versionNo
settingsNo
createdAtNo
createdByNo
updatedAtYes
authoredViaNo
lastEditedByNo
previousVersionNo
authoredViaClientNo
deployedWorkerUrlNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedOutput schema / properties / createdBy
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "email": {
      +      "type": "string"
      +    },
      +    "userId": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "userId",
      +    "email"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / lastEditedBy
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "email": {
      +      "type": "string"
      +    },
      +    "userId": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "userId",
      +    "email"
      +  ],
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • addedInput schema / additionalProperties
      Added value: +false
  3. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and openWorldHint=false, so safety is covered. The description adds meaningful behavior beyond that: versionNumber switches to a frozen deployed graph and returns previousVersion, with null for version 1, enabling change inspection.

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?

The description is compact and front-loaded, first stating the main result and then the versionNumber behavior. Every clause carries useful information, with no redundant restatement of structured fields.

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?

With annotations covering safety and an output schema documenting return shape, the description only needs to explain call semantics. It fully covers draft versus deployed-version reads, previousVersion behavior, and the updatedAt dependency for updates.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds semantics beyond the schema by explaining that versionNumber fetches a frozen deployed graph plus previousVersion for comparison. It also clarifies that updatedAt is included in the normal response, which matters for update_workflow.

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, and precisely describes what it returns: the editable workflow graph, metadata, and the updatedAt value. It also distinguishes version reads from draft reads and points to list_workflow_versions for version numbers, so an agent can tell it apart from sibling tools.

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?

Explains the primary use case (fetch graph and updatedAt for update_workflow) and the conditional use of versionNumber to inspect a deployed version and its predecessor. It names list_workflow_versions as the source of version numbers, though it does not explicitly state when not to use this tool.

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.