Skip to main content
Glama

Inspect a unit of work

ratchet_get_group
Read-onlyIdempotent

Shows every step in a multi-step unit of work: what succeeded, what can still be undone, what has already been undone, what is irreversible, and what has an unknown outcome. Use it to answer "where did this workflow actually get to?" after a crash, without changing anything.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
group_keyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already mark it read-only, idempotent, and non-destructive; the description reinforces that with 'without changing anything' and adds useful state-semantics context (undoable, undone, irreversible, unknown). This goes beyond simply restating the annotations, though it does not address auth or rate-limit behavior.

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?

Two tight sentences front-load the core behavior before the use case, and every phrase earns its place. The description is easy to scan and free of filler.

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 single-parameter, read-only inspection tool with no output schema, the description covers the tool's purpose, output categories, and canonical use case. It leaves minor gaps around group_key semantics and error behavior, but nothing critical for deciding to call it.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema provides only a string type and no description for group_key, and the description never names or explains the parameter. An agent must infer that group_key identifies the unit of work from the tool name; the description does not define its form, how to obtain it, or any constraints.

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 names a specific action and resource: it 'shows every step in a multi-step unit of work' and enumerates exactly which categories of step state are reported. This makes it easy to distinguish from sibling inspection tools like get_run or get_effect, which target different resources.

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?

It gives an explicit trigger context: use it to answer 'where did this workflow actually get to?' after a crash. It does not, however, contrast itself with sibling inspection tools or state when not to use it, so it stops short of full alternative routing.

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.