Skip to main content
Glama

help

Read-onlyIdempotent

Read capability or troubleshooting guidance when needed; generation does not require this call. Returns topic, summary, capabilities or steps, docsUrl and version metadata. Use list_models for current model prices, account for personal access, and spending_policy for automatic-spending authorization.

Input Schema

NameRequiredDescriptionDefault
topicNoHelp topic; omit for the capability matrix.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / topic / description
      Added value: +"Help topic; omit for the capability matrix."
    • changedInput schema / properties / topic / enum
      Previous value: -[
      -  "quickstart",
      -  "generate",
      -  "derive",
      -  "enhance",
      -  "compare",
      -  "models",
      -  "async_batch",
      -  "prompts",
      -  "account",
      -  "billing",
      -  "tasks",
      -  "examples",
      -  "update",
      -  "troubleshooting"
      -]New value: +[
      +  "quickstart",
      +  "generate",
      +  "derive",
      +  "enhance",
      +  "reverse",
      +  "compare",
      +  "models",
      +  "async_batch",
      +  "prompts",
      +  "account",
      +  "billing",
      +  "tasks",
      +  "examples",
      +  "update",
      +  "troubleshooting"
      +]
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and idempotentHint, so safety is covered. The description adds real value by disclosing the return shape (topic, summary, capabilities or steps, docsUrl, version metadata), which matters because no output schema exists, and by stating the call is optional. It stops short of describing size/limits of the capability matrix, so not a 5.

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?

Three sentences, all load-bearing, with the optionality caveat and return shape front-loaded. The final routing sentence is slightly compressed ('account for personal access') but still parses correctly, costing little.

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 no output schema, the description correctly compensates by enumerating the returned fields, and it covers the optional-use case and sibling routing. For a single-enum-parameter read tool this is essentially complete; only finer detail about the capability matrix itself is absent.

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 enum description already covers 'omit for the capability matrix', so the baseline is 3. The description adds topic-selection guidance beyond the schema by implying which subject areas belong to other tools (prices, account, spending), helping an agent pick a topic rather than guessing.

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+resource: reading capability or troubleshooting guidance, and immediately scopes it as optional ('generation does not require this call'). It also names the sibling tools that own adjacent needs (list_models, account, spending_policy), so an agent can distinguish it from them without opening schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly gives the when-not condition ('generation does not require this call') and routes three concrete needs to alternatives: model prices to list_models, personal access to account, automatic-spending authorization to spending_policy. This is close to a complete routing table for the help/account/billing cluster.

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