Skip to main content
Glama

guide

Read-onlyIdempotent

Short how-to docs. topic: ways, canvas, small-steps, html, videos, react, design-systems, reviews, free-plan, confirm, names, or . (such as edit.patch) for that action's params and an example. No topic lists them all.

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": "guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
topicNoA topic from guide({}), or "<tool>.<action>" such as "edit.patch".

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.8/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 behavior, so the safety profile is fully covered elsewhere. The description adds real behavioral context beyond that: content type ('short how-to docs'), the exact topic vocabulary, and that tool.action topics return both params and an example. The wording difficulty noted above is the only real gap.

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?

Two short sentences, front-loaded with the purpose, with no filler. The compression costs a little clarity in 'No topic lists them all', which reads as an unfinished or ambiguous sentence.

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 one-parameter, closed-world read tool with full annotation coverage and no output schema, the description supplies purpose, valid inputs, and the two addressing modes. Only the enumeration behavior and the exact shape of a returned doc remain slightly underspecified.

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 schema already documents the single topic parameter at 100% coverage (baseline 3), but the description goes further by enumerating valid topic values and explaining the '<tool>.<action>' addressing form that the schema only gestures at. That is meaningful added meaning rather than restatement.

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 opens with a concrete statement of what it returns ('Short how-to docs') and enumerates the topic space, including the '<tool>.<action>' form, so an agent knows this is the documentation-lookup tool. It does not differentiate itself from siblings such as read, find, or catalog, which is the only thing keeping it from a 5.

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?

It routes the agent usefully with 'or <tool>.<action> (such as edit.patch) for that action's params and an example', which tells you when the tool.action form applies. However, 'No topic lists them all' is grammatically ambiguous — it could mean omitting the topic enumerates everything, or that no such listing exists — and there is no guidance on when to prefer guide over read/find/catalog.

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.