Ingest Knowledge

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

Annotations already indicate idempotence (idempotentHint=true) and non-destructiveness (destructiveHint=false). The description adds behavior about deduplication via externalId and optional LLM processing, but lacks details on authorization, error states, or rate limits.

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 concise sentences: first states purpose, second adds key features. No redundant info, front-loaded with core action.

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?

With 8 parameters, nested objects, and no output schema, the description is adequate but lacks details on return values, expected behavior on duplicate externalId, or error handling. Schema covers parameters, so baseline is met.

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 covers all parameters (100% coverage). Description adds meaning by explaining that externalId enables deduplication and processing enables LLM modes, going beyond schema descriptions.

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 tool ingests content into a knowledge base, with specific verbs and resource. It mentions key features like deduplication and LLM processing, but does not differentiate from sibling tools like neuron_create_kb_entry or neuron_sync_knowledge.

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?

No guidance on when to use this tool versus alternatives such as neuron_create_kb_entry or neuron_sync_knowledge. No exclusions or prerequisites mentioned.

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