Read indexed knowledge
read_knowledgeRead an exact indexed Markdown page or section from the pinned knowledge snapshot, including available anchors.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | ||
| section | No |
read_knowledgeRead an exact indexed Markdown page or section from the pinned knowledge snapshot, including available anchors.
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | ||
| section | No |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds real context beyond that: the data comes from a 'pinned knowledge snapshot' and returns available anchors. It still says nothing about what happens when a page or section does not exist.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with no filler; the core verb+resource comes first. The trailing 'including available anchors' clause is slightly vague about whether anchors are returned or accepted, which keeps it short of a 5.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a two-parameter read tool with no output schema, the description establishes the source and payload nature, which is adequate. It omits identifier syntax, the meaning of 'anchors', and error behavior on a missing page, leaving meaningful gaps for an agent invoking it correctly on the first try.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description carries the burden, and it does map loosely onto both parameters by naming 'page' and 'section'. However, it never explains the expected identifier format (path, slug, anchor) or that page is required while section is optional, so the gap is only partially closed.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb (Read) and a specific resource (an exact indexed Markdown page or section from the pinned knowledge snapshot), plus that anchors are included. It hints at the boundary with search_knowledge via 'exact' but never names the sibling, so differentiation is left partly to inference.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is only implied: 'exact' page/section suggests the caller must already know the identifier and should use search_knowledge to discover it first, but no when-to-use, when-not-to-use, or named alternative is given. An agent can infer the workflow but is not told it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.