Skip to main content
Glama

Report workflow step

report_workflow_step

Report the agent client's outcome and optional measured costs for a workflow step that has no expected lifecycle tool, a failure, the self-improvement step, or the client score. A step with an expected lifecycle tool is completed by that tool, which also accepts the client metrics, so it needs no report; failed blocks a step for another attempt. Optional stages are bypassed only by choosing a configured available edge with resume_workflow before entering them; once entered, every step is required. A completed self-improvement report closes that step and its reason describes what changed and why, or why nothing did. Research content is never stored. When one route follows, the response carries the next step's instructions; when several do, choose one with resume_workflow and its instructions arrive then.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
runIdYesId of the Workflow run.
reasonNoWhat happened and why.
statusYescompleted, or failed to block the step for another attempt.
stepIdYesId of the step being reported.
metricsNoOptional client measurements for the step.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

With readOnlyHint=false and destructiveHint=false already declaring the write/safe profile, the description still adds real behavioral context: 'failed blocks a step for another attempt', a completed self-improvement report 'closes that step', and 'Research content is never stored'. These are non-obvious state effects an agent needs before calling.

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

Conciseness3/5

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

The purpose is front-loaded, but the description runs long and dense, packing several distinct rules into multi-clause sentences. Useful content is present, yet the lack of separation between usage, state effects and response behavior makes it harder to scan than it needs to be.

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 no output schema, the description carries the return-value burden and does address it ('When one route follows, the response carries the next step's instructions; when several do, choose one with resume_workflow'). For a mutation tool it also covers the key state effects and the no-research-storage rule, leaving only minor gaps.

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%, so the schema already documents runId, stepId, status, reason and metrics; the baseline of 3 applies. The description adds only marginal parameter meaning ('failed blocks the step for another attempt', reason as 'what changed and why'), which largely overlaps with behavioral context rather than extending syntax or format.

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 and resource ('Report ... for a workflow step') and enumerates the outcome types it covers (no lifecycle tool, failure, self-improvement step, client score). An agent can identify the action, though the opening clause is syntactically tangled enough that the scope takes a second read.

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 concrete when-to-use conditions ('a workflow step that has no expected lifecycle tool, a failure, the self-improvement step, or the client score') and routes the agent elsewhere for lifecycle steps ('A step with an expected lifecycle tool is completed by that tool'), naming resume_workflow as the alternative for optional stages. Guidance is present but buried in dense prose rather than stated crisply as when/when-not.

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