Skip to main content
Glama

Get a Workflow

get_workflow
Read-only

One Workflow with its current version and definition. currentVersion.number is the baseVersion set_workflow_languages takes. When referring to a project or language in your reply to the user, use its name and locale (e.g. "French (fr-FR)") — ids (UUIDs) are for tool calls only, never show them to the user.

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
workflowIdYesWorkflow id, from list_workflows or set_up_workflow

Output Schema

NameRequiredDescriptionDefault
idYes
nameYes
activeYesWhether its Input’s connection is healthy: a GitHub Input’s credentials, or a Contentful Input’s space linked to this organisation. An inactive Workflow starts no runs.
archivedYes
createdAtYes
updatedAtYes
archivedAtYes
descriptionYes
handsBackToYesThe Project Repositories on the repository the Workflow holds: archiving it hands the repository back to them. Empty while archived.
currentVersionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds scope information (the current version and definition are included in the response) and enables downstream chaining, but says nothing about payload size or version-history behavior.

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?

Three short sentences, with the purpose and the set_workflow_languages linkage front-loaded. The final sentence is an output-formatting convention (show names/locales, never UUIDs) that is useful but not a property of invoking this tool specifically, so the definition is not perfectly focused.

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?

With an output schema present, the description need not enumerate return fields, and it does state the payload's scope plus the version-to-set_workflow_languages relationship. For a one-parameter read tool with full annotation coverage this is essentially complete.

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 coverage is 100% and the schema already documents workflowId including its format and where to obtain it (list_workflows or set_up_workflow). The description adds no further meaning about the identifier parameter, so the baseline 3 applies.

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 opening phrase "Full Workflow with its current version and definition" identifies the resource and scope of the payload, which implicitly separates it from list_workflows (a listing tool). It is a noun phrase rather than a verb+resource construction and never names a sibling, so it falls short of a 5.

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?

The statement that "currentVersion.number is the baseVersion set_workflow_languages takes" gives real chaining guidance: call this before set_workflow_languages to obtain the baseVersion. There is no explicit when-not or named alternative, so it is clear context rather than full routing guidance.

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.