read_kb_doc

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

With no annotations, the description carries full burden. It discloses that the tool returns reliability metrics, content, and related cards, and what the agent must do after. It does not mention side effects or auth, but as a read operation this is sufficient.

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 well-structured with sections for purpose, when-to-use, input, output, and actions. It is front-loaded with the workflow context and every sentence adds value without redundancy.

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?

Given the simple input (one parameter), no annotations, and existence of an output schema, the description provides complete context: workflow placement, input format, output nature, and required post-action. No gaps remain.

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?

The input schema has no description for kb_id (0% coverage). The description compensates by specifying 'The exact ID of the card (e.g., 'CROSS_DOCKER_001')', providing a format example that adds meaning.

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 clearly states it's the second step in the troubleshooting workflow and that it reads the content and solution of a specific Knowledge Base card. The verb 'read' and resource 'knowledge base card' are specific, and it distinguishes from siblings by referencing the workflow sequence.

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?

Explicitly states to call this ONLY after obtaining a valid kb_id from resolve_kb_id tool. It also outlines the required follow-up steps (apply solution, call save_kb_card), providing clear usage guidance within the workflow.

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