Skip to main content
Glama
DOC Model Safety Gate

DOC Model Safety Gate

by laceykes

getWorkflow

Retrieves a workflow definition by ID so agents can inspect the approval and audit rules behind staged content changes.

Instructions

Get one workflow definition by ID.

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": {
      "id": "<id>"
    },
    "name": "getWorkflow"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesWorkflow definition ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden and doesn't meet it. It conveys read-only semantics only through the word 'Get', and says nothing about what a 'definition' includes (nodes, edges, version, publication state) or what happens on an unknown ID.

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?

One short, front-loaded sentence with no filler. It is efficient, though its brevity comes at the cost of the missing behavioral details noted elsewhere.

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

Completeness3/5

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

For a single-parameter read tool this is minimally adequate, especially since readers can infer the target from the name. But with no output schema and no annotations, the description should at least sketch the shape of the returned definition and note the not-found behavior.

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 single id parameter is fully documented there, so the description's 'by ID' adds nothing new. Baseline 3 applies when the schema does the work.

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?

States a specific verb+resource: fetch a single workflow *definition* (as opposed to run status or nodes) by its ID. That resource distinction is enough for an agent to understand the target, though it never explicitly contrasts itself with siblings like getRunStatus.

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

Usage Guidelines2/5

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

No when-to-use guidance, no mention of when to prefer listWorkflows instead, and no prerequisites. The only implicit cue is 'by ID', which the schema already enforces via the required id field.

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