Skip to main content
Glama

kb_get_document

Read-onlyIdempotent

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.

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": {
      "slug": "<slug>"
    },
    "name": "kb_get_document"
  }
}

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.8/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description still adds real behavior: 6000-char default, offset/next_offset counting within the selected body, the rule to continue only when the requested material is missing rather than on has_more alone, and the caveat that excerpts are educational rather than executable signal definitions.

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 purpose and the query_knowledge exclusion before the parameter mechanics. It is dense and slightly overlong at seven sentences, but essentially every sentence carries a routing or pagination constraint rather than filler.

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 read-only fetch with 6 params and no output schema, it covers the entry point, the disambiguation from query_knowledge and kb_search/kb_list_documents, view selection, pagination semantics, and when to stop paging. Nothing needed 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%, so the baseline is 3, and the description earns above that by constraining usage: full=True only for explicit full-document requests, view=section requires a returned section_anchor, and pagination is scoped to 'the selected body.' Only the max_chars cap is repeated from the schema rather than extended.

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+resource: 'Read a requested KB guide or a known source section by slug.' It also distinguishes itself from the knowledge siblings by naming query_knowledge op=ask as the non-document alternative, so an agent can route without opening a 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?

Explicit when-to-use ('when the user requests the document itself'), when-not ('For a general explanation use query_knowledge op=ask'), how to recover from a missing prerequisite ('locate it with kb_search or kb_list_documents'), and which view to pick. This is close to a full routing rule set.

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.