Skip to main content
Glama

knowledge_read

Read a Markdown note in full or by line range and return its hash for use as expected_hash in write operations, preventing concurrent edits from being overwritten.

Instructions

Прочитать .md из базы целиком или диапазоном строк. Возвращает хеш — передай его в knowledge_write как expected_hash, чтобы не затереть чужие правки.

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

Input Schema

NameRequiredDescriptionDefault
pathYesпуть относительно базы
end_lineNo
start_lineNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It does disclose the key trait that the call returns a hash used for optimistic concurrency in knowledge_write, which is valuable, but it says nothing about out-of-range line handling, indexing base, or what the content payload looks like.

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

Conciseness5/5

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

Two short sentences, zero filler. The read scope comes first and the hash-passing rule follows, so the most actionable information is front-loaded.

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 annotations and no output schema, the description is the only behavioral source; it covers the hash return and the write workflow but leaves the content return shape, missing-file behavior, and line-range edge cases unexplained.

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 only 33% — only 'path' is documented — so the description must compensate. It implies start_line/end_line select a range versus reading the whole file ('целиком или диапазоном строк'), but gives no detail on 1-based indexing, inclusivity, or whether both bounds are required together.

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 ('Прочитать .md из базы') plus the two modes of operation (whole file or line range). It does not explicitly contrast with knowledge_search, but the read/write pairing with knowledge_write is named, so the agent can place it 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 Guidelines4/5

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

Gives a concrete workflow directive: take the returned hash and pass it to knowledge_write as expected_hash to avoid clobbering others' edits. That is a real when-to-use rule, though there is no explicit exclusion against siblings like knowledge_search.

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