Skip to main content
Glama

Read a topic or one section

get_topic
Read-onlyIdempotent

Read the full text of a knowledge-base topic, or a single section of it, with tables and verification tags intact. Use after list_topics or search_glazing_knowledge when you need the complete context (e.g. a whole code table). topic accepts a number (30), 'T30', 'Topic 30', or a title phrase ('butt glazed'); section accepts a section id like '30.4', 'sources', 'key', or a heading phrase like 'summary table' or 'bid-day checklist'. Long topics are paged: follow the continue_from hint. Responses keep the KB's confidence tags: [V] verified, [V-mfr] manufacturer claim, [UNVERIFIED], [inference], [Expert] field experience.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicNoTopic number 1-32, 'T30', or a title phrase. Optional if `section` is a full id like '16.6'.
sectionNoSection id ('16.6', 'sources', 'key', '32-A') or heading words ('summary table').
max_charsNoMax characters to return (default 12000).
continue_fromNoSection id to resume paging a long topic from (given in the previous response).
tables_as_recordsNoAlso return section tables as JSON records (header -> value).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
toolYesTool that produced this result.
notesYesNotices: renamed/discontinued products, hints, flags. May be empty.
topicYesThe resolved topic, or null if none matched.
resultsYesSections returned, in order.
disclaimerYesReference-only disclaimer that applies to every answer.
next_sectionYesIf more sections remain, pass this as continue_from to page on.
result_countYesNumber of results/records returned.
available_sectionsYesAll section ids in the resolved topic (empty if none).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so safety is covered; the description goes further by disclosing paging behavior ('long topics are paged: follow the continue_from hint') and the meaning of the returned confidence tags. It does not mention auth, rate limits, or failure modes, but for a closed-world read tool this is solid added context.

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?

Three dense sentences, with purpose and the primary routing hint front-loaded before the format examples and tag legend. The tag enumeration is a little long but each entry carries distinct meaning, so little waste.

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?

With an output schema present, return-value shape need not be spelled out, and the description still covers paging, tag semantics, and accepted parameter formats. An agent has everything needed to call this correctly on the first try.

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 would be 3, but the description adds accepted input formats beyond the schema ('Topic 30', 'butt glazed', 'sources', 'key', 'bid-day checklist'), which genuinely reduces invocation ambiguity. It adds no extra detail for max_chars, tables_as_records, or continue_from beyond what the schema already states.

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+resource ('Read the full text of a knowledge-base topic, or a single section of it') and states the scope distinction (whole topic vs single section) up front. It is clearly separable from list_topics and search_glazing_knowledge, which are named as the discovery counterparts.

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?

Explicitly says to use it 'after list_topics or search_glazing_knowledge when you need the complete context (e.g. a whole code table)', naming both alternatives and the condition that selects this tool over them. That is a genuine when-to-use rule rather than implied usage.

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.