rlm_code_neighbors

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

No annotations provided, and description lacks behavioral details such as read-only nature, potential large output, or that it returns a graph. Only minimal action stated.

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?

Single sentence is concise but at the cost of completeness. Could be expanded while maintaining brevity.

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 no output schema and no annotations, the description should explain what a 'local code subgraph' entails (e.g., nodes and edges). It also doesn't handle the optionality of parameters (required: [] but symbol implied). Incomplete for agent to use confidently.

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?

Description does not elaborate on any of the 5 parameters. Schema coverage is 60%, but description adds no meaning beyond what's in the schema. Depth, limit, and edge_kinds are not explained.

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?

Description clearly states it returns the local code subgraph around a symbol. This differentiates from sibling tools like rlm_code_callers (caller-specific) and rlm_code_imports (import-specific).

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 information on when to use this tool versus alternatives. Does not mention constraints or ideal scenarios.

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