Read KB content

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

Annotations already declare readOnlyHint and idempotentHint, but the description adds useful behavioral context: line-based reading with offset/limit, v6 vs v7 path resolution, and acceptance of record IDs. This goes beyond the annotations and helps the agent understand side-effect-free read behavior.

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?

The description is two sentences but includes technical version details (v6/v7 contracts, env paths) that may not be essential for an AI agent. The main purpose is front-loaded, but the extra detail could be streamlined to improve brevity.

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?

The description covers input parameters, output format ({content, total_lines, has_more}), and version differences. For a read-only tool with no output schema, this is fairly complete. It lacks edge-case handling (e.g., file not found) but annotations suggest simplicity.

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 100%, so baseline is 3. The description reinforces parameter meanings (offset, limit, filename) but does not add significantly new semantics beyond the schema. It mentions line-based behavior, which is implicit from parameter names.

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?

Clearly states the tool reads full content from a KB file with optional line-based offset/limit. The description mentions v6 and v7 contracts, specifying input and output format. However, it does not explicitly distinguish from sibling tools like gkb_query or gkb_micro_query, which could also read content.

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?

The description lacks any guidance on when to use this tool versus alternatives. With 18 sibling tools, including gkb_query and gkb_micro_query, usage context is missing. No when-not-to-use or prerequisite information is provided.

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