Skip to main content
Glama

bgp_neighbors

Read-onlyIdempotent

Lists BGP neighbors per router with peer address, AS, iBGP/eBGP, state, and prefixes received, and flags every session that is not Established to diagnose why a BGP neighbor is down.

Instructions

Starts with wrong: each BGP session that is not Established, with a text line (empty when none). Then BGP neighbors per router as collected: peer address, remote AS, iBGP/eBGP, state, established, and prefixes received (null when the data has no count). 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": "bgp_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

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so the trailing 'Read-only' is redundant. The description nonetheless adds genuine behavioral detail beyond annotations: a leading `wrong` section listing non-Established sessions, empty `text` when none, and null semantics for prefix counts.

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

Conciseness4/5

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

The description is compact with no filler, and the most important content (the `wrong` section) is front-loaded. The telegraphic phrasing ('Starts with `wrong`', 'as collected') is slightly awkward to parse but does not waste sentences.

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?

There is no output schema, so the description must carry the return shape, and it does: it describes both the leading anomaly section and the per-neighbor fields with null handling. For a simple two-parameter read tool this is nearly complete, missing only explicit usage context.

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 description coverage is 100%, so both parameters are already documented, including the 'default: all routers' note. The description restates the router scoping and never mentions the `path` parameter, so it adds little meaning beyond the schema — the baseline 3 applies.

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

Purpose4/5

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

The description names the resource (BGP neighbors per router) and enumerates the returned fields (peer address, remote AS, iBGP/eBGP, state, established, prefixes received), so an agent can tell it apart from ospf_neighbors. It lacks an explicit leading verb such as 'list' or 'get', relying on 'Starts with...' and 'Then...' to convey that this is a read that returns data.

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

Usage Guidelines3/5

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

'All routers, or one with `router`' gives scoping guidance, and the mention of non-Established sessions implies a health-check use case. However, there is no explicit when-to-use or when-not-to-use guidance and no routing to siblings like route_lookup or why_best_path, so usage must be inferred.

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