Skip to main content
Glama

knowledge_read

Read a project knowledge document by path relative to .context-grove, letting AI coding agents consult Git-versioned Markdown guidance before acting.

Instructions

Read a project knowledge document by its path relative to .context-grove. / Leia um documento de conhecimento pelo caminho relativo a .context-grove.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It conveys that the operation is a read, but says nothing about what happens on a missing/invalid path, permission requirements, or what a successful read returns.

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?

A single compact sentence that front-loads the action and resource. The bilingual duplication doubles the length without adding information for a given reader, which is the only real waste.

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?

For a one-parameter read tool with no output schema, the description covers the essential input semantics. It still leaves error behavior and the shape of returned content unstated, which an agent would need when the path is wrong.

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 0%, so the lone 'path' parameter is undocumented in the schema. The description compensates partially by specifying the path is relative to .context-grove, which is genuinely useful, but it omits format details (extension, separators, case).

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 project knowledge document') and scopes it to a path relative to .context-grove. It is clearly distinguishable from knowledge_search/catalog/health in substance, though it never names those siblings to make the distinction explicit.

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: nothing says to use this when you already know the document path, nor that knowledge_search is the alternative when you don't. Usage is only implied by the 'by its path' phrasing.

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