Skip to main content
Glama

netlab-mcp

License: Apache-2.0 Python CI engine: netlab 26.06

An MCP server that wraps ipspace/netlab as an engine to give LLMs access to validated, lab-tested network device configurations — instead of hallucinated ones.

Why

Getting working network configs out of a raw LLM is unreliable: vendor-syntax drift, no validation, invented data-model fields, no interop guarantees. netlab already solves the hard part — it owns the data-model transform (AS / RD-RT / VNI / neighbor computation), the Jinja2 render, the containerlab provider, and a netlab validate test system. This server does not re-serve raw .j2 templates or rebuild that pipeline. It exposes netlab's outputs to an LLM and records what actually passes in a lab.

Related MCP server: Nornir MCP Server

What it does

  • Offline (fast, no docker): translate intent → netlab topology, render real per-device config, query declared module/platform support.

  • Lab (needs docker + containerlab): deploy to containerlab, run netlab validate, record the pass/fail verdict into a version-scoped compatibility matrix.

WARNING

Lab ≠ production. Every config-bearing tool response embeds the full disclaimer from netlab_mcp.models.DISCLAIMER. Configs are validated only in an isolated, synthetic netlab + containerlab lab on free images. "Validated in lab" ≠ "safe in your network" — review IP/AS/naming and interactions with your existing config before applying to real gear. See SECURITY.md.

Scope (MVP)

  • Free containerlab images only: srlinux, frr, cumulus, vyos, linux (ceos behind an explicit EULA env flag). Licensed NOSes (nxos/iosxr/sros/junos/…) come later behind a self-hosted runner.

  • First proven loop: eBGP across srlinux + frr.

Tools

Tool

Mode

Disclaimer

Purpose

generate_topology

offline

intent + platforms → netlab topology YAML (validated by parse)

render_config

offline

topology → real per-device config + clab.yml

query_compatibility

offline

netlab declared support, overlaid with observed lab verdicts

get_known_good

offline

return a previously lab-passed topology + config

list_examples

offline

index netlab's integration test topologies

report_failure

offline

record a negative result into the matrix

host_check

offline

doctor: lab readiness, versions, loaded images, validation plugins

validate_in_lab

lab

deploy + netlab validate + record verdict

Mode: offline needs no docker; lab requires docker + containerlab. Disclaimer: ✅ responses embed the lab≠production disclaimer.

Install — offline (no docker)

The engine (netlab binary + netsim) installs from PyPI as networklab; you do not need to vendor it.

uv venv --python 3.12 .venv
source .venv/bin/activate
uv pip install -e '.[dev]'          # pulls networklab (the `netlab` binary) from PyPI

# Only `list_examples` needs netlab's SOURCE tree (tests/integration); it is gitignored.
git clone --depth 1 https://github.com/ipspace/netlab netlab

pytest -m "not docker"              # offline + contract suite, no docker needed
netlab-mcp                          # run the MCP server over stdio

Install — lab (docker + containerlab)

The lab path (validate_in_lab) has host prerequisites that pip does not install. On a dedicated Linux lab host:

#

Prerequisite

Why

How

1

containerlab ≥ 0.75.0

netlab 26.06's container provider requires it

containerlab install docs

2

Ansible in the same venv as netlab

netlab pushes device config via Ansible, calling bare ansible-galaxy/ansible-playbook from PATH

uv pip install 'ansible<=11.10' paramiko netmiko ansible-pylibssh ncclient netaddr (or netlab install ansible)

3

Per-device Ansible collections

each NOS driver needs its collection

e.g. ansible-galaxy collection install nokia.srlinux (srlinux); arista.eos (ceos)

4

Scoped passwordless sudo for containerlab

netlab runs sudo -E containerlab deploy non-interactively

see block below

PATH trap: because netlab invokes bare binary names, the server must run with the venv activated (or .venv/bin on PATH), or netlab won't find ansible-playbook / netlab.

Passwordless sudo — create /etc/sudoers.d/netlab-clab (mode 0440, validate with visudo -cf):

<user> ALL=(root) NOPASSWD: SETENV: /usr/bin/containerlab
  • The SETENV: tag is mandatory — netlab passes -E; without it you get sorry, you are not allowed to preserve the environment.

  • Do NOT use NOPASSWD: ALL.

  • Security implication: containerlab can bind-mount host paths and run privileged containers, so this entry is effectively passwordless root for <user>. Use it only on a dedicated/disposable lab host. See SECURITY.md.

Verify the host is lab-ready: docker info and containerlab version (≥ 0.75.0) succeed. If they don't, validate_in_lab degrades cleanly to verdict unavailable (it is not an error) and the offline tools keep working.

Quickstart — the eBGP srlinux + frr loop

Canonical topology: tests/fixtures/mvp_bgp.yml — srlinux DUT (AS 65000) ↔ frr peer (AS 65100), with a validate.session test that checks the BGP neighbor reaches Established.

Driving the tools the way an MCP client would (see scripts/smoke_offline.py):

  1. generate_topology("ebgp peering", ["srlinux", "frr"]) → netlab topology YAML.

  2. render_config(topology_yaml) → real per-node config (srlinux JSON-RPC, frr vtysh) + clab.yml.

  3. validate_in_lab(topology_yaml, ["srlinux", "frr"], module="bgp") → deploy + netlab validate; verdict pass is recorded as known-good (with cached artifacts).

  4. get_known_good("bgp", "srlinux") → the lab-passed topology + config for reuse.

Security model

  • Free-image allow-list, enforced on netlab's resolved node devices (not the caller's platforms claim) and fails closed when a device can't be resolved — licensed NOSes are rejected.

  • ceos is gated behind the explicit NETLAB_MCP_ACCEPT_CEOS_EULA env flag.

  • External tools: (edgeshark, nso, …) are rejected, with netlab up --no-tools as a backstop.

  • A platforms/topology mismatch is rejected (no spoofing the declared device set).

  • Every config-bearing response embeds the lab≠production disclaimer.

Full threat model — including what the guardrails explicitly do not protect against — is in SECURITY.md.

Configuration (env vars)

Variable

Effect

NETLAB_MCP_NETLAB_BIN

path to the netlab executable (default: same venv, then PATH)

NETLAB_MCP_STORE

store dir for the matrix db + artifacts (default: ./store)

NETLAB_MCP_WORKDIR

base dir for per-request temp workdirs (default: ./.work)

NETLAB_MCP_ACCEPT_CEOS_EULA

set truthy to allow the EULA-gated ceos image

NETLAB_MCP_PLATFORMS

comma-separated extra device names to allow past the free set

NETLAB_MCP_ALLOW_INSTALLED

set truthy to allow any device backed by a locally loaded docker image

NETLAB_MCP_TRANSPORT

stdio (default) or http (streamable HTTP on /mcp)

NETLAB_MCP_HOST / NETLAB_MCP_PORT

HTTP bind address (default 127.0.0.1:8000)

NETLAB_MCP_TOKEN / NETLAB_MCP_TOKEN_FILE

enable static bearer auth on the HTTP transport

HTTP transport

NETLAB_MCP_TRANSPORT=http NETLAB_MCP_TOKEN_FILE=/etc/netlab-mcp/token netlab-mcp

serves MCP on http://127.0.0.1:8000/mcp (Authorization: Bearer <token>) plus an unauthenticated GET /health liveness probe (cheap, non-sensitive — safe to expose to uptime checks). A non-loopback NETLAB_MCP_HOST is refused unless a token is configured: validate_in_lab reaches docker/sudo on this machine, so the token is effectively root-equivalent — treat it accordingly and prefer NETLAB_MCP_TOKEN_FILE (mode 0600) over the bare env var. Client config:

{
  "mcpServers": {
    "netlab": {
      "type": "http",
      "url": "http://127.0.0.1:8000/mcp",
      "headers": { "Authorization": "Bearer <token>" }
    }
  }
}

Systemd unit sketch:

[Service]
Environment=NETLAB_MCP_TRANSPORT=http
Environment=NETLAB_MCP_TOKEN_FILE=/etc/netlab-mcp/token
ExecStart=/opt/netlab-mcp/.venv/bin/netlab-mcp
User=netlab

Architecture

LLM / MCP client → FastMCP server (allow-list + disclaimer guardrails) → offline engine (netlab create / initial -o / show module-support) or lab engine (netlab up → containerlab → netlab validate) → sqlite matrix store. See docs/netlab-mcp-architecture.excalidraw (open at excalidraw.comFile ▸ Open; regenerate with python scripts/gen_diagram.py).

Layout

src/netlab_mcp/
  server.py            FastMCP app + tool registrations
  config.py            netlab binary discovery, platform allow-list, paths
  models.py            disclaimer + shared constants
  engine/              runner, transform, render, compat, probes, lab, topo, topogen
  store/               sqlite matrix + yaml mirror + results.yaml harvest
store/                 runtime state (matrix.db gitignored, matrix.yaml committed)
tests/                 offline (CI-safe), contract, lab (docker-gated)

Contributing

See CONTRIBUTING.md. The PR gate is pytest -m "not docker"; lab tests are docker-gated. By participating you agree to the Code of Conduct.

License

Apache-2.0. The wrapped ipspace/netlab engine is separately licensed (MIT) and is not vendored or redistributed by this project — it is installed as a dependency.

Acknowledgements

Built on ipspace/netlab and containerlab. Disclaimer: this is an independent project, not affiliated with or endorsed by either.

Available Tools

8 tools
generate_topologyA

Turn an intent + target platforms into a netlab topology YAML (parse-validated).

intent: free text, e.g. "ebgp peering" or "ospf two routers". The module is inferred. platforms: NOS list, dut first (MVP free set: srlinux, frr, cumulus, vyos, linux). Feed the returned topology_yaml to render_config or validate_in_lab.

ParametersJSON Schema
NameRequiredDescriptionDefault
intentYes
platformsNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.4/5.0
Behavior4/5

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

The description discloses key behaviors: the output is parse-validated YAML, the module is inferred, and platform list order matters (DUT first). With no annotations provided, the description carries the full burden and covers the main behavioral aspects, though it doesn't mention any potential side effects or permissions required.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise (two sentences plus brief elaboration) and front-loaded with the main purpose. Every sentence adds value: purpose, parameter guidance, and downstream usage. No unnecessary words.

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?

Given the tool has 2 parameters, an output schema, and no nested objects, the description covers all necessary aspects: what the tool does, what inputs mean, and how to use the output. It is fully complete for an agent to select and invoke the tool correctly.

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?

The description adds significant meaning beyond the input schema: it explains that 'intent' is free text with examples, and 'platforms' is a NOS list with DUT-first ordering and an MVP set. Schema coverage is 0% but the description fully compensates, providing clear semantics for both parameters.

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 description clearly states the tool's purpose: 'Turn an intent + target platforms into a netlab topology YAML (parse-validated).' It uses a specific verb ('Turn') and resource ('netlab topology YAML'), and distinguishes itself from siblings by mentioning that the output should be fed to 'render_config' or 'validate_in_lab'.

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?

The description implies usage context by explaining that the output is intended for downstream tools ('render_config' or 'validate_in_lab'), but it does not explicitly state when to use this tool versus alternatives like 'list_examples' or 'query_compatibility'. It gives examples of intent but no exclusions.

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

get_known_goodB

Return a previously lab-passed topology + rendered config for module+platform, if any.

ParametersJSON Schema
NameRequiredDescriptionDefault
moduleYes
platformYes
netlab_versionNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

B3.3/5.0
Behavior2/5

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

No annotations are provided, and the description only states it returns data 'if any'. It does not disclose whether the tool is read-only, what happens on missing data, or any side effects, leaving behavioral assumptions ambiguous.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single front-loaded sentence of 13 words, efficiently conveying the core purpose without any fluff.

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

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (3 parameters, 0% coverage, no annotations) and the presence of an output schema, the description still lacks context on what defines a 'known good' entry, how the lookup works, and what the rendered config includes, making it insufficient for a first-time user.

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

Parameters2/5

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

With 0% schema description coverage, the description should clarify parameter meanings. It mentions 'module+platform' but does not explain the parameters, particularly netlab_version which is optional, nor does it provide examples or constraints.

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 description clearly states that the tool returns a previously lab-passed topology and rendered config for a given module and platform. It effectively distinguishes this from sibling tools like generate_topology (which creates new) and render_config (which may not be limited to known-good).

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?

The description implies usage for retrieving known-good results, but does not explicitly state when to use this tool versus alternatives, nor does it provide conditions or when not to use it.

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

host_checkA

Diagnose this host's lab readiness in one call — run this first when anything fails.

Reports docker/containerlab availability + versions, the netlab version, which platforms are allowed, which devices have locally loaded images (deployable without a pull), and which devices can anchor validate tests per module.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.5/5.0
Behavior4/5

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

With no annotations provided, the description fully discloses what the tool reports: Docker/containerlab availability, versions, allowed platforms, locally loaded images, and validate anchor devices. It does not mention side effects, but as a diagnostic tool, side effects are unlikely.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise: two sentences with no wasted words. The first sentence is a clear call-to-action, and the second enumerates the diagnostic outputs.

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 no-parameter diagnostic tool, the description covers its purpose, usage timing, and output details. An output schema exists, so the description need not detail return values, making it complete.

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?

The tool has zero parameters, so the input schema is fully covered. The description adds value by explaining what information the tool gathers and reports, going beyond the trivial schema.

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 description clearly states the tool diagnoses host lab readiness and should be run first when failures occur. It distinguishes itself from sibling tools like generate_topology and validate_in_lab by positioning itself as a first diagnostic step.

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?

The description explicitly advises running this tool 'first when anything fails,' providing clear when-to-use guidance. It lacks explicit when-not-to-use instructions, but the context and sibling list imply its role as a preliminary check.

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

list_examplesA

Index netlab's integration test topologies (real, maintained multi-platform scenarios).

With no module: list available modules + counts. With a module: list its scenarios.

ParametersJSON Schema
NameRequiredDescriptionDefault
moduleNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.3/5.0
Behavior3/5

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

No annotations are provided, so the description carries the burden. It discloses the two operational modes but does not mention side effects, authentication needs, or error handling. A 3 is appropriate as it is minimally transparent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences with no wasted words. It front-loads the overall purpose and then details the parameter behavior. Highly concise and well-structured.

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?

Given the tool's simplicity (1 optional parameter, output schema present), the description covers the two modes completely. The output schema handles return details, so no further explanation is needed.

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 coverage is 0%, requiring the description to compensate. It explains the 'module' parameter behavior (null vs string), adding meaningful context that the schema lacks. This justifies a score above baseline.

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 description clearly states the tool indexes netlab's integration test topologies and explains the two distinct behaviors with and without the module parameter. It differentiates from sibling tools like generate_topology or validate_in_lab by focusing on listing/indexing.

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?

The description explicitly guides usage with and without the module parameter. It does not provide exclusion criteria or mention alternatives, but the behavior is well-defined for a listing tool.

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

query_compatibilityC

What netlab declares a platform supports, overlaid with what was observed in the lab.

declared comes from netlab; observed comes from prior validate_in_lab/harvest runs. conflicts flags cells declared-supported but observed-failing for the current version.

ParametersJSON Schema
NameRequiredDescriptionDefault
moduleNo
platformsNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

C2.7/5.0
Behavior3/5

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

With no annotations, the description carries the burden. It discloses that the tool is read-only (querying) and overlays two data sources, flagging conflicts. However, it doesn't discuss permissions, rate limits, or the exact conflict detection logic.

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 description is concise (3 short sentences) and front-loaded with the core purpose. The use of backticks and asterisks adds clarity for 'declared', 'observed', and 'conflicts'. No unnecessary words.

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

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (combining two data sources with optional filtering), the description omits crucial details: how to filter by module/platform, output structure, conflict criteria, and relationship to sibling tools. An output schema exists but is not described.

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

Parameters1/5

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

The input schema has 0% description coverage, and the description does not explain the purpose or expected values of the 'module' and 'platforms' parameters. A user cannot infer how to use these parameters from the description alone.

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?

The description clearly states the tool's purpose: querying compatibility data by overlaying declared (netlab) and observed (lab) supports. It distinguishes itself from sibling tools like validate_in_lab by focusing on data comparison and conflict flagging.

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

Usage Guidelines2/5

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

The description explains the data sources (declared from netlab, observed from prior runs) but provides no guidance on when to use this tool versus alternatives like get_known_good or validate_in_lab. No exclusions or prerequisites are mentioned.

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

render_configA

Render real per-device config from a netlab topology — offline, no containers.

Returns {per_node: {node: {module: config_text}}, clab_yaml, disclaimer}. This is the netlab data-model transform + Jinja2 render; the config matches what would deploy.

ParametersJSON Schema
NameRequiredDescriptionDefault
topology_yamlYes
nodesNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.9/5.0
Behavior4/5

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

Given no annotations, the description discloses the offline nature, the data-model transform + render process, and the return structure. Lacks fuller detail on side effects or permissions, but provides adequate behavioral context for an apparent read-only compute.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two concise sentences: first states purpose with key qualifiers, second details return structure and process. No fluff; every sentence adds value.

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?

Despite lacking schema descriptions, the description covers core functionality, offline mode, transformation process, and return structure. With an output schema, return details are covered elsewhere. Minor gaps in parameter explanation prevent a 5.

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

Parameters2/5

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

Schema description coverage is 0%, yet the description does not explain what topology_yaml expects (e.g., YAML string content) or how nodes filters devices. Baseline with no schema descriptions would be 1, but the description gives minimal hint that input is a netlab topology, raising it to 2.

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?

Clearly states verb 'Render' and resource 'real per-device config from a netlab topology'. The offline, no-container detail distinguishes it from sibling tools that likely involve live environments, such as validate_in_lab.

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?

Implies usage for offline config generation but no explicit when-to-use or when-not-to-use guidance. Sibling tools like host_check and validate_in_lab suggest different contexts, but the description does not directly contrast them.

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

report_failureC

Record a negative result (a combo that did not work) into the compatibility matrix.

ParametersJSON Schema
NameRequiredDescriptionDefault
moduleYes
platformsYes
topology_yamlYes
errorYes
stageNounknown

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

C2.9/5.0
Behavior2/5

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

No annotations provided, so the description must disclose behavioral traits. It only states it records a result, but does not explain side effects (e.g., overwriting, idempotency, validation) or requirements (e.g., authentication). This is insufficient for a write operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single concise sentence. However, it sacrifices essential information (parameter explanations, behavioral notes). While efficient, it is too brief to be fully helpful.

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

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has 5 parameters (4 required) with no schema coverage. Despite having an output schema, the lack of parameter descriptions and behavioral transparency means the agent cannot reliably invoke this tool. The description is incomplete for its complexity.

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

Parameters1/5

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

Schema description coverage is 0%. The description does not explain any of the 5 parameters (module, platforms, topology_yaml, error, stage). An agent cannot know format or constraints, making correct invocation unlikely.

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 description clearly states the action 'Record a negative result' and specifies the target 'compatibility matrix'. It distinguishes this tool from siblings like query_compatibility or validate_in_lab by focusing on reporting failures.

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?

The description implies usage when a combo fails but does not explicitly state when to use this tool vs alternatives, nor does it mention when not to use it. No guidance on prerequisites or exclusions.

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

validate_in_labA

Deploy a topology to containerlab, run netlab validate, and record the verdict.

Requires docker + containerlab on a Linux host. Returns the verdict (pass/fail/warning), rendered config, raw validate output, and persists a version-scoped matrix row. The lab is always torn down afterward. On a host without containerlab this returns verdict "unavailable" rather than failing.

ParametersJSON Schema
NameRequiredDescriptionDefault
topology_yamlYes
platformsYes
moduleNobgp
scenarioNo
keep_labNo
timeout_sNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.7/5.0
Behavior3/5

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

The description discloses key side effects (lab teardown, persistent matrix row) and return components. However, it contains an apparent contradiction: it states 'The lab is always torn down afterward' but the schema includes a 'keep_lab' parameter (default false) that suggests the lab may be kept. This undermines transparency slightly. No annotations were provided, so the description carries full burden.

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 description is brief (3 sentences) and front-loads the primary action. The contradiction slightly harms clarity, but overall it is efficient and avoids unnecessary verbosity.

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

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has an output schema (not shown) which reduces the need to detail return values. The description covers key outcomes and persistence but omits parameter details and has a contradiction. Given the parameter count (6), more completeness would be beneficial.

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

Parameters2/5

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

Schema coverage is 0%, meaning the description must explain parameter meanings. It only implicitly covers 'topology_yaml' (the topology) and possibly 'platforms'. It fails to explain 'module', 'scenario', 'keep_lab', and 'timeout_s', leaving the agent to guess their roles in the validation process.

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 description clearly specifies the action ('validate'), the resource ('topology in containerlab'), and the process (deploy, run netlab validate, record verdict). It distinguishes this tool from siblings like 'generate_topology' and 'host_check' by focusing on validation and persistence.

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?

The description explicitly states prerequisites (Docker, containerlab, Linux host) and gracefully degrades to 'unavailable' without them. It implies usage for validation scenarios but does not mention alternatives or when not to use, though the context is clear enough for an agent.

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

TDQS

A3.8/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose: topology generation, known-good retrieval, host check, example listing, compatibility query, config rendering, failure reporting, and lab validation. No overlap in functionality.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case (e.g., generate_topology, validate_in_lab, report_failure). Naming is predictable and readable.

Tool Count5/5

With 8 tools, the set is well-scoped for a netlab MCP server. Each tool is justified and covers a specific step in the workflow without being excessive or insufficient.

Completeness5/5

The tool surface covers the full lifecycle: topology generation, config rendering, validation, host readiness, compatibility queries, failure reporting, and example browsing. No obvious missing operations for the intended domain.

Maintenance

ActivityInactive
ResponsivenessSyncing

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/steinzi/netlab-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server