Skip to main content
Glama

Approveit

Describe a workflow

describe_workflow
Read-only

Return a workflow's approval structure: its steps, who approves at each step, and the conditions that route a request between them.

Input Schema

NameRequiredDescriptionDefault
workflow_idYesID of the workflow to describe.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description contributes useful behavioral detail by enumerating what the response contains (steps, approvers, routing conditions), but it says nothing about behavior when the workflow_id does not exist, or whether inactive or draft steps are included, which matters because idempotentHint is false.

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?

One sentence, front-loaded with the verb and the resource, and every clause (steps, approvers, routing conditions) tells the agent something concrete about the payload. No filler and no redundancy.

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 one-parameter read tool with annotations and no output schema, the description covers what an agent needs: that it retrieves a structure rather than mutating anything, and roughly what that structure contains. The only real gap is error/not-found behavior and differentiation from get_workflow_details.

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?

There is a single required parameter with 100% schema description coverage, so the schema already explains 'ID of the workflow to describe'. The description adds no format, sourcing, or lookup hints beyond that, which is the expected baseline when the schema does the heavy lifting.

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 uses a specific verb ('Return') and names the exact resource returned: a workflow's approval structure, including steps, approvers, and routing conditions. It is clear what the tool does, though it does not contrast itself with the nearby sibling get_workflow_details, which an agent could easily confuse it with.

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?

Usage is implied by the phrase 'a workflow's approval structure', which suggests inspection rather than mutation, and the read-only nature is consistent with that. However, there is no explicit when-to-use guidance, no statement of prerequisites, and no routing to the alternatives get_workflow_details or describe_workflow_template.

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.

Resources