Skip to main content
Glama

core.blue

Read a topic

read_topic
Read-onlyIdempotent

Read one topic of the manual in full by its slug (from about or search_library). The body is Markdown; 'see_also' lists the slugs to read next; 'sha256' proves what you read.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesThe topic's slug, e.g. 'getting-a-house'.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesThe topic in Markdown.
slugYesThe stable identifier of the topic.
tagsYesKeywords; the first names the group of the topic.
titleYesThe title of the topic.
sha256YesSHA-256 of the body as served, lower-case hex; cite it to prove what you read.
statusYes'draft' or 'published'. A draft has not been reviewed by the operator yet.
summaryYesOne or two sentences that answer the question the title asks.
see_alsoYesSlugs of the topics to read next.

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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 readOnly, idempotent, non-destructive, closed-world, so safety is covered. The description adds genuinely new behavioral context: the body is Markdown, 'see_also' chains to further slugs, and 'sha256' lets the caller verify the content read. It stops short of mentioning error behavior for a bad slug.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single dense sentence front-loads the operation and key, then uses two short clauses for the return contract. No filler and nothing that could be cut without losing meaning.

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?

One required parameter, full schema coverage, an output schema in place, and annotations covering the safety profile. The description supplements the output schema with the chaining hint (see_also) and verification hint (sha256), leaving nothing an agent needs to invoke it correctly.

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 single parameter is already documented with an example, so the baseline is 3. The description adds provenance meaning ('from about or search_library') that the schema does not convey, telling the agent where a valid slug comes from.

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 and resource ('Read one topic of the manual in full') plus the lookup key ('by its slug'), which cleanly separates it from sibling search_library and about. An agent can identify the operation without opening 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?

Names the source of the required slug ('from about or search_library'), which implicitly tells the agent this tool is the follow-up step after those two. It does not state when-not to use it or what to do if the slug is unknown, so it stops short of full routing guidance.

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