Skip to main content
Glama

list_routers

Read-onlyIdempotent

List routers in a saved network lab state and show which protocols have collected OSPF, BGP, or routing table data, plus row counts. Use it to verify available topology data before analysis.

Instructions

List the routers in a network-xray lab state and which protocols have state for each (ospf: OSPF neighbors or LSDB in the data; bgp: BGP neighbors or BGP routes), whether a routing table was collected, and row counts. 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": "list_routers"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoSame input as lab_state (optional here: the server was started with /app/demo/bgp-lp/frameB.json)

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.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and a closed-world scope, so the trailing "Read-only." mostly repeats structured data. The description does add genuine behavioral value the annotations cannot carry: it decodes the per-protocol flags (ospf means OSPF neighbors or LSDB present; bgp means BGP neighbors or BGP routes present), notes whether a routing table was collected, and mentions row counts — all useful since there is no output schema.

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?

A single front-loaded sentence that packs scope, per-protocol semantics, and output contents without filler. The nested parenthetical expansions are dense but each clause earns its place; only the trailing "Read-only." is redundant with annotations.

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

Completeness5/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 adequately by naming the fields per router (protocol state, routing-table flag, row counts). Combined with full schema coverage for the sole optional parameter and complete annotations, an agent has enough to call it correctly.

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% and the single optional `path` parameter is fully documented in the schema, including the default server-side file. The description adds nothing about parameters, so the baseline of 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?

States a specific verb and resource ("List the routers in a network-xray lab state") and enumerates what each entry carries: protocol state indicators, routing-table presence, and row counts. It implicitly reads as the aggregate/overview counterpart to the per-protocol siblings (bgp_neighbors, ospf_neighbors), but never names an alternative, so differentiation is inferred rather than stated.

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?

There is no explicit when-to-use or when-not-to-use guidance and no alternative tool is named. The scope ("lab state") implies an entry-point overview before drilling into bgp_neighbors/ospf_neighbors, but the agent must infer that routing itself.

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