Skip to main content
Glama

yangmap

Which gNMI path carries which information, on which vendor, in which OS version.

A language model given read-only gNMI access doesn't know where to look. It knows CLI syntax by heart and invents plausible YANG paths that don't exist. yangmap gives it the map — built from the YANG published by the vendor, not from a hand-written list.

$ yangmap chercher "active and inactive routes" nokia_sros --version 24.3.R3
nokia_sros 24.3.3  (exact)

  [  31.44] /state/router[router-name=?]/route-table/unicast/ipv4/statistics/aggregate/available-routes
            leaf/uint32 — Count of routes of a routing protocol, both active in the FIB and inactive in the RIB.

What yangmap does not do

It connects to no equipment. No credentials, no inventory, no socket. It's a documentation server, not a collection server — and that's what gives it a zero security surface.

The caller discovers the equipment's version (gNMI Capabilities) and passes it as a parameter. yangmap stays offline and unprivileged.

Related MCP server: VyOS MCP Server

Guarantees

Guarantee

Mechanism

Test

No equipment contact

No server module imports a network library

tests/test_frontiere.py

No access to secrets

No module imports keyring or an equivalent

tests/test_frontiere.py

The download path is unreachable from a tool

server.py imports neither bundles nor indexer

tests/test_frontiere.py

No silent fallback between vendors

Unknown platform ⇒ error

tests/test_api.py

A version mismatch is always reported

Every response carries the bundle actually served

tests/test_api.py

These tests were deliberately broken before being fixed. One of them protected nothing: from yangmap import bundles passed, because the AST extractor only picked up the module, never the imported name.

Installation

python3 -m venv .venv
.venv/bin/pip install -e ".[dev]"

Usage

# 1. Download the vendor's YANG — the ONLY command that touches the network
yangmap fetch nokia_sros 24.3.R3

# 2. Build the index — offline from here on
yangmap build nokia_sros

# 3. Search
yangmap chercher "SFP transceiver" nokia_sros
yangmap detail "/state/port[port-id=?]/transceiver" nokia_sros

yangmap versions

Bundles and indexes live under ~/.yangmap and are never version-controlled: they regenerate from a single command.

MCP server

yangmap-mcp

Three tools, and not one more:

Tool

Returns

yang_chercher(sujet, plateforme, version, limite, arbre)

Ranked paths, with type and vendor description

yang_detail(chemin, plateforme, version)

The node, the keys it requires, and its immediate children

yang_valider(chemin, plateforme, version)

Does this path run, and what will it return — before contacting anything

The second lets the model descend the tree without guessing. The third answers the question that follows.

yang_valider — the three failures that look identical

A failing path returns in three ways, and once returned they are indistinguishable:

What happened

What the model receives

What it concludes

The path does not exist

An empty response

"The feature is not configured"

A key was left as a template (=?)

An empty response

"The feature is not configured"

The subtree is enormous

A truncated response

It draws conclusions from amputated data

The first two are false facts stated with confidence; the third is worse because it is invisible. yang_valider distinguishes them offline, before any contact, and returns an explicit reason instead of a blank void.

$ yangmap valider '/configure/router[router-name=Base]/bgp/group[group-name=transit]/export-policy' nokia_sros
[KO] inexistant
     unknown segment: 'export-policy' under /configure/router[]/bgp/group[].
     Possible children: export, ebgp-default-reject-policy, import.

$ yangmap valider '/state/router[router-name=Base]/interface[interface-name=*]' nokia_sros
[!!] volumineux
     518 nodes under this path, ~3470 characters per instance.

The payload threshold is calibrated, not chosen arbitrarily: netlive's interfaces collector targeted this container and returned 17,583 characters for 5 interfaces, compared to 573 when narrowed to the useful leaves. Hence ~6.7 characters per descendant and per instance — the estimator comes within 1% of this real measurement.

The two trees

arbre="etat" (default) is operational state, what a diagnostic Get queries. arbre="conf" is the configuration tree.

It was previously missing, and that absence had a cost: on netlab, four consecutive searches for bgp group export-policy returned nothing — not because the path is missing from the model, but because no /configure path was indexed. With arbre="conf", the correct path ranks first:

$ yangmap chercher "bgp group export policy" nokia_sros --arbre conf
  [  33.44] /configure/router[router-name=?]/bgp/group[group-name=?]/export/policy
            leaf-list/union — BGP export policy name

The two trees never mix in the same ranking: every state node has a configuration twin that would compete for the exact same words. Measured: the Nokia golden set stays at 11/11 after doubling the index.

Platforms

Platform

YANG source

Indexed models

Paths

Descriptions

nokia_sros

nokia/7x50_YangModels, tag per revision

nokia-state + nokia-conf

115,557

98%

cisco_iosxe

YangModels/yang, vendor/cisco/xe

*-oper.yang

12,123

97%

arista_eos

aristanetworks/yang

OpenConfig

9,924

100%

The exact version isn't always published — Nokia goes down to the patch, Cisco and Arista stop at the train. Falling back is therefore the normal case, and it is reported in every response:

{"bundle_servi": "17.3.1", "version_demandee": "17.3.4a", "ecart": "meme_train",
 "avertissement": "Version 17.3.4a not published by the vendor: bundle 17.3.1 served…"}

Ranking

This is the only genuinely hard part, and it's defined by its measurement: a golden set of real questions, metric "is the expected path in the top five". 21 questions, three platforms, 100%.

python goldenset/mesurer.py             # measure
python goldenset/mesurer.py --ablation  # does each signal earn its place?

Four signals, all proven useful by ablation:

Signal neutralized

Rate

Delta

BM25 on descriptions

76%

−24%

BM25 on path segments

86%

−14%

Exact segment match

90%

−10%

Depth penalty

95%

−5%

Two signals were tried and then dropped for lack of measurable effect: boosting leaves, and term coverage. A signal that doesn't move a single golden-set entry doesn't stay in the code.

The baseline that ranking has to beat

A naive substring search returns, across all three vendors:

Question

Top raw result

"transceiver" (Nokia)

…/dwdm/coherent/rx-optical-snr-x-polarization

"routing table" (Nokia)

/state/radius/route-downloader[]/statistics/…

"routing table" (Arista)

…/l2rib/mac-ip-table/entries/entry[][]/host-ip

The correct data is in the index every time. This is a ranking defect, never a data defect.

Tests

.venv/bin/python -m pytest -m "not lab"   # 101 tests, no network or hardware
.venv/bin/python -m pytest -m lab         # 9 tests against a real containerlab

Documentation

Design · Validation criteria

License

MIT

Available Tools

2 tools
yang_chercherA

Trouve les chemins gNMI qui portent une information donnée, classés du plus pertinent au moins pertinent. Ce que l'on cherche, en langage naturel : « routes actives et inactives », « transceiver SFP », « adjacences ISIS ». Le français est accepté. Vendeur : nokia_sros, cisco_iosxe, arista_eos. Version d'OS de l'équipement, telle que rendue par gNMI Capabilities (ex. 24.3.R3). Facultative — sans elle, la version la plus récente installée est servie, et l'approximation est déclarée. Rend pour chacun : le chemin prêt à interroger, le genre de nœud, le type de donnée et la description du vendeur.

Inputs: sujet (required), plateforme (required), limite, version. Returns: object

yang_detailA

Détaille un chemin rendu par yang_chercher : sa description, les clés à renseigner, et ses ENFANTS IMMÉDIATS — pour descendre dans l'arbre sans deviner. Vendeur : nokia_sros, cisco_iosxe, arista_eos. Version d'OS de l'équipement, telle que rendue par gNMI Capabilities (ex. 24.3.R3). Facultative — sans elle, la version la plus récente installée est servie, et l'approximation est déclarée.

Inputs: chemin (required), plateforme (required), version. Returns: object

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A4/5.0

    Scored across 2 tools

    Disambiguation5/5

    The two tools have clearly distinct purposes: one searches for paths based on natural language, the other details a specific path by describing its keys and children. There is no ambiguity between them.

    Naming Consistency4/5

    Both tools share the 'yang_' prefix, but one uses a verb ('chercher') and the other a noun ('detail'). This is a minor inconsistency, but the pattern is still predictable and readable.

    Tool Count3/5

    With only two tools, the server feels thin, but the scope is narrow and well-defined: search and detailed exploration of YANG paths. It is borderline but not excessive.

    Completeness4/5

    The pair covers the core workflow of finding and exploring YANG paths. A minor gap is the lack of a direct way to list all paths or vendors, but the search functionality effectively compensates.

    Maintenance

    ActivityMaintained
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      Not graded
      quality
      D
      maintenance
      A Model Context Protocol server that provides programmatic access to ONOS SDN controller's network management capabilities, enabling device control, topology management, and analytics through ONOS's REST API.
      6
      GPL 3.0
    • -
      license
      Not graded
      quality
      Not graded
      maintenance
      A Model Context Provider server offering comprehensive access to VyOS network operating system functionality through 25+ tools covering configuration management, operational commands, diagnostics, and monitoring.
      2
      -
    • F
      license
      Not graded
      quality
      B
      maintenance
      Enables AI assistants to manage network devices via gNMI protocol, including querying capabilities, reading/modifying configurations, and subscribing to telemetry data through natural language.
      -