knowledge_ingest

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

Reveals validation behavior (rejects unknown keys) and suggests schema check. Annotations indicate mutability, which aligns with 'insert'. No contradictions.

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?

Two efficient sentences plus a tip, front-loaded with the main action, no fluff.

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?

Covers purpose, validation behavior, and a prerequisite (check schema). Output schema exists to explain return values, so no gap. Minimal annotations but description compensates.

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 coverage is 100%, but the description adds value by clarifying that properties are validated against collection schema and unknown keys are rejected, beyond the schema's bare definitions.

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 the verb ('insert') and resource ('knowledge collection'), and distinguishes from sibling tools like knowledge_query and knowledge_search by specifying manual insertion with schema validation.

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?

Provides guidance to call knowledge_schema first to check expected properties, implying a prerequisite. Lacks explicit when-not details but context from sibling tools makes it clear.

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