Skip to main content
Glama

Read Knowledge Document

read_knowledge_document
Read-onlyIdempotent

The text extracted from one document (or the transcript of an audio file), in pages: offset and max_chars select the part, and the reply says how long the whole text is.

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": {
      "document_id": "<document_id>"
    },
    "name": "read_knowledge_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
app_idNoOptional app whose notebooks to use. Omitted: the owner's own Business Brain.
offsetNo
max_charsNo
document_idYesThe document id, from list_knowledge_documents.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior4/5

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

The annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), so the description's job is to add behavior beyond that. It does: the call pages through the text via offset/max_chars, the response reports the total length of the whole document, and audio files return transcripts. It stops short of describing error behavior when offset exceeds the text or any size limits on reads.

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?

It is a single compact sentence with no filler, and the most important information (what comes back, and that audio transcripts qualify) is up front. The phrasing 'in pages: offset and max_chars select the part' is slightly compressed but still readable.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description does well to explain that the reply contains text plus a total-length indicator, and that pagination is character-based. What remains missing for a four-parameter retrieval tool is guidance on very large documents, what happens past the end of the text, and how this differs from the other knowledge-reading tools.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 50%, with documented descriptions for document_id and app_id but none for offset and max_chars. The description compensates partially by explaining that offset and max_chars select a slice of the full text, which clarifies their joint role, but it adds no units, boundary behavior, or default implications and says nothing about app_id.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states exactly what the tool returns: the text extracted from a single document, including audio transcripts. That is a clear resource plus retrieval idea, but it never contrasts itself with nearby siblings such as list_knowledge_documents, ask_knowledge_notebook, or get_knowledge_answer, so an agent must infer the boundary on its own.

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

Usage Guidelines2/5

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

There is no explicit when-to-use guidance, no statement of when not to use it, and no named alternative for cases like asking a question across a notebook. Usage is only hinted at through the paging explanation, which describes mechanics rather than selection criteria.

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