loading…
Search for a command to run...
loading…
Enables AI agents to interact with Cisco IOS-XE network devices over SSH using structured tools. Provides read and write capabilities for network management wit
Enables AI agents to interact with Cisco IOS-XE network devices over SSH using structured tools. Provides read and write capabilities for network management with built-in validation and security.
A Model Context Protocol (MCP) server that lets an AI agent interact with a Cisco IOS-XE network device over SSH. Built in Python with FastMCP and Netmiko.
The server exposes 7 tools (5 read + 2 write), each with strict input validation and clear descriptions so an LLM agent can discover and use them autonomously.
Course: Agent AI & Automation — Sheridan College Author: Ahmed Instructor: Sebastian
This project targets Cisco's Always-On IOS-XE DevNet Sandbox. It is free, publicly reachable, requires no reservation, and is always up.
| Setting | Value |
|---|---|
| Host | sandbox-iosxe-latest-1.cisco.com |
| Port | 22 (SSH) |
| Username | admin |
| Password | C1sco12345 |
| Device type | Cisco IOS-XE (Catalyst 8000v) |
Reference: Cisco DevNet — Always-On Sandboxes.
Quick connectivity check from your machine:
ssh [email protected]
# password: C1sco12345
You should land at Router# (or similar) prompt. If this works, the MCP
server will work too.
The sandbox is shared. Please keep changes small and non-disruptive (e.g. only edit interface descriptions, don't shut interfaces or change IPs).
Requires Python 3.10+.
# 1. Clone / copy the project
cd network-mcp-server
# 2. Create and activate a virtual environment (recommended)
python -m venv .venv
source .venv/bin/activate # on Windows: .venv\Scripts\activate
# 3. Install dependencies
pip install -r requirements.txt
Dependencies:
mcp[cli] — MCP Python SDK (provides FastMCP)netmiko — multi-vendor SSH/CLI librarypython-dotenv — loads .env for local devcp .env.example .env
# edit .env if your lab uses different credentials
python server.py
The server runs over stdio, so it waits on stdin for MCP JSON-RPC
messages. In practice you won't invoke it by hand — you'll connect Claude
Desktop (see below) or the mcp dev CLI.
mcp dev server.py
This opens the MCP Inspector in your browser where you can list tools and call them manually.
| Tool | Description |
|---|---|
get_device_info |
Hostname, model, software version, uptime, serial. Parses show version. |
get_interfaces |
All interfaces with status, IP, description. Parses show ip interface brief + show interfaces description. |
get_routes |
IPv4 routing table. Parses show ip route into structured entries. |
get_arp_table |
IP-to-MAC mappings. Parses show ip arp. |
get_running_config |
Full running config, or a single section (e.g. interface GigabitEthernet1). Takes optional section arg. |
| Tool | Description |
|---|---|
configure_interface_description |
Sets a description on an interface and verifies the change was applied by reading it back. Args: interface, description. |
save_config |
Runs copy running-config startup-config to persist changes across reload. |
All tool outputs are JSON strings so the LLM can reason over structured
data. When Netmiko's TextFSM parsers can't handle an output, the server
falls back to raw CLI text inside a {"raw": "..."} wrapper.
Locate Claude Desktop's config file:
~/Library/Application Support/Claude/claude_desktop_config.json%APPDATA%\Claude\claude_desktop_config.json~/.config/Claude/claude_desktop_config.jsonMerge the block below into the file (use the full absolute path to
your server.py):
{
"mcpServers": {
"network-mcp-server": {
"command": "python",
"args": ["/ABSOLUTE/PATH/TO/network-mcp-server/server.py"],
"env": {
"DEVICE_HOST": "sandbox-iosxe-latest-1.cisco.com",
"DEVICE_PORT": "22",
"DEVICE_USERNAME": "admin",
"DEVICE_PASSWORD": "C1sco12345",
"DEVICE_TYPE": "cisco_xe"
}
}
}
}
A ready-to-copy version lives in claude_desktop_config.example.json.
Fully quit and reopen Claude Desktop. (Just closing the window is not enough — it keeps the MCP process alive.)
In a new chat, click the 🛠️ / tools icon. You should see
network-mcp-server listed with 7 tools.
Once connected, try these prompts:
"What device am I connected to? Give me its hostname, model, and IOS version." The agent will call
get_device_info.
"List all interfaces that currently have an IP address assigned." The agent will call
get_interfacesand filter the results.
"Show me the default route." The agent will call
get_routesand pick the entry with network0.0.0.0.
"Set the description on GigabitEthernet2 to 'managed by MCP demo', then confirm the change was applied." The agent will call
configure_interface_description, then (optionally)get_running_configwithsection='interface GigabitEthernet2'to double-check.
"Save the running config to startup." The agent will call
save_config.
The MCP server needs:
admin account is already enable-level. If you use your own device,
the account must be able to enter config t and issue write memory..env file or equivalent environment
variables set by Claude Desktop.The server does not need root/admin on your workstation.
DEVICE_USERNAME, DEVICE_PASSWORD). If any required env var is missing
the server refuses to connect and returns a clear error..env is git-ignored. A .env.example (with safe-to-share DevNet
sandbox values) is provided instead.;, |, backtick, newline, null byte) are
rejected.configure_interface_description
reads the config back after applying the change and reports
applied: true/false.erase startup-config) are deliberately
not exposed."Missing required environment variable(s)"
You forgot to set DEVICE_HOST / DEVICE_USERNAME / DEVICE_PASSWORD.
Copy .env.example to .env or set them in Claude Desktop's env block.
"Authentication to
"Connection to ssh [email protected]
from the same machine. If that hangs too, your firewall/VPN is the issue.
Claude Desktop doesn't show the server after editing the config
Fully quit Claude Desktop (not just close the window) and reopen it. On
macOS: Cmd+Q. On Windows: right-click tray icon → Quit.
Tool call returns raw text instead of parsed JSON
This means Netmiko's TextFSM template didn't match the device output
(different IOS version, different platform). The server falls back to raw
CLI text in {"raw": "..."}. The agent can still reason over it; it's
just not structured.
Добавь это в claude_desktop_config.json и перезапусти Claude Desktop.
{
"mcpServers": {
"network-mcp-server": {
"command": "npx",
"args": []
}
}
}