README
¶
netdev-ssh-mcp
MCP server for interacting with network devices (switches, routers) over SSH. Supports Arista EOS, Cisco NX-OS, and Cisco IOS/IOS-XE. Exposes network device operations as tools for use with Claude Code and Claude Desktop (and other MCP clients)
Tools
get_config
Retrieves the running or startup configuration from an Arista, Cisco Nexus, or Cisco Catalyst device. Sensitive values (passwords, secrets, SNMP community names, BGP/OSPF/TACACS/RADIUS/IKE keys) are automatically replaced with deterministic SHA-256 hashes:
enable secret [h:a3f4b2c1d5e6]
snmp-server community [h:f9e1d2b4c3a7] ro
username admin privilege 15 secret [h:a3f4b2c1d5e6]
The same secret value always produces the same hash, so configs from different devices can be safely compared and diffed — identical hashes mean identical secrets.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
host |
string | yes | — | Hostname or IP address of the device |
username |
string | no | DEVICE_USERNAME |
SSH username |
port |
int | no | 22 | SSH port |
config_type |
string | no | running |
running or startup |
run_show_command
Runs any show command on an Arista, Cisco Nexus, or Cisco Catalyst device
and returns the output. The command must start with show. Append | json
for structured output where supported, or | no-more to disable pagination
for text output.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
host |
string | yes | — | Hostname or IP address of the device |
command |
string | yes | — | The show command to run |
username |
string | no | DEVICE_USERNAME |
SSH username |
port |
int | no | 22 | SSH port |
Example commands:
show bgp summary | json
show interfaces status | json
show lldp neighbors detail | json
show inventory | json
show version | json
show ip route | json
show running-configandshow startup-configare not allowed here — use theget_configtool instead.
Default username
Set DEVICE_USERNAME to avoid specifying username in every tool call:
export DEVICE_USERNAME=admin
The username tool parameter takes precedence if provided.
Authentication
Authentication methods are tried in order:
- SSH agent — if
SSH_AUTH_SOCKis set, the agent is used automatically. No configuration needed. - Password — set via the
DEVICE_PASSWORDenvironment variable (see below).
At least one method must be available at call time.
Claude Desktop note: Claude Desktop is a GUI application and does not inherit your shell environment, so
SSH_AUTH_SOCKis not available to the MCP server process. Set it explicitly in theenvblock of the config (see the Claude Desktop section below). Claude Code runs in the terminal and inherits your shell environment, so no extra configuration is needed there.
Password via environment variable
Set DEVICE_PASSWORD before starting the server:
export DEVICE_PASSWORD=mysecret
netdev-ssh-mcp
The password is never passed through tool parameters or the MCP protocol — it is read once from the environment at call time and applies to all connections made by the server process.
Building
Requires Go 1.26 or later.
go build -o netdev-ssh-mcp .
To install the binary to /usr/local/bin after building (macOS and Linux):
sudo install -m 0755 netdev-ssh-mcp /usr/local/bin/
Integration
Claude Code
Add a project-local .mcp.json at the root of your repository:
{
"mcpServers": {
"netdev-ssh-mcp": {
"command": "/usr/local/bin/netdev-ssh-mcp"
}
}
}
With a default username:
{
"mcpServers": {
"netdev-ssh-mcp": {
"command": "/usr/local/bin/netdev-ssh-mcp",
"env": {
"DEVICE_USERNAME": "admin"
}
}
}
}
Claude Code runs in the terminal and inherits your shell environment, so
SSH_AUTH_SOCK is available automatically — no extra configuration needed for
SSH agent authentication.
Alternatively, using password authentication:
{
"mcpServers": {
"netdev-ssh-mcp": {
"command": "/usr/local/bin/netdev-ssh-mcp",
"env": {
"DEVICE_USERNAME": "admin",
"DEVICE_PASSWORD": "mysecret"
}
}
}
}
Alternatively, register the server globally with the Claude Code CLI:
claude mcp add netdev-ssh-mcp /usr/local/bin/netdev-ssh-mcp
Claude Desktop
Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS)
or %APPDATA%\Claude\claude_desktop_config.json (Windows):
{
"mcpServers": {
"netdev-ssh-mcp": {
"command": "/usr/local/bin/netdev-ssh-mcp"
}
}
}
Claude Desktop does not inherit your shell environment, so SSH_AUTH_SOCK
must be set explicitly. Get the current socket path from your terminal:
echo $SSH_AUTH_SOCK
Then add it to the config:
{
"mcpServers": {
"netdev-ssh-mcp": {
"command": "/usr/local/bin/netdev-ssh-mcp",
"env": {
"DEVICE_USERNAME": "admin",
"SSH_AUTH_SOCK": "/private/tmp/com.apple.launchd.XXXXX/Listeners"
}
}
}
}
Note that the socket path changes on every reboot and must be updated in the config accordingly.
Alternatively, using password authentication:
{
"mcpServers": {
"netdev-ssh-mcp": {
"command": "/usr/local/bin/netdev-ssh-mcp",
"env": {
"DEVICE_USERNAME": "admin",
"DEVICE_PASSWORD": "mysecret"
}
}
}
}
Restart Claude Desktop after editing the config.
Obfuscation
Sensitive values are obfuscated by default in the output of both get_config
and run_show_command. To disable this, pass --no-obfuscate:
netdev-ssh-mcp --no-obfuscate
In an MCP config file, pass it via args:
{
"mcpServers": {
"netdev-ssh-mcp": {
"command": "/usr/local/bin/netdev-ssh-mcp",
"args": ["--no-obfuscate"]
}
}
}
Logging
The server logs to stderr (never stdout, which is reserved for the MCP
protocol). The log level is controlled by the LOG_LEVEL environment
variable:
| Value | Description |
|---|---|
debug |
Connection details, command strings, byte counts |
info |
Default — tool calls, connect/disconnect, success/failure |
warn |
Warnings only |
error |
Errors only |
LOG_LEVEL=debug netdev-ssh-mcp
Author
Krzysztof Ciepłucha
Disclaimer
This tool was designed and built with the assistance of AI tools. The design decisions, architecture, and all code have been reviewed and verified by a human. The project goes through automated security checks, vulnerability scanning, and static code analysis on every commit.
That said, this software is provided as-is with no guarantees. It may contain bugs. Use at your own risk.
License
Licensed under the Apache License, Version 2.0. See LICENSE for details.
Documentation
¶
There is no documentation for this package.