codebook_neighbors

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

The description reveals one behavioral detail: 'pure cosine similarity'. However, with no annotations, it does not disclose whether the tool is read-only, required permissions, side effects, or performance implications. This is a partial disclosure that leaves gaps.

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 a single, concise sentence that gets to the point quickly. It could be improved by adding structure (e.g., listing key parameters), but it is not verbose.

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?

Despite having an output schema, the description fails to explain parameter semantics, usage context, or behavioral traits beyond the similarity metric. The presence of four parameters with no commentary makes the description incomplete for effective tool use.

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 description provides no explanation for any of the four parameters (notes_dir, note_id, glob, k). With 0% schema coverage, this is a critical omission; the agent cannot understand how to set parameters beyond their names and types.

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 finds nearest notes to a given note using cosine similarity, which is specific and indicates a retrieval operation. However, it does not explicitly differentiate from siblings like codebook_related or codebook_query, which might have similar functions.

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 is provided on when to use this tool versus alternatives (e.g., codebook_related, codebook_query). There is no mention of prerequisites, scenarios, or exclusions, leaving the agent without decision support.

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