Skip to content
Documentation Prelude Topology Engine 1.0.0

Available tools

The Prelude TE MCP tools the assistant can call once the MCP server and the companion skill are installed.

With PRELUDE_TE_ENABLED=true on the MCP server, the assistant gets four tools dedicated to Prelude TE. Every tool maps to the same REST endpoints you would call by hand — see the API reference for the underlying paths.

te_ping

Health probe. Returns whether the configured Prelude TE instance is reachable from the MCP server, with the response body when the server is up. Useful when an action fails and you want the assistant to verify connectivity before debugging further.

te_topology

Read the consolidated topology.

Action What it does
get List every domain plus the full merged topology.
get_domain Return the topology for a single domain.
get_node Return a single node by safe-id, scoped to a domain.
get_link Return a single link by safe-id, scoped to a domain.
stats Return per-domain node/link/prefix counts and the list of known domains.

For the shape of the data returned, see Topology / Nodes, Links, and Prefixes.

te_bgp_peers

Manage BGP-LS peers.

Action What it does
list List every configured peer with its state and counters.
get Return a single peer by ID.
create Create a new peer. Takes name, peer_address, user_peer_as, optional auth, timers.
update Update an existing peer.
delete Delete a peer. Frees a license slot (see Licensing).

The assistant uses the same field semantics as the web UI form — see Peers.

te_outputs

Manage outputs (NATS connections).

Action What it does
list List every configured output with its state.
get Return a single output by ID.
create Create a new output. Takes name, type, connection_url, optional TLS / auth settings.
update Update an existing output.
delete Delete an output.

See Outputs / NATS for the field semantics.

Filtering by: