Skip to main content
Glama

ospf_neighbors

Read-onlyIdempotent

Lists OSPF neighbors per router and flags missing adjacencies or mismatched interface settings from collected lab state, for all routers or one specified router.

Instructions

Starts with wrong: what is wrong, for OSPF and interfaces, each with a text line (an interface down, an OSPF interface that faces a neighbor and has no adjacency with the values both ends must share and do not, a Full adjacency whose ends still differ); empty when nothing is. Then OSPF neighbors per router as collected: neighbor router ID, address, state (e.g. Full), interface, and DR/BDR role and peer node name when known. All routers, or one with router. Read-only.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "ospf_neighbors"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoSame input as lab_state (optional here: the server was started with /app/demo/bgp-lp/frameB.json)
routerNoOnly this router, e.g. r1 (default: all routers)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / path / description
      Previous value: -"Same input as lab_state (optional here: the server was started with /app/demo/compose-bgp-lp/web/xray-states.js)"New value: +"Same input as lab_state (optional here: the server was started with /app/demo/bgp-lp/frameB.json)"
  2. Changed2 schema fields changed
    • changedInput schema / properties / path / description
      Previous value: -"Same input as lab_state"New value: +"Same input as lab_state (optional here: the server was started with /app/demo/compose-bgp-lp/web/xray-states.js)"
    • changedInput schema / required
      Previous value: -[
      -  "path"
      -]New value: +[]
  3. First observedv1.4.3

TDQS

C2.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint/idempotent/non-destructive, and the trailing 'Read-only.' merely repeats that. The description does add genuine behavioral detail beyond annotations by describing the shape of the returned `wrong` block (per-item `text`, empty when nothing is wrong) and the neighbor fields returned when they are known.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The content arrives as one long run-on sequence with deeply nested parentheticals, and the lead position is spent on the secondary `wrong` diagnostic rather than the tool's namesake output. The information is relevant but the ordering and sentence structure make it hard to scan.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description carries the return-value burden and does so reasonably: it enumerates the neighbor fields (router ID, address, state, interface, DR/BDR role, peer node name) and explains the diagnostic block. Missing are the possible `wrong` categories as an enumerated list and whether output is sorted or scoped by lab.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already documents both `path` and `router`. The description adds only that `router` scopes to all versus one, which duplicates the schema's 'default: all routers', and says nothing about `path` beyond what the schema states.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The core purpose is derivable from 'OSPF neighbors per router as collected' followed by a concrete field list, but the description never states a verb such as 'lists' or 'returns' and buries the primary resource behind a long diagnostic-block explanation. No sibling differentiation is offered despite ospf_interfaces appearing in the same list.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The only usage guidance is 'All routers, or one with `router`', which restates the parameter default. There is no statement of when to prefer this over bgp_neighbors, ospf_interfaces, lab_state, or state_diff, and no prerequisites or exclusions.

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