MM

mikrotik-mcp/mikrotik-mcp

开发工具
21 stars 0 forks 质量 90 趋势 90

A Bun-native MCP server that turns one or more MikroTik routers into +950 tools your AI can drive. Firewall · routing · DHCP/DNS · wireless · QoS · and a complete VPN suite — over SSH, with...

概览

Drive one or more MikroTik routers in plain language — 950 risk-annotated tools your AI can call, over SSH. Firewall · routing · DHCP/DNS · wireless · QoS · a complete VPN suite · transactional Safe Mode · live attack detection · and an observability dashboard that watches every call. @usex/mikrotik-mcp turns into any MCP client (Claude Desktop, Claude Code, Cursor, …) can call to read and configure your router by talking to it. It reaches the device over — no agent, no package to install on RouterOS — runs on , and validates every call against a schema. "Show me the firewall input chain, then block SSH from the WAN under safe mode." "Build an IKEv2 site-to-site tunnel to 203.0.113.5 for 192.168.20.0/24." "Why can't VLAN 50 reach the internet?" - lookup_ip_intelligence and Diagnostics → IP Intelligence compare full ipquery/ipkit responses: ASN/organization, location, risk and every additional field, with searchable details and JSON export.

README


@usex/mikrotik-mcp turns MikroTik RouterOS into 924 Model Context Protocol tools any MCP client (Claude Desktop, Claude Code, Cursor, …) can call to read and configure your router by talking to it. It reaches the device over plain SSH — no agent, no package to install on RouterOS — runs on Bun, and validates every call against a schema.

Point it at a router and go:

// claude_desktop_config.json
{
  "mcpServers": {
    "mikrotik": {
      "command": "mikrotik-mcp",
      "env": {
        "MIKROTIK_HOST": "192.168.88.1",
        "MIKROTIK_USERNAME": "admin",
        "MIKROTIK_PASSWORD": "your-password",
      },
    },
  },
}

Then just ask:

“Show me the firewall input chain, then block SSH from the WAN under safe mode.” “Build an IKEv2 site-to-site tunnel to 203.0.113.5 for 192.168.20.0/24.” “Why can’t VLAN 50 reach the internet?”

Highlights

  • IP Intelligence: lookup_ip_intelligence and Diagnostics → IP Intelligence compare full ipquery/ipkit responses: ASN/organization, location, risk and every additional field, with searchable details and JSON export. Public IPs are sent only on submission; private IPs stay local. Guide.

  • Service probes: add, edit, search and remove approved HTTPS/TLS/TCP/DNS targets directly in Config or Service Routing, with explicit IP/CIDR boundaries and safe-apply confirmation. Setup guide.

  • OpenVPN connections: live sessions and persistent observed history, per-user/date connection counts, IP/ASN/country breakdowns and daily charts. Local cached reports avoid router reads; collection gaps remain visible. Includes confirmed single-session disconnect. Guide.

  • Service Routing: live IPv4/IPv6 routes, fuzzy address-list search, exact/wildcard domain-to-exit policies with optional health probes, per-policy live matched-traffic counters and charts, VRF HTTPS exit checks and explicitly authorized failover, with preview, backup and Safe Mode. Guide

  • Flight Recorder: opt-in, durable pre/post-incident telemetry and log metadata, with an evidence timeline and scoped JSON export. Guide

  • Recovery Lab: reviewed portable restore/upgrade rehearsals, coverage and cleanup evidence. Execution requires a separately deployed isolated CHR runner. Guide

  • Client Check — invite the affected phone/laptop with an expiring QR/link, measure browser HTTP latency, loaded latency and bounded transfers, and compare Wi-Fi/VPN runs in the dashboard. Optional investigation links keep evidence together. Tests measure the path to the MCP host, not arbitrary internet speed, DNS leakage or PMTU. Guide and trust boundary

  • Router Migration — inspect both routers, map Ethernet ports, preview supported configuration and review omitted sections. Fresh-state checks, local snapshots of both routers, Safe Mode rehearsal and verified inactive staging protect the target. Physical cutover, credentials and activation remain operator-controlled. Supported scope

  • Support Bundles — prepare a time-bounded report from saved investigations, event metadata, snapshot inventories and client measurements. Raw tool bodies, secrets and personal labels stay out; network identifiers become consistent aliases. Review before downloading self-contained HTML or JSON. Nothing is uploaded. Privacy and export

  • MCP App workspaces — 13 host-themed views, with dedicated investigation, round-trip, service-health, L2 fabric, operations and report workspaces alongside the existing device, interface, firewall and record views. Responsive grids, named path interfaces, expandable evidence and colored JSON keep results readable inside compatible MCP clients. New report views never execute or replay tools. View guide

  • Round-trip path lab — model explicit forward/reverse static IPv4 paths across fresh snapshots, with per-hop evidence and declared asymmetry. NAT or unsupported state stops with UNKNOWN; modelled forwarding is not live connectivity. A guided three-step editor selects routers, dated captures and interfaces without writing JSON, with an optional mirrored return path and plain-language result labels. Guide

  • Service health contracts — approved DNS/TCP/TLS/HTTPS endpoint checks from the MCP host, optional fresh-export packet regressions, historical evidence, explicit scheduled enrollment and fail-closed rollout gates. Disabled until targets are approved. Guide

  • Client/service investigations — save multi-router DHCP/ARP/bridge and network evidence with timestamps, explicit unknowns and next experiments. Router ICMP success never masquerades as verified application health. Guide · Delivery tracker

  • Exported client-flow paths — select a recent TCP/UDP flow and visualize its reported ingress/exit, with named VPN-interface lookup and colored JSON evidence. Uses existing NetFlow/IPFIX exports; never enables capture or changes router settings. Missing telemetry remains unknown, not a fabricated blocking hop. Flow-path guide

  • 🧰 924 tools, one per RouterOS scope — L2 (bridge, VLAN, wireless, PoE), L3 (addressing, routing, DHCP, DNS), security (firewall, NAT, address-lists, certificates), QoS, and system ops (users, logs, backups, scheduler).

  • 🛡️ Attack detection — reads every device’s log, correlates brute force, credential spraying and a login that succeeded after failures into incidents with evidence, and can block the source with a timed, reversible entry. Detect-only until you say otherwise. →

  • ⏱️ Scheduled audits — run the auditors on a cron with nobody in the loop, and hear only about what changed since the last run: new, worsened, resolved. →

  • 📖 explain_device — turns a config into the architecture document that should have been in the wiki (topology diagram, what’s exposed, what each chain does), and explains what the difference between two snapshots actually means. →

  • 🧪 Offline simulator — trace a hypothetical packet through NAT, routing and firewall against a snapshot, with no device in the loop. Reports UNKNOWN rather than guessing. →

  • 📊 Live observability dashboard — a localhost web UI that shows every tool call the AI makes in real time: inputs, outputs, latency, errors, per-device analytics. Secrets redacted. Jump to it ↓

  • 🔐 Complete VPN suite — WireGuard, IPsec (IKEv1/IKEv2), L2TP, PPTP, SSTP, OpenVPN, plus GRE/IPIP/EoIP/VXLAN. A choose-vpn-solution prompt picks one for you.

  • 🛟 Safe Mode — wrap risky changes in a real transactional window; RouterOS holds them in memory and auto-reverts if your session drops, so you can’t lock yourself out.

  • 🚦 Risk-annotated — every tool is tagged read / write / destructive, so clients auto-approve reads and prompt on writes.

  • 🧱 Injection-safe — a command builder quotes/escapes every value; a hostname like LAN; /system reset can never split into a second command.

  • 🖧 Multiple devices — name your routers and target one per call; configure both ends of a tunnel in one conversation.

  • 🪜 SSH jump hosts — reach a router with no exposed port by tunnelling through a bastion (jumpVia); commands, Safe Mode and file upload all ride the hop.

  • ⚡ Connection pooling — one persistent SSH session per device saves ~200-500 ms per command.

  • 🔀 REST API, opt-in — point a device at RouterOS 7.9+'s /rest for structured JSON and real HTTP status codes, with automatic SSH fallback for anything REST can’t express. Per-device, off by default.

Install

# Requires Bun ≥ 1.3 — https://bun.sh
bun add -g @usex/mikrotik-mcp

# Point it at your router and verify SSH connectivity
MIKROTIK_HOST=192.168.88.1 MIKROTIK_USERNAME=admin MIKROTIK_PASSWORD=•••• \
  mikrotik-mcp auth-check

# Wire it into your MCP client (stdio by default)
mikrotik-mcp serve

Prefer SSH keys? Swap the password for a key file (add a passphrase if it’s encrypted):

MIKROTIK_HOST=192.168.88.1 MIKROTIK_USERNAME=admin \
MIKROTIK_KEY_FILENAME=~/.ssh/id_ed25519 \
MIKROTIK_KEY_PASSPHRASE=•••• \
  mikrotik-mcp auth-check     # prints "Auth mode: SSH key"

Prefer a one-click bundle (no Bun/Node/npm on the machine, credentials entered in the host UI)? Build an .mcpb and drag it into Claude Desktop → Settings → Extensions:

bun run build:mcp                    # bundle for this machine
bun run build:mcp --target linux-x64 # or one target · build:mcp:all for every target

Full options: docs/configuration.md · MCPB details: docs/getting-started.md.

Simple usage — by scenario

Once the server is wired into your client, everything below is a plain-language request. The AI picks the right tool, validates it, and runs it. No CLI syntax to memorize.

🔎 See what’s on the router

“List the firewall filter rules and flag anything that allows WAN → LAN.” “What DHCP leases are active right now?” “Show interface traffic and tell me which port is saturated.”

All read-only — safe to auto-approve.

🧱 Make a change, safely

“Enable safe mode, block inbound SSH on the WAN, then commit if I’m still connected.”

Safe Mode holds the change in memory and reverts automatically if you lock yourself out:

enable_safe_mode → (make changes) → commit_safe_mode    # persist
                                   → rollback_safe_mode  # discard

🔐 Stand up a VPN

“Create a WireGuard interface on port 13231 and generate a client config for my laptop.” “Build an IKEv2 site-to-site tunnel to 203.0.113.5 for 192.168.20.0/24.”

Not sure which VPN? Ask the choose-vpn-solution prompt — it recommends one and outlines the build. Every technology is covered:

Need Use Build it with
MikroTik ↔ MikroTik, modern clients WireGuard create_wireguard_interface, add_wireguard_peer, generate_wireguard_client_config
Interop site-to-site / native IKEv2 IPsec create_ipsec_{profile,peer,identity,proposal,policy}, get_ipsec_active_peers
Built-in OS VPN clients L2TP/IPsec set_l2tp_server, create_ppp_secret, create_ppp_profile
Through restrictive firewalls SSTP (TLS) set_sstp_server, create_sstp_client
Cross-platform OpenVPN set_ovpn_server, create_ovpn_client
Route / L2-bridge between sites GRE/IPIP/EoIP/VXLAN create_gre_tunnel, create_eoip_tunnel, create_vxlan_tunnel

Details: docs/vpn-guide.md.

🖧 Manage several routers at once

Name your routers and drive them all from one conversation — exactly what you need to set up a tunnel between two MikroTiks and test it from both ends:

// devices.json
{
  "defaultDevice": "site-a",
  "devices": {
    "site-a": { "host": "203.0.113.10", "username": "admin", "keyFilename": "/keys/site-a" },
    "site-b": { "host": "198.51.100.20", "username": "admin", "password": "••••" },
  },
}
mikrotik-mcp serve --config ./devices.json
mikrotik-mcp devices        # site-a (default) · site-b

Docker: one writable devices.json for all MCP settings

Use the published alimaster/mikrotik-mcp image (6.4.0, or the moving latest tag). Docker selects linux/amd64 or linux/arm64 automatically; no local build is needed. Compose defaults to 6.4.0; set MIKROTIK_IMAGE_TAG explicitly to select a different release.

Not ARM-only: the same image runs on x86-64 and ARM64 Linux hosts (including Ubuntu), and on Windows/macOS through Docker Desktop’s Linux containers. Windows users should enable the WSL2 backend; do not select Windows containers. See the host compatibility and PowerShell quick start for platform-specific setup. Neither Compose nor the runtime is pinned to ARM.

The Bun container reads /home/bun/.mikrotik-mcp/devices.json automatically. Despite its name, this is the complete MCP configuration, not just the router list: mcp, dashboard, ssh, memory, tools, access, alerts, flows, policy, schedules, attacks, serviceProbes, s3 and top-level settings live in this same JSON. Config/Devices saves and MCP settings tools write back to it; confirm Keep changes (or confirm_mcp_settings) before restarting a pending safe-apply transaction. Listener/transport changes require a server restart.

Create a real JSON file on the host (no comments or trailing commas). For example:

{
  "defaultDevice": "home",
  "devices": {
    "home": {
      "host": "192.168.88.1",
      "username": "automation",
      "keyFilename": "/run/secrets/mikrotik_key"
    }
  },
  "mcp": { "transport": "streamable-http", "host": "0.0.0.0", "port": 8000 },
  "dashboard": { "enabled": true, "host": "0.0.0.0", "port": 9090 },
  "ssh": { "keepAlive": true },
  "memory": { "enabled": true },
  "disableUpdateCheck": true
}
docker pull alimaster/mikrotik-mcp:6.4.0
docker run -d --name mikrotik-mcp --restart unless-stopped \
  -p 127.0.0.1:8000:8000 -p 127.0.0.1:9090:9090 \
  --mount type=volume,src=mikrotik-state,dst=/home/bun/.mikrotik-mcp \
  --mount type=bind,src=/absolute/path/devices.json,dst=/home/bun/.mikrotik-mcp/devices.json \
  --mount type=bind,src=/absolute/path/mikrotik_ed25519,dst=/run/secrets/mikrotik_key,readonly \
  alimaster/mikrotik-mcp:6.4.0

Dashboard: http://localhost:9090 · MCP: http://localhost:8000/mcp. The JSON mount must be read-write, must already exist, and must be readable and writable by container UID/GID 1000. Keep it private (0600); it can contain credentials. The SSH key only needs read access. On Linux, arrange matching ownership/ACLs; do not make secrets world-readable. Mount a dedicated copy rather than sharing the live service’s file with a second writer.

The included Compose file binds ./devices.json (or the absolute path in MIKROTIK_CONFIG_PATH) and also persists application data:

# Only creates a starter file when none exists; edit it before starting.
test -e devices.json || cp docker/devices.example.json devices.json
# Configure devices + dashboard.enabled in devices.json; mount your key in Compose.
docker compose pull mikrotik-mcp
docker compose up -d mikrotik-mcp
# Or use an existing file:
MIKROTIK_CONFIG_PATH=/absolute/path/devices.json docker compose up -d mikrotik-mcp
  • The starter JSON has no credentials and leaves the dashboard disabled. Docker defaults are stored in JSON, so saved ports/settings are not silently replaced by baked-in environment defaults on restart. Explicit CLI/env overrides still win; remove conflicting .env values if JSON should be authoritative.
  • If changing listener ports in JSON, update Docker’s port mappings too. For Compose set MCP_PORT / DASHBOARD_PORT to the same new ports; these only control publishing, not application settings. Its healthcheck reads the JSON.
  • The named state volume retains databases, Memory contents, reports, config backups and history. These are data, not settings, and are not embedded in JSON. Custom database/backup paths must also be mounted. Do not use docker compose down -v if you want to retain this data.
  • For the strongest crash safety, mount a dedicated parent directory containing devices.json at /home/bun/.mikrotik-mcp instead of a single file; this preserves atomic replacement and all state on the host. Single-file mounts use a private, flushed .bak-mounted-* backup and an inode-preserving write when Linux rejects rename with EBUSY. That fallback is not power-loss atomic; keep one writer and retain backups. A read-only mount cannot persist edits. After replacing the host file by rename in an editor, recreate a single-file-mounted container to remount the new file.

See Docker deployment and persistence for directory mounts, permissions and explicit configuration overrides. Maintainers: run bun run docker:publish for the interactive Docker Hub publisher (automatic account detection/login, release review, multi-platform push and verified latest promotion). Preview safely with bun run docker:publish --dry-run. See Publishing to Docker Hub for details and manual commands.

Every tool gains an optional device argument, and Safe Mode is per-device:

“On site-a create a WireGuard interface, on site-b add it as a peer, then ping across.”

Behind a bastion with no exposed port? Jump through another router (jumpVia) — commands, Safe Mode and SFTP all ride the hop. Full guide: docs/multi-device.md.

Multiple management addresses & automatic failover

In Devices → Add device / Edit settings → Connection, add internal, VPN or public static IPs and choose Primary. The existing host is Primary; fallbackHosts holds up to seven alternate IPv4/IPv6 addresses in priority order. All addresses must reach the same router, using its shared SSH/REST ports, credentials and jump-host configuration.

{
  "host": "10.10.10.1",
  "fallbackHosts": ["203.0.113.10", "2001:db8::10"],
  "port": 22,
  "username": "admin",
  "keyFilename": "/keys/home"
}
  • A successful connection remembers its IP for 5 minutes, separately for each device and transport/port. New connections try that IP first; each successful connection renews the window. Failure clears the preference immediately. Without a cached success, Primary and then alternatives are tried in order, with a 30-second cooldown for failed addresses. Healthy pooled/Safe Mode sessions stay open even after expiry; commands already dispatched are never replayed on another IP.
  • Device cards automatically refresh address observations every 4 seconds: open connections, remembered IP and remaining preference time, last failures, and untested addresses. These are real connection observations, not continuous probes of unused addresses. Primary is never rewritten; preference is in-memory and resets on server restart or device configuration replacement.
  • SSH, SSH jump devices, SFTP, initial Safe Mode setup, REST probes and dashboard tests use this selection. Authentication/key errors stop that connection attempt; MAC-Telnet has no IP failover.
  • Device cards and list_mikrotik_devices distinguish Connected, historical success, failed attempts and untested addresses. Test connection / Connect & Save reports the IP that authenticated.
  • Failover happens before command dispatch. A lost command response is not automatically replayed on another IP or over SSH. An active Safe Mode transaction never migrates between connections.
  • Existing single-address configurations remain valid. No router interface, routing or firewall settings are changed by adding management addresses to MCP.

🩺 Diagnose and harden

“Why can’t VLAN 50 reach the internet?” “Audit my firewall for shadowed and overly-broad rules.” “Harden this router and show me the exact diff before committing.”

These map to higher-level workflows — firewall audit, security hardening, change plan & dry-run — each read-only to inspect, dry-run + Safe Mode to fix.

📊 Observability dashboard

A localhost web dashboard that watches every tool call the LLM makes against this server — in real time. Off by default, zero overhead until you flip it on, and it runs alongside whatever transport you use:

mikrotik-mcp serve --dashboard          # → http://127.0.0.1:9090

Every call flows through one choke point in the registry, so the dashboard sees all of them, across every transport. Why you’ll want it on:

  • 👁️ Live feed of every call — tool, inputs, outputs, target device, duration, success/error — streaming in over a Bun-native WebSocket (SSE fallback). Filter by tool / risk / device / status / free-text, pause & resume, export to CSV or JSON.
  • 📈 Analytics at a glance — calls in window, calls/min, error rate, avg / p95 / p99 latency, distinct tools, output volume; top tools, by-risk and status donuts, by-device bars, and a recent-errors panel.
  • 🔒 Secrets redacted before storage — any password, private key, PSK or token is replaced with «redacted» before anything is stored or streamed. Set --dashboard-capture-body=false to keep metadata only.
  • 🕸️ Devices & connectivity map — a hub-and-spoke graph of the server to each device, coloured by live SSH reachability, with per-device online/offline, latency, RouterOS identity/version and recent activity.

It also carries a page per flagship workflow — Attacks (live incidents, the evidence behind each, guarded blocking), Schedules (audit posture over time and what regressed), Explain (the architecture document with its topology diagram), Policies, Simulator, Transactions, Flows and Rollout — plus Config Studio (edit the config JSON with autocomplete + safe-apply auto-rollback), a live topology map from MNDP discovery, a releases/upgrade timeline, and a reload/restart button. Everything persists to a Bun-native SQLite store on your machine — no external database. Binds to loopback (127.0.0.1) by default; set a bearer token (--dashboard-token) to expose it safely.

Full reference: docs/observability.md.

The dashboard includes a responsive operations shell with searchable grouped navigation, pinned page shortcuts, a mobile drawer, and coordinated light/dark themes. Its 41 pages are organised into eight task-based categories, with shared-scrollbar navigation, category counts and common-term search. Navigation guide. The activity chart pairs a dotted canvas with animated successful-call trends and independent error bars, with reduced-motion and pause controls. BeUI now powers the dashboard’s shared buttons, inputs, badges, checkboxes, switches, selects, tabs, tooltips, loaders, theme toggle and animated numbers. Animated Sidebar adds a collapsible icon rail while retaining search and pins. Live Feed uses Animated Badges and an Expandable Action Bar; Overview, Devices and Live Feed offer read-only Pull to Refresh with a keyboard-accessible button. The local BeUI registry retains the 17 collections used by the dashboard and their supporting components; unused component demonstrations have been removed. The fixed Operations Island expands into live activity, router checks and recent tool completions, using existing data without extra probes or configuration changes. Missing and stale observations are explicitly labelled. For frontend development, bun run dev:dashboard connects the UI on port 9191 to the existing dashboard backend on port 9091. See the dashboard design system.

DevFrame developer tools

Run the dashboard backend and the DevTools frontend in two terminals from the repository root:

# Terminal 1 — MCP server and dashboard API
bun run start:dev --dashboard --dashboard-port 9091 --config /path/to/devices.json

# Terminal 2 — dashboard frontend with DevFrame enabled
bun run dev:tools

Open http://127.0.0.1:9191/ and authorize the DevFrame dock with the one-time code printed in the development terminal when prompted. If the port is occupied, run bun run dev:tools --port 9194 and open http://127.0.0.1:9194/ instead. The backend stays on port 9091; start:dev alone does not enable DevFrame.

  • Data Inspector: explore tool schemas, modules, prompts, App View coverage, device requirements, navigation and build diagnostics.
  • Devframe Inspector: enable Settings → Advanced → Show Devframe Inspector, then filter Functions by mikrotik: for read-only MCP inspection queries.
  • A11y Inspector: audit the current dashboard page for accessibility issues.

After changing tool declarations, run bun run gen:schemas to refresh the public inspection data. Run bun run build:ui to populate build-artifact diagnostics. DevFrame is development-only: it is not embedded in production builds, does not load device credentials, and does not expose another router-execution endpoint. See the DevTools guide for search examples and security boundaries.

Access Scope settings can be edited directly in the dashboard: configure risk ceilings, router allow/block lists and tool-name patterns, preview permission decisions without executing tools, then review and apply with a 60-second auto-revert window. The page distinguishes the operator policy, runtime session restrictions and server read-only mode. See Access Scope settings.

The tool catalog

901 tools across 143 modules. Full, always-current reference (parameters + risk per tool) is generated from source: docs/tools-reference.md.

Group Tools Modules
System & Ops 194 system, network tools, investigations, service contracts, round-trip paths, Safe Mode, transactions, rollout, scheduled audits
Security 127 firewall filter, NAT, address-lists, certificates, IP services, hardening, policy-as-code, attack detection
VPN & Tunneling 108 WireGuard, IPsec, PPP, L2TP, PPTP, SSTP, OpenVPN, GRE/IPIP/EoIP/VXLAN
Dynamic Routing 99 router-id, tables, rules, next-hops, filters, BFD, BGP, OSPF, RIP, PIM-SM, IGMP proxy, GMP, RPKI
IPv6 90 addressing, DHCPv6, ND, neighbours, pools, routes, firewall filter/NAT/mangle/raw
Tools 67 ping, traceroute, bandwidth test, sniffer, traffic generator, RoMON, Wake-on-LAN, SMS
Addressing & Routing 62 IP addresses, IP pools, routing, DHCP, DNS
Interfaces 56 interfaces, VLAN, bridge, wireless, PoE
AAA 34 RADIUS, User Manager, 802.1X
QoS 23 queue types, queue trees, simple queues
Switch 18 switch settings, ports, rules, port isolation
Discovery & Meta 11 tool gateway (find/describe/invoke), server pulse, capability probe
Memory 9 persistent knowledge graph

Beyond the catalog

Higher-level workflows built on top of the per-scope tools:

  • Change Plan & Dry-Run — preview commands as a terraform-style plan, apply under Safe Mode, show the exact /export diff, commit only if still reachable.
  • Cross-Device Transactions — coordinate Safe Mode across several routers: the recommended MCP workflow for related VPN, peering, route and ACL changes. Plan → stage → verify → commit with approval. Best-effort, not ACID; partial commits require manual recovery. Connection instructions and cross-device prompts steer the model here before independent writes, not for read-only tasks.
  • Staged Fleet Rollout — apply one change as canary → wave → fleet with a health gate and soak between waves, reverting everything already changed on the first failure.
  • Scheduled Audits — run the auditors on a cron with nobody in the loop and alert only on what changed since the previous run: new, worsened, resolved.
  • Config Narrative — turn a router’s configuration into a plain-language architecture document with a topology diagram, and explain what the difference between two snapshots actually means.
  • Attack Detection — watch the fleet’s logs for brute force, credential spraying and a login that succeeded after failures, correlate them into incidents with evidence, and block the source reversibly when you ask.
  • Config Snapshots — store /export snapshots and time-travel diff any two, or one against the live device.
  • Firewall Audit — find shadowed, broad, missing-default-drop, duplicate and dead rules, risk-scored, with one-click fixes.
  • Security Hardening — per-category audit+remediate pairs; audits read-only, fixes dry-run + snapshot + Safe-Mode first.
  • Policy-as-Code — write your own compliance rules in YAML and lint a config snapshot offline; Markdown/JSON/SARIF, read-only, CI-able.
  • Offline Simulator — trace a hypothetical packet through NAT, routing and firewall against a snapshot; reports UNKNOWN rather than guessing.
  • Traffic Flow — NetFlow/IPFIX collection and continuous top-talker / conversation / application analytics; flow metadata only, no payload.
  • Port-Scan Detection · Packet Capture Studio · Discovery · Config Studio.

Built-in prompts

MCP prompts are one-click guided workflows — authored as Markdown in prompts/, so you can edit or add your own without touching code:

harden-router · diagnose-connectivity · setup-guest-wifi · choose-vpn-solution · setup-wireguard-vpn · setup-ipsec-site-to-site · setup-l2tp-ipsec-roadwarrior · setup-tunnel-between-sites · backup-and-document

See docs/prompts.md.

Browse the live library under Workspace → Prompts in the dashboard, or run Prompt Library in Raycast (also available in the Fleet Menu Bar). Search and filter workflows, fill their required inputs, add your own request and target router, then preview and copy the completed brief into an MCP-connected assistant. Nothing runs on a router while composing. The dashboard links open ChatGPT/Claude without including your request in the URL; paste and send it yourself. Raycast also offers Ask Raycast AI for a Plan when AI access is available: this sends the request to Raycast AI for advice, not MCP tool execution.

Transports

Transport When Run
stdio (default) Claude Desktop, local MCP clients mikrotik-mcp serve
streamable-http Remote / shared, behind a proxy mikrotik-mcp serve --transport streamable-http --mcp-port 8000
sse Legacy HTTP clients mikrotik-mcp serve --transport sse

HTTP transports expose POST /mcp and GET /health with DNS-rebinding protection. See docs/transports.md.

Configuration

Update MCP settings through tools

The MCP Settings module (mcp-settings) manages host-side settings without contacting a router, even when the dashboard is disabled:

Tool Purpose
get_mcp_settings Read editable settings, revision, config path and pending change
get_mcp_settings_schema Discover allowed fields and validation limits
preview_mcp_settings Validate a partial patch and inspect its diff and restart requirements
update_mcp_settings Back up and persist an approved patch to the source JSON, with timed rollback
confirm_mcp_settings Keep the pending tool-created change after readback
rollback_mcp_settings Restore its local backup before confirmation

Editable fields cover MCP tool pagination, App views and capability gating; SSH pooling; dashboard retention/body capture/redaction; Memory enablement; and startup update checks. Partial patches preserve omitted settings. For example, preview {"changes":{"ssh":{"keepAlive":true,"idleTimeout":60000}}}, then apply the same changes with the returned revision and confirm:true only after user approval. Read back and confirm using the new revision and pending_id (the update result’s pendingId, also pending.id in readback).

Writes are unavailable in read-only mode. Devices, credentials, listener addresses, file paths, access ceilings, tool restrictions and probe allowlists remain operator-managed. These tools cannot disable redaction; enabling body capture requires redaction. They return no credential values. Config files and backups are written with owner-only permissions (0600 on POSIX).

Dashboard and tool edits in the same process share one pending transaction; stale revisions and conflicting edits are rejected. Unconfirmed tool updates roll back after 60s by default (configurable from 30–600s) while the process remains alive. Never restart with a pending update: confirm first, then restart separately if the preview requires it. MCP presentation, dashboard recorder and update-check changes need a restart for full activation. Memory enablement is checked on the next operation; SSH settings affect subsequent calls/new connections and new idle timers without forcibly disconnecting existing sessions.

The saved config path is returned by the tools. If the server was started from environment variables alone, use --config on future starts; CLI/env overrides can still take precedence. A configured value is not evidence of a restart or of router connectivity.

Environment and CLI

Settings come from MIKROTIK_* env vars or matching CLI flags (defaults → env → flags):

Variable Flag Default Purpose
MIKROTIK_HOST --host 127.0.0.1 RouterOS host
MIKROTIK_USERNAME --username admin SSH user
MIKROTIK_PASSWORD --password — SSH password (or use a key →)
MIKROTIK_KEY_FILENAME --key-filename — SSH private-key file path
MIKROTIK_KEY_PASSPHRASE --key-passphrase — Passphrase for an encrypted key
MIKROTIK_JUMP_HOST --jump-host — SSH bastion to tunnel through
MIKROTIK_CONFIG_FILE --config — JSON file of named devices
MIKROTIK_DEVICES --devices — Inline JSON of named devices
MIKROTIK_MCP__TRANSPORT --transport stdio stdio / streamable-http / sse
MIKROTIK_SSH__KEEP_ALIVE --ssh-keep-alive true SSH connection pooling
MIKROTIK_DASHBOARD__ENABLED --dashboard false Real-time observability dashboard

Full table (HTTP host, allow-lists, timeouts, dashboard options, MIKROTIK_LOG_LEVEL): docs/configuration.md.

Documentation

Doc
Getting started Install, verify, first run
Configuration Every env var & flag
Device capabilities What a router supports; how tools are gated on it
Alerting Rules that reach out — Slack, Discord, ntfy, webhook, MCP
Multiple devices Manage several routers; per-call targeting
Connecting clients Claude Desktop, stdio, HTTP
Observability Real-time dashboard: live feed + analytics, SQLite
Safe Mode Transactional changes
Cross-Device Transactions Two-phase commit across several routers
Staged Fleet Rollout Canary → wave → fleet with health gates and auto-revert
Change Plan & Dry-Run Preview commands, apply with the exact diff + auto-rollback
Traffic Flow NetFlow/IPFIX collection + top-talker analytics
Attack Detection Live attack incidents from logs; guarded, timed blocking
Firewall Audit Shadowed/broad/dead rules, risk-scored
Security Hardening Per-category audit+remediate, snapshot + Safe-Mode
Scheduled Audits Auditors on a cron, alerting only on run-over-run changes
Policy-as-Code Your own YAML compliance rules, linted offline → SARIF
Config Narrative Config → architecture doc + Mermaid; consequence-level diffs
Offline Simulator Trace a packet through firewall + routing, no device
VPN guide Every tunnel type + how to build it
Prompts The 9 guided workflows
Architecture · Security How it’s built · credentials & risk gating
Tool reference The full generated catalog
Development · Docker Build, test, deploy

Security

Talks to RouterOS over SSH using credentials you supply; nothing is sent anywhere else. Tool values are quoted/escaped to prevent console-command injection. Destructive tools are annotated so clients can require confirmation. Details: docs/security.md. Only point this at devices you’re authorized to manage.

License

MIT. Reuse freely. No warranty.


View this README on GitHub

安装

docker run -d --name mikrotik-mcp --restart unless-stopped \

配置

// claude_desktop_config.json { "mcpServers": { "mikrotik": { "command": "mikrotik-mcp", "env": { "MIKROTIK_HOST": "192.168.88.1", "MIKROTIK_USERNAME": "admin", "MIKROTIK_PASSWORD": "your-password", }, }, }, }