neighbors

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

Without annotations, the description provides behavioral info: BFS traversal, both directions, returned node fields. However, it does not disclose side effects, permissions, or cost implications, leaving gaps in transparency.

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?

Three efficient sentences front-load the core action. Every sentence adds value with no 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?

Adequate for a simple BFS tool but lacks parameter clarification and does not detail the output schema despite its existence. Missing context like default behavior or edge cases.

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 0%, yet the description adds no meaning beyond the schema. Parameters kind, id, depth, max_n are not explained, leaving the agent to infer their roles solely from 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?

The description clearly states it performs BFS from a starting node up to depth hops, returning visited nodes with kind, id, and snippet. It distinguishes graph traversal from sibling tools like search and search_via_parent by specifying bidirectional traversal and node details.

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 explicit guidance on when to use this tool versus alternatives. Usage is implied (graph exploration) but lacks conditions, prerequisites, or exclusions.

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