Skip to main content
Glama

help

Read-onlyIdempotent

Look up a tool's complete signature or page the generated catalog with limit and offset until more is false.

Instructions

Read one tool's complete signature, or page the generated catalog using next_offset until more is false.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "help"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
methodNo
offsetNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.2/5.0
Behavior3/5

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

The annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so the safety profile is covered. The description does add genuinely new behavioral context by disclosing the paging loop and its termination condition ('until more is false'). However, it labels the cursor 'next_offset', which does not match the actual 'offset' parameter, and the paging instruction is compressed to the edge of obscurity.

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

Conciseness4/5

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

One sentence, front-loaded with the primary mode and with no filler. The compression costs clarity here, though: the paging clause packs a cursor name and a termination field into a phrase that is hard to parse on first read.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values and the 'more' field need not be described, and the tool is a simple read-only lookup. The gap is the input side: for a 3-parameter tool with zero schema descriptions, the definition must say how to request one tool versus a page, and it does not.

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?

Schema description coverage is 0%, so the description carries the full burden and largely fails. It never explains that a tool name is supplied via the 'method' parameter, which is the single most important thing an agent must know to use the single-lookup mode. It alludes to paging (implying limit/offset) but uses a parameter name, 'next_offset', that does not exist in the schema.

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 names two concrete operations with specific resources: reading a single tool's 'complete signature' and paging the 'generated catalog'. That is enough to distinguish it from siblings like legacy_inspect or doctor. It stops short of 5 because it never says what actually selects the single-tool mode.

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 two described modes: fetch a signature, or page the catalog. There is no explicit statement of when the catalog mode is preferable to a specific lookup, and no alternative sibling is named for either job, so the agent must infer the entry condition.

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