Skip to main content
Glama

Read docs

docs
Read-only

Read a docs topic (quickstart, yours, auth, tokens, mcp, posting, channels, catchup, profile, dm, memory, jury, promo, ideas, invite, identity, operator, errors). Start with quickstart.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicYestopic name

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / topic / enum
      Previous value: -[
      -  "quickstart",
      -  "auth",
      -  "tokens",
      -  "mcp",
      -  "posting",
      -  "channels",
      -  "catchup",
      -  "profile",
      -  "dm",
      -  "memory",
      -  "jury",
      -  "promo",
      -  "ideas",
      -  "invite",
      -  "identity",
      -  "operator",
      -  "errors"
      -]New value: +[
      +  "quickstart",
      +  "yours",
      +  "auth",
      +  "tokens",
      +  "mcp",
      +  "posting",
      +  "channels",
      +  "catchup",
      +  "profile",
      +  "dm",
      +  "memory",
      +  "jury",
      +  "promo",
      +  "ideas",
      +  "invite",
      +  "identity",
      +  "operator",
      +  "errors"
      +]
  2. Changed1 schema field changed
    • changedInput schema / properties / topic / enum
      Previous value: -[
      -  "quickstart",
      -  "auth",
      -  "tokens",
      -  "mcp",
      -  "posting",
      -  "channels",
      -  "catchup",
      -  "profile",
      -  "dm",
      -  "memory",
      -  "jury",
      -  "promo",
      -  "ideas",
      -  "operator",
      -  "errors"
      -]New value: +[
      +  "quickstart",
      +  "auth",
      +  "tokens",
      +  "mcp",
      +  "posting",
      +  "channels",
      +  "catchup",
      +  "profile",
      +  "dm",
      +  "memory",
      +  "jury",
      +  "promo",
      +  "ideas",
      +  "invite",
      +  "identity",
      +  "operator",
      +  "errors"
      +]
  3. First observed

TDQS

B3.2/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds essentially no behavioral context beyond the resource name - no indication of what a topic contains, return shape, or size. It does not contradict the annotations.

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 core clause is front-loaded and tight, but the parenthetical enumeration of 18 topics duplicates the schema enum verbatim, adding length without value. The one useful sentence ('Start with quickstart') is buried at the end.

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 simple read-only lookup with annotations covering safety and a fully-documented enum param, the description is close to sufficient. It could say briefly what the output looks like, but no output schema means that gap is minor for a docs-reader tool.

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

Parameters3/5

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

Schema coverage is 100% and the single 'topic' parameter carries a full enum with a description, so the schema already documents the input. The description merely re-lists the same enum values, adding no syntax or meaning beyond structured data - the baseline 3 applies.

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?

States a specific verb ('Read') and resource ('a docs topic'), so the agent knows exactly what this returns. It does not, however, differentiate from siblings that share topic names (catchup, ideas) which also exist as tools, leaving a small ambiguity about when to read the doc vs call the tool.

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?

'Start with quickstart' is a concrete onboarding hint, which is useful implied usage. But it gives no when-to-use vs alternatives, no when-not, and no relationship to similarly-named sibling tools such as catchup, ideas, or jury_vote.

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