Skip to main content
Glama

Topolograph

get_edges

Read-onlyIdempotent

Get edges from a graph with optional filtering.

Description: Returns a paginated list of edges. Supports graph-level pre-filters (protocol, watcher, area) and per-edge attribute filters. Useful for queries like "all IS-IS L1 edges" or "edges with max_rsrv_link_bw < 10Gbps". Edges are the source of neighbor/adjacency data: to find a router's neighbor count, fetch edges and count those with that router as src_node. Results are paginated; read all pages (see pagination.total_pages) before counting.

Attribute filters use exact match or range operators:
  weight=10, temetric__gt=100, unreserved_bw_0__lt=1000000000
TE attributes (when present): temetric, admin_group, max_link_bw,
  max_rsrv_link_bw, unreserved_bw_0..7
IS-IS: isis_level=1 or isis_level=2
User-defined attributes (e.g. isp_provider=verizon) are also supported.

Input fields: graph_time (str): The graph time identifier, or the name of your OSPF/IS-IS watcher (Enterprise) to read its newest snapshot with events up to now; the answer then names that snapshot in graph_time src_node (str, optional): Filter edges by source node name dst_node (str, optional): Filter edges by destination node name protocol (str, optional): Graph-level filter (ospf, ospfv3, isis, yaml) watcher (bool, optional): Graph-level filter: watcher-uploaded vs manually parsed area (str, optional): Graph-level filter by area edge_query_params (dict, optional): Edge attribute filters (flat key=value pairs) include (list[str], optional): Extra MPLS-TE fields, hidden by default: "lsp_left_bw" (how much TE bandwidth is left on each edge, after accounting for placed LSP tunnels -- lsp_left_bw_0..7 plus a human-readable lsp_reserved_bw/lsp_left_bw/lsp_bandwidth_usage pair at the default priority-7 pool), "lsps" (which LSP tunnels traverse this edge), "is_te_link" (true when the link advertises at least one optional TE value: TE metric, admin group, max/reservable/unreserved bandwidth or SRLG; a zero counts, interface and neighbor addresses do not), "edge_key" (stable identity, needed for get_lsps(via_edge_key=) on parallel/ECMP edges) page (int): Page number, 1-indexed (default: 1) per_page (int): Items per page (default: 50) is_te_link (bool, optional): true keeps only TE links, false only links that are not; any other type is rejected with HTTP 400 at (str, optional): ISO 8601 moment; state with watcher events applied up to it

Output fields: dict with keys: items: list of edges with src, dst, weight, and optional TE/IS-IS/user-defined attrs pagination: page, per_page, total, total_pages

Equivalent to GET /graph/{graph_time}/edges.

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": {
      "graph_time": "<graph_time>"
    },
    "name": "get_edges"
  }
}

Input Schema

NameRequiredDescriptionDefault
atNo
areaNo
pageNo
includeNo
watcherNo
dst_nodeNo
per_pageNo
protocolNo
src_nodeNo
graph_timeYes
is_te_linkNo
edge_query_paramsNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds substantial behavior on top: pagination semantics with total_pages, hidden-by-default MPLS-TE fields unlocked via include, exact-match vs range operator syntax, the watcher snapshot-naming side effect, and a specific error case (non-boolean is_te_link rejected with HTTP 400). This is the kind of context annotations cannot convey.

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?

Well structured and front-loaded: purpose, then filtering semantics, then inputs, then outputs. Some redundancy is present — the 'Output fields' block restates an output schema that already exists, and the 'Input fields' block largely mirrors the schema — but the added detail (include field meanings, operator syntax) earns most of the length.

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?

For a 12-parameter, paginated read tool with an output schema, this covers the remaining gaps: pagination caveats, filter operator syntax, opt-in heavy fields, and error behavior. An agent has everything needed to call it correctly and interpret the result.

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

Parameters5/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: every one of the 12 parameters is documented with type, optionality, default, and meaning, including non-obvious ones like graph_time accepting a watcher name, edge_query_params' __gt/__lt operator convention, and the exact set of include values. Little ambiguity remains about how to construct a call.

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

Purpose5/5

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

The first line states a specific verb and resource ('Get edges from a graph with optional filtering'), and the body clarifies what an edge represents ('the source of neighbor/adjacency data') and how it differs from node-oriented queries. It also names a downstream consumer (get_lsps via_edge_key), so an agent can place the tool in the wider graph API without opening the schema.

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

Usage Guidelines4/5

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

Concrete query examples ('all IS-IS L1 edges', 'max_rsrv_link_bw < 10Gbps') and a procedural rule ('read all pages before counting') give strong usage context, plus a cross-tool hint that edge_key is needed for get_lsps on parallel/ECMP edges. It stops short of explicit when-not-to-use guidance or naming an alternative tool for node-level queries.

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.