Skip to main content
Glama

Read a knowledge document

dosai_read_knowledge_document
Read-onlyIdempotent

The text of one knowledge base document, piece by piece, exactly as the bot sees it.

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

Input Schema

NameRequiredDescriptionDefault
project_idYesFrom dosai_list_projects.
document_idYesFrom dosai_list_knowledge.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / document_id / description
      Previous value: -"Knowledge base document id, as returned by dosai_list_knowledge."New value: +"From dosai_list_knowledge."
  2. Changed2 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedInput schema / properties / project_id / description
      Previous value: -"Project id, as returned by dosai_list_projects."New value: +"From dosai_list_projects."
  3. Changed2 schema fields changed
    • removedInput schema / properties / document_id / pattern
      Removed value: -"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    • removedInput schema / properties / project_id / pattern
      Removed value: -"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
  4. Added

TDQS

C2.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered elsewhere. The description adds one genuinely useful behavioral detail — that the content is returned 'exactly as the bot sees it', meaning post-processing/parsed view rather than raw upload — but the 'piece by piece' hint is never explained, leaving unclear whether the call returns the whole document, one chunk, or a paginated slice.

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

Conciseness3/5

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

It is a single short sentence with no padding, so nothing is wasted. However, the brevity comes at the cost of being a bare noun phrase rather than a front-loaded action statement, and the unexplained 'piece by piece' phrase raises a question it does not answer.

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

Completeness2/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 is the only place the return shape can be explained, and 'piece by piece' leaves the critical question open: does one call return the full document or a chunk requiring repeated calls? For a read tool whose entire purpose is returning content, that ambiguity is a real gap even though parameters and annotations are well covered.

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 description coverage is 100% and both parameters carry provenance hints ('From dosai_list_projects', 'From dosai_list_knowledge'), so the schema does the heavy lifting. The description adds nothing about the two UUIDs or how document_id relates to the document returned, which is acceptable at this coverage level but no better than baseline.

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

Purpose3/5

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

The description identifies the resource as 'one knowledge base document' and what it yields (the text), which separates it somewhat from list/search siblings by name alone. But it is a noun phrase with no verb — it never says 'read', 'fetch', or 'return' — so the agent must infer the operation from the tool name and title rather than the description.

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 when-to-use guidance at all: nothing says to prefer this over dosai_list_knowledge or dosai_search_knowledge, nor any precondition such as needing a document_id from a prior listing step. The only clue is the phrase 'exactly as the bot sees it', which implies inspection/debugging rather than editing, but that is inference, not 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