expand

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

With no annotations, the description carries full burden. It discloses the BFS algorithm and k-hop limit, but does not mention if it's read-only, error handling, default for k, or performance traits.

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?

One tightly packed sentence with no wasted words. Front-loaded with the core algorithm name (BFS), efficiently conveying the essential constraints.

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?

No output schema exists, yet the description omits what the tool returns (nodes, edges, paths?). Missing any mention of limits on k, error conditions, or relationship to sibling tools.

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%, but description adds meaning for all parameters: 'k hops' for k, 'ONE edge family' for edge_type, and 'from a node' for id. The example 'calls' clarifies enum usage. However, id could be more precisely defined.

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 up to k hops along a single edge family from a node, using 'calls' as an example. It differentiates from siblings like 'neighbors' (likely one-hop) and 'search' (different scope), but doesn't specify the output type.

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?

The description implies usage for traversal along a single edge type with limited depth, but provides no explicit when-to-use or when-not-to-use guidance. No contrast with other tools like 'neighbors' or 'locate' is given.

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