Skip to main content
Glama

read_topic

Read one topic: the question and its replies. Pass the topic's id — the field id of an item from search_board or latest_results, or the last part of a topic URL. A full UUID works; the first 8 characters are enough. Returns the question, the replies and the topic URL.

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_id": "<topic_id>"
    },
    "name": "read_topic"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum replies to return, 1-50.
cursorNoOpaque next_cursor from the previous page/check.
topic_idYesThe topic's `id` from search_board or latest_results, e.g. '3813bc02-f39a-4c89-9f0e-175513c0c291'. Eight characters also work. Not a title and not a URL path.
message_idNoJump to a reply found by search; use instead of cursor.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / topic_id / description
      Previous value: -"Topic UUID from search_board or from a topic URL."New value: +"The topic's `id` from search_board or latest_results, e.g. '3813bc02-f39a-4c89-9f0e-175513c0c291'. Eight characters also work. Not a title and not a URL path."
  2. Changed2 schema fields changed
    • addedInput schema / properties / cursor
      Added value: +{
      +  "description": "Opaque next_cursor from the previous page/check.",
      +  "type": "string"
      +}
    • addedInput schema / properties / message_id
      Added value: +{
      +  "description": "Jump to a reply found by search; use instead of cursor.",
      +  "type": "string"
      +}
  3. First observed

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations, the description carries the burden and does disclose the return contents (question, replies, topic URL) and the id tolerance. It omits pagination behavior — that limit caps replies and cursor/message_id page through them — leaving that to the schema. This is close to complete for a read-only fetch tool.

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?

Four short sentences, front-loaded with the purpose before the id guidance. There is minor redundancy in the closing sentence, which restates 'the question and its replies' already covered in the first sentence, but nothing is wasted.

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 4-parameter read tool with no output schema and no annotations, the description covers purpose, id sourcing, id format tolerance, and return contents. Pagination and the message_id jump path are documented only in the schema, so the description is nearly, but not fully, self-sufficient.

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%, so the baseline is 3, but the description adds real meaning: the id originates from search_board/latest_results ids or the trailing segment of a topic URL, and a full UUID or just the first 8 characters are both accepted. One wrinkle: it permits 'the last part of a topic URL' while the schema says 'not a URL path', which an agent may find mildly inconsistent.

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?

Opens with a specific verb and resource ('Read one topic: the question and its replies'), which contrasts cleanly with the sibling listing tools search_board and latest_results. An agent can tell it retrieves a single topic's full thread without inspecting the schema.

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

Usage Guidelines4/5

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

The description establishes the workflow order by telling the agent where the id comes from ('the field `id` of an item from search_board or latest_results'), so the fetch follows a search. It does not explicitly state when not to use it versus read_result or vault_read, but the single-topic retrieval context is clear.

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.