Skip to main content
Glama

Context guide for an operation

read_guide
Read-onlyIdempotent

Use before reporting results from an operation, to get its definitions, sample-size rules and the required wording. The context guide for an operation (get_pay, get_postings, lookup, crosswalk, describe_dimension_value, list_fx_rates, list_periods): parameters, rules, minimum sample sizes, and how to word results. Free.

Input Schema

NameRequiredDescriptionDefault
operationYesOperation ID, e.g. get_pay.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive/closed-world, so safety is covered. The description adds value beyond them by disclosing that the guide returns definitions, minimum sample sizes and required result wording, plus that the call is 'Free' — useful cost context. It stops short of describing output shape in detail, but no output schema exists to do that either.

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 usage trigger is front-loaded, but the payload is stated twice in nearly identical form ('definitions, sample-size rules and the required wording' vs 'parameters, rules, minimum sample sizes, and how to word results'). The duplication wastes space and slightly muddies which phrasing is canonical.

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 one required parameter, no output schema, and annotations covering safety, the description supplies the missing pieces: when to call it, which operations it covers, and roughly what it returns. The enumeration of operations could drift out of sync with the actual supported set, but for an agent's purposes it is complete enough to invoke correctly.

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?

Schema coverage is 100% and the schema only gives 'e.g. get_pay' as a sample value. The description adds real meaning by enumerating the operation IDs the guide supports (get_pay, get_postings, lookup, crosswalk, describe_dimension_value, list_fx_rates, list_periods), which the schema does not.

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?

States a specific verb and resource ('get its definitions, sample-size rules and the required wording') and frames it as a pre-reporting context lookup, which is clearly distinct from data siblings like get_pay or crosswalk. An agent can tell this is a metadata/guidance tool, not a data-fetch tool.

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?

'Use before reporting results from an operation' gives an explicit trigger condition, which is the key routing signal. It does not state when not to use it or what to do if the operation is absent from the list, so it falls short of a full when/when-not treatment.

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