Skip to main content

eos-mcp

MCP server for Arista EOS device operations via eAPI.

Exposes EOS show commands, running-config retrieval, configuration push (via configure session with commit timer), and tech-support collection to MCP-compatible AI assistants.

Installation

pip install eos-mcp

Configuration

Copy config.ini.example to ~/.config/eos-mcp/config.ini and fill in credentials:

[DEFAULT]
username = admin
password = yourpassword
transport = https
verify = false

[switch1.example.com]
tags = main,dc1

[switch2.example.com]
tags = main,dc1

Config file discovery order:

  1. EOS_MCP_CONFIG environment variable
  2. ./config.ini (current directory)
  3. ~/.config/eos-mcp/config.ini

(Individual MCP tool calls may also override the path via a config_path parameter.)

Usage

# Verify config and list devices
eos-mcp --check

# Test connectivity to a specific host
eos-mcp --check --check-host switch1.example.com

# Start MCP server (stdio transport)
eos-mcp

Tools

Tool Description
health_check Report server version and config status (lightweight; does NOT connect to devices)
get_router_list List registered devices (optional tag filter)
get_device_facts Return structured facts for one device (model, serial, EOS version, uptime, memory)
get_device_facts_batch Return device facts for multiple devices in parallel
get_version Return EOS version string (quick connectivity check)
run_command Run a single enable-mode command on one device
run_commands Run multiple enable-mode commands on one device
run_command_batch Run an enable-mode command on multiple devices in parallel
run_commands_batch Run multiple enable-mode commands on multiple devices in parallel
get_config Retrieve running-config
get_config_diff Show config diff vs rollback checkpoint
list_config_sessions List configure sessions and their state
push_config Push config via configure session (dry_run=True by default)
confirm_config_session Confirm a pending commit timer session
abort_config_session Abort a pending session
collect_tech_support Collect show tech-support output
daily_brief Health check (environment, errdisabled, uptime, MLAG, recent syslog alerts) across multiple devices

Development

Live smoke test

Unit tests check logic against fixtures; they cannot tell you that a tool has stopped returning real data. scripts/smoke_test.py runs every registered tool against the configured devices and fails on empty, malformed or error answers:

# uses the same inventory file as the server (EOS_MCP_CONFIG)
uv run python scripts/smoke_test.py
uv run python scripts/smoke_test.py --only facts --traceback
  • Read-only. push_config, confirm_config_session and abort_config_session are skipped by name, and a test enforces that. collect_tech_support is skipped too — it changes nothing, but it is minutes of device CPU for an answer no assertion would read. The command-running tools are exercised with show version: they accept enable-mode commands in general, and a smoke test must not be the thing that types one that matters.
  • No payloads in the report. Tool names and statuses only; error text is redacted too, since every error here is prefixed with the device it came from and the payloads are configuration.
  • Nothing estate-specific in the specs. The device the per-host tools need is discovered at run time from the configured inventory, and skipped when it is empty. Two tests keep it that way: one refuses those parameters as literals, the other bans anything address-shaped anywhere in the file, because this repository is public.
  • Every probe refuses the Error (<host>): ... line these tools return in place of raising — otherwise an unreachable device would read as a successful call.
  • CI enforces the cheap half: a tool registered without a probe spec fails the build (tests/test_smoke_probes.py), so adding a tool forces the question "how would we know it works?".
  • scripts/smoke_harness.py is the engine and holds no EOS knowledge: it is kept identical across the servers that share it, so fix engine bugs once and sync the file rather than patching this copy.

Requirements

  • Python >= 3.10
  • Arista EOS with eAPI enabled (management api http-commands)
  • Network access to port 443 (HTTPS) on target devices

License

Apache-2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eos_mcp-1.1.3.tar.gz (30.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

eos_mcp-1.1.3-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

Details for the file eos_mcp-1.1.3.tar.gz.

File metadata

  • Download URL: eos_mcp-1.1.3.tar.gz
  • Upload date:
  • Size: 30.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for eos_mcp-1.1.3.tar.gz
Algorithm Hash digest
SHA256 d50600ac3c55e295e31a8d0c5df5de61aff8c66b701687580edf65ac838d01c6
MD5 3df69d2455c88b9de69757f317d6e0f8
BLAKE2b-256 8119e78581a4c81f027939dc9d8ae48328076a0874f7cb8f47bc8c66079130b0

See more details on using hashes here.

Provenance

The following attestation bundles were made for eos_mcp-1.1.3.tar.gz:

Publisher: release.yml on shigechika/eos-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file eos_mcp-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: eos_mcp-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 18.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for eos_mcp-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 cc92fb9430e8882350c6004b1fa6ab5896c5c6cf7220a6d7e1637eccee8a68bc
MD5 97491713faaaf63b14a252ecff8f4acb
BLAKE2b-256 479673de15b4787c5ea6044df36ea007a5bb4bcca1864248f30499922ec2bfeb

See more details on using hashes here.

Provenance

The following attestation bundles were made for eos_mcp-1.1.3-py3-none-any.whl:

Publisher: release.yml on shigechika/eos-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.3.0

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.4

2 files

This release

1.1.3 This release

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.4.1

2 files

0.4.0

2 files

0.3.1

2 files

0.3.0

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page