Skip to main content
Glama

Read a ThreadPage guide

get_guide
Read-onlyIdempotent

Read a ThreadPage guide for agents, as Markdown; every level may read it. Read "formatting" before writing tables, checklists, images, files or Note references, or before editing a Note. Read "working" (it is long) when an error code, a request or a multi-step edit is unclear.

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

Input Schema

NameRequiredDescriptionDefault
topicYes"formatting": every Markdown and document element, Note references, images and limits. "working": every tool, safe editing, operation IDs and retries, limits, errors, requests and safety.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive and local-only, so the safety profile is covered. The description adds two useful traits beyond them: the return payload is Markdown and one topic is long (a size/cost warning). It still doesn't describe how large the Markdown is or whether it can be fetched repeatedly without cost.

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 dense sentences, front-loaded with what the tool returns and its access scope, followed by the per-topic triggers. Nothing is wasted, though the quoted topic names and parenthetical are packed tightly enough to be mildly hard to scan.

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

Completeness5/5

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

A single-parameter documentation fetch with a full enum schema and no output schema (output is Markdown). The description covers purpose, access, payload format, and when to fetch each topic — nothing an agent needs in order to call it correctly is missing.

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 both enum values are already documented, so the schema carries the baseline. The description adds decision meaning on top: which operational moment selects "formatting" versus "working", plus the caveat that "working" is long. That is more than restating the enum.

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?

A specific verb and resource ("Read a ThreadPage guide ... as Markdown") with the scope of who can read it ("every level may read it"). It is unmistakably distinct from the CRUD siblings in the list (get_note, get_thread, get_access), which all return workspace data rather than documentation.

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?

Explicit triggers are given per topic: "formatting" before writing tables, checklists, images, files, Note references, or editing a Note; "working" when an error code, a request, or a multi-step edit is unclear. This is genuine when-to-use routing keyed to the enum values, not vague advice.

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.