Skip to main content
Glama

kb_get_document

Read a requested KB guide or a known source section by slug. Use directly when the user requests the document itself; no preliminary graph call is required. For a general explanation use query_knowledge op=ask, not a document-reading sequence. If a needed slug is unknown, locate it with kb_search or kb_list_documents. Use view=overview for a guide summary; view=section with a returned section_anchor for a specific passage. Content defaults to 6000 characters; offset and next_offset count characters within the selected body. Continue only when the requested material is missing, not merely because has_more is true. full=True is for explicit full-document requests. A document excerpt is educational material; executable signal identities and parameters come from the runtime registry.

Input Schema

NameRequiredDescriptionDefault
fullNoExplicit full content download; cannot combine with offset or max_chars.
slugYesThe document slug.
viewNoUse overview for a brief summary and headings; section for a specific topic; content for document pages.content
offsetNoPagination offset in the result units documented by the tool; zero starts the first page.
max_charsNoPage size, default 6000, capped at 12000 and the response budget.
section_anchorNoExact anchor from overview or search, required only for section view.

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?

No annotations are supplied, so the description carries the full disclosure burden, and it does substantial work: it declares this a read, states the 6000-character default and character-based offset/next_offset units, and warns that has_more alone is not a reason to continue paging. It does not describe failure behavior for unknown slugs or the response envelope, so it falls short of a 5.

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?

Front-loaded with the core action and the routing decision first, then mechanics. It is dense but nearly every clause carries a rule the agent would otherwise guess wrong; a lighter paragraph split would improve scanability but nothing is truly redundant.

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?

For a 6-parameter read tool with no annotations and no output schema, the description covers routing, view selection, pagination units, page-size defaults, the full-download restriction, and a caveat that executable signal identities come from the runtime registry rather than the document. An agent has enough to call it 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 a 3 is the floor; the description goes beyond it by fixing the unit of offset/next_offset as characters within the selected body (the schema only says 'result units') and by tying section_anchor to a value returned by overview or search. It slightly restates the schema's view and full semantics rather than adding new meaning there.

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 a requested KB guide or a known source section by slug') and immediately separates itself from the graph/query tools. It is clearly distinguishable from kb_search, kb_list_documents and query_knowledge without opening any schema.

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?

Gives explicit when-to-use ('use directly when the user requests the document itself; no preliminary graph call is required'), an explicit alternative with its own trigger ('for a general explanation use query_knowledge op=ask'), and a resolution path when the slug is unknown (kb_search / kb_list_documents). It also routes between view modes and restricts full=True to explicit full-document requests.

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.