Skip to main content
Glama

Inspect workflow state

workflow_status
Read-onlyIdempotent

Retrieve the active edit session details to determine allowed actions, preview changes, spot conflicts, and review recovery journal entries.

Instructions

Return the active edit session, allowed next actions, preview, conflicts, and recovery journal.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYes
nextActionsYes
workflowStateYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint true, idempotentHint true, destructiveHint false). The description adds value by detailing the specific information returned, giving the agent clear expectations for the output. No contradictions with annotations.

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?

A single, compact sentence that leads with the action and lists key deliverables without any filler. Perfectly sized for the tool's simplicity.

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?

Given that an output schema exists and there are no parameters, the description fully covers what the tool returns. The listed components align with the expected workflow state, and no additional information is needed for correct invocation.

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?

The tool has zero parameters, so the baseline is 4. The description appropriately avoids parameter explanations since there are none to document.

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?

The description states a specific verb 'Return' and enumerates the exact state components (active edit session, allowed next actions, preview, conflicts, recovery journal), making its purpose unmistakable. It clearly distinguishes itself from sibling mutation tools like begin_edit_session and abort_edit_session by being an inspection tool.

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?

There is no explicit guidance on when to use this tool versus alternatives. The description does not mention scenarios, exclusions, or conditions, leaving the agent to infer usage. While the purpose is obvious, the lack of any usage direction prevents a higher score.

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