Skip to main content
Glama

Topolograph

list_bgp_sessions

Read-onlyIdempotent

List BGP peering sessions of a BGP graph epoch.

Input fields: bgp_graph_time (str): The BGP graph epoch to query igp_relation (str, optional): Filter by relation to the IGP topology (intra-domain, inter-domain, external) bgp_session_type (str, optional): Filter by session type (ibgp, ebgp) page (int): Page number, 1-indexed (default: 1) per_page (int): Items per page (default: 50)

Output fields: dict with keys: items (list of BgpSession), pagination

Equivalent to GET /bgp-graph/{bgp_graph_time}/sessions.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "bgp_graph_time": "<bgp_graph_time>"
    },
    "name": "list_bgp_sessions"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNo
per_pageNo
igp_relationNo
bgp_graph_timeYes
bgp_session_typeNo

Output Schema

NameRequiredDescriptionDefault
itemsYes
paginationYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, open-world behavior, so safety is covered. The description adds that results are paginated and that the call maps to GET /bgp-graph/{bgp_graph_time}/sessions, plus filter semantics, but it says nothing about ordering, result volume, or failure behavior for an unknown epoch.

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 purpose line is front-loaded in a single sentence, followed by tidy input/output field blocks and the REST equivalent. The structure is efficient with no filler, though the type annotations in the list partially duplicate what the schema already encodes.

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 five parameters, existing output schema, and read-only annotations, the description covers what an agent needs to construct the call and interpret the response keys. The main missing piece is guidance on sourcing bgp_graph_time, e.g., via list_bgp_graphs, which is the one thing that could cause a failed invocation.

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

Parameters4/5

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

Schema description coverage is 0%, so the description must carry the load, and it does: all five parameters are named with types, defaults for page and per_page, and allowed filter values (intra-domain/inter-domain/external; ibgp/ebgp). The only gap is that the string format expected for bgp_graph_time is never specified.

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 BGP peering sessions') scoped to a 'BGP graph epoch', which an agent can distinguish from siblings like list_bgp_nodes or get_bgp_route_state. It does not explicitly contrast with the nearest alternative, but the scope is unambiguous.

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?

Usage is only implied by the scope: query sessions belonging to a given graph epoch. There is no explicit when-to-use vs. when-not, no alternative tool named (e.g., route-level queries), and no prerequisite such as how a valid epoch is obtained.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.