Skip to main content
Glama

knowledge_read

Read-only

Read a line range from a cached documentation document by source and ID after searching, using next to continue through long results.

Instructions

Read a line range of a cached document by source and ID from knowledge_search. Use next to continue.

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": {
      "source": "<source>",
      "id": "<id>"
    },
    "name": "knowledge_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
fromNo
linesNo
sourceYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds that documents are 'cached' and read in line ranges, which is useful context, but it says nothing about what happens when the range exceeds the document, whether content is line-numbered, or how truncation is signalled.

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?

Two short sentences with the core action and the ID provenance front-loaded; there is no filler. The second sentence is slightly wasted because it points at a nonexistent 'next' control instead of the real paging parameter.

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?

A four-parameter tool with zero schema documentation and no output schema needs the description to explain pagination defaults, maximum window size, and the shape of returned content. The description leaves the continuation mechanism and return format entirely unspecified, so an agent must guess at page sizes and how to advance.

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

Parameters2/5

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

Schema description coverage is 0% across four parameters, so the description must carry the burden. It only conveys 'source', 'id', and the vague notion of a line range; it never explains the names or bounds of 'from' (default 1, 1-based), 'lines' (default 70, max 120), or the meaning of the seven enum values for 'source'.

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?

States a specific verb and resource: 'Read a line range of a cached document by source and ID'. It also ties the document identity back to knowledge_search, which helps separate it from the search sibling, though it does not describe how it differs from resource_read.

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

Usage Guidelines3/5

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

'from knowledge_search' gives a clear prerequisite: obtain the ID from search first. However, 'Use next to continue' references a token/parameter named 'next' that does not exist in the schema (the continuation control is actually 'from'), leaving the paging guidance ambiguous rather than actionable.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.