shortest_path

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

No annotations provided. The description only describes the output format but does not disclose behavior like read-only nature, algorithm, or requirements (e.g., graph must already be built).

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 one-sentence description is too short and vague, lacking substantive content. It does not balance brevity with informativeness.

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?

Given the complexity of a shortest path tool, with no output schema and no annotations, the description is insufficient. It fails to explain return format, error cases, or integration with 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?

With 0% schema description coverage, the description should add meaning to parameters. It hints at 'two nodes' but does not explain a, b, or repo, leaving their semantics unclear.

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 mentions 'ordered path' and 'no path' result, vaguely indicating graph path finding, but does not specify 'shortest' or the context (e.g., code repository graph). It fails to differentiate from sibling tools like get_neighbors or story_trace.

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 build_graph or get_neighbors. No prerequisites or exclusions are stated.

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