get_ospf_neighbors

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

Even without annotations, the description names the exact command ('show ip ospf neighbor'), which transparently indicates that the tool performs a read-only network device operation. It does not mention error conditions or access requirements, but the command itself conveys the core behavior.

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, front-loaded sentence that states the action, target, and exact command without any wasted words. It earns its place by adding the specific CLI command, which is useful for understanding behavior.

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 tool's low complexity, one required parameter, and an available output schema, the description is largely complete for selecting and invoking it. Minor gaps remain around usage guidance and parameter specifics, but the core context is sufficiently covered.

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 input schema provides no description for the required 'device' parameter, and the tool description does not compensate. The parameter name is self-explanatory, but no details about accepted formats, device addressing, or required access are given, leaving the agent with only the schema's type information.

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 the action ('Show') and the target resource ('OSPF neighbors'), citing the exact CLI command 'show ip ospf neighbor'. This distinguishes it from sibling tools like get_eigrp_neighbors, get_cdp_neighbors, and get_lldp_neighbors.

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 when to use the tool (when you need OSPF neighbor information) but provides no explicit guidance on alternatives, prerequisites, or when not to use it. Sibling tool names make some alternatives obvious, but no direct comparison is offered.

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