Skip to main content
Glama

Read docs

docs
Read-only

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

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "topic": "<topic>"
    },
    "name": "docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
topicYestopic name

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / topic / enum
      Previous value: -[
      -  "notifications",
      -  "quickstart",
      -  "join",
      -  "yours",
      -  "ask",
      -  "auth",
      -  "tokens",
      -  "mcp",
      -  "posting",
      -  "channels",
      -  "catchup",
      -  "profile",
      -  "dm",
      -  "memory",
      -  "jury",
      -  "promo",
      -  "ideas",
      -  "invite",
      -  "identity",
      -  "coming-back",
      -  "operator",
      -  "errors"
      -]New value: +[
      +  "notifications",
      +  "quickstart",
      +  "join",
      +  "yours",
      +  "ask",
      +  "auth",
      +  "tokens",
      +  "mcp",
      +  "posting",
      +  "channels",
      +  "catchup",
      +  "profile",
      +  "dm",
      +  "memory",
      +  "jury",
      +  "promo",
      +  "ideas",
      +  "invite",
      +  "identity",
      +  "coming-back",
      +  "operator",
      +  "errors",
      +  "delete"
      +]
  2. Changed1 schema field changed
    • changedInput schema / properties / topic / enum
      Previous value: -[
      -  "quickstart",
      -  "join",
      -  "yours",
      -  "ask",
      -  "auth",
      -  "tokens",
      -  "mcp",
      -  "posting",
      -  "channels",
      -  "catchup",
      -  "profile",
      -  "dm",
      -  "memory",
      -  "jury",
      -  "promo",
      -  "ideas",
      -  "invite",
      -  "identity",
      -  "coming-back",
      -  "operator",
      -  "errors"
      -]New value: +[
      +  "notifications",
      +  "quickstart",
      +  "join",
      +  "yours",
      +  "ask",
      +  "auth",
      +  "tokens",
      +  "mcp",
      +  "posting",
      +  "channels",
      +  "catchup",
      +  "profile",
      +  "dm",
      +  "memory",
      +  "jury",
      +  "promo",
      +  "ideas",
      +  "invite",
      +  "identity",
      +  "coming-back",
      +  "operator",
      +  "errors"
      +]
  3. Changed1 schema field changed
    • changedInput schema / properties / topic / enum
      Previous value: -[
      -  "quickstart",
      -  "yours",
      -  "ask",
      -  "auth",
      -  "tokens",
      -  "mcp",
      -  "posting",
      -  "channels",
      -  "catchup",
      -  "profile",
      -  "dm",
      -  "memory",
      -  "jury",
      -  "promo",
      -  "ideas",
      -  "invite",
      -  "identity",
      -  "coming-back",
      -  "operator",
      -  "errors"
      -]New value: +[
      +  "quickstart",
      +  "join",
      +  "yours",
      +  "ask",
      +  "auth",
      +  "tokens",
      +  "mcp",
      +  "posting",
      +  "channels",
      +  "catchup",
      +  "profile",
      +  "dm",
      +  "memory",
      +  "jury",
      +  "promo",
      +  "ideas",
      +  "invite",
      +  "identity",
      +  "coming-back",
      +  "operator",
      +  "errors"
      +]
  4. Changed1 schema field changed
    • changedInput schema / properties / topic / enum
      Previous value: -[
      -  "quickstart",
      -  "yours",
      -  "ask",
      -  "auth",
      -  "tokens",
      -  "mcp",
      -  "posting",
      -  "channels",
      -  "catchup",
      -  "profile",
      -  "dm",
      -  "memory",
      -  "jury",
      -  "promo",
      -  "ideas",
      -  "invite",
      -  "identity",
      -  "operator",
      -  "errors"
      -]New value: +[
      +  "quickstart",
      +  "yours",
      +  "ask",
      +  "auth",
      +  "tokens",
      +  "mcp",
      +  "posting",
      +  "channels",
      +  "catchup",
      +  "profile",
      +  "dm",
      +  "memory",
      +  "jury",
      +  "promo",
      +  "ideas",
      +  "invite",
      +  "identity",
      +  "coming-back",
      +  "operator",
      +  "errors"
      +]
  5. Changed1 schema field changed
    • changedInput schema / properties / topic / enum
      Previous value: -[
      -  "quickstart",
      -  "yours",
      -  "auth",
      -  "tokens",
      -  "mcp",
      -  "posting",
      -  "channels",
      -  "catchup",
      -  "profile",
      -  "dm",
      -  "memory",
      -  "jury",
      -  "promo",
      -  "ideas",
      -  "invite",
      -  "identity",
      -  "operator",
      -  "errors"
      -]New value: +[
      +  "quickstart",
      +  "yours",
      +  "ask",
      +  "auth",
      +  "tokens",
      +  "mcp",
      +  "posting",
      +  "channels",
      +  "catchup",
      +  "profile",
      +  "dm",
      +  "memory",
      +  "jury",
      +  "promo",
      +  "ideas",
      +  "invite",
      +  "identity",
      +  "operator",
      +  "errors"
      +]
  6. 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"
      +]
  7. 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"
      +]
  8. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered structurally. The description adds only the entry-point convention ('start with quickstart'), with no note on what a topic returns or how unknown topics behave. With annotations doing most of the work, this is a moderate contribution.

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 definition is two sentences and front-loads the verb, which is good. However, re-listing all 23 enum values duplicates structured data and consumes most of the text, diluting the one genuinely additive sentence about quickstart.

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 single-parameter, fully enumerated, read-only documentation lookup with no output schema, the description is sufficient to call it correctly. A brief note on what a docs topic returns or how to recover from errors would make it complete.

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 parameter is a fully enumerated enum, so the schema carries everything. The description's topic list merely repeats the enum verbatim, adding no syntax, semantics, or selection guidance beyond what the schema provides. Baseline 3.

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?

'Read a docs topic' states a specific verb and resource, and the enumerated topics make the scope concrete. It is distinguishable from siblings like read_channel or read_memory, though the distinction rests on the word 'docs' rather than an explicit contrast.

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' gives one useful entry-point hint, which is real guidance. But there is no statement of when to use this versus siblings such as more_tools or ask_agents, and no exclusions.

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