mikromcp 1.13.2 โ 1.14.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -7
- package/config/routers.example.yaml +1 -0
- package/dist/main.js +3405 -841
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -8,16 +8,16 @@
|
|
|
8
8
|
</picture>
|
|
9
9
|
</p>
|
|
10
10
|
|
|
11
|
-
> **AI-native network automation for MikroTik RouterOS.** MikroMCP exposes RouterOS as a typed, auditable [Model Context Protocol](https://modelcontextprotocol.io) server so Claude, Cursor, Codex, and other MCP clients can inspect, diagnose, and safely operate MikroTik
|
|
11
|
+
> **AI-native network automation for MikroTik RouterOS and SwOS.** MikroMCP exposes RouterOS routers and SwOS switches as a typed, auditable [Model Context Protocol](https://modelcontextprotocol.io) server so Claude, Cursor, Codex, and other MCP clients can inspect, diagnose, and safely operate MikroTik gear in natural language.
|
|
12
12
|
|
|
13
13
|
[](https://github.com/AliKarami/MikroMCP/actions/workflows/ci.yml)
|
|
14
14
|
[](https://github.com/AliKarami/MikroMCP/actions/workflows/release.yml)
|
|
15
|
-
[](package.json)
|
|
16
16
|
[](LICENSE)
|
|
17
17
|
[](package.json)
|
|
18
18
|
[](https://help.mikrotik.com/docs/display/ROS/REST+API)
|
|
19
19
|
[](https://modelcontextprotocol.io)
|
|
20
|
-
[](https://github.com/AliKarami/MikroMCP/wiki/Available-Tools)
|
|
21
21
|
[](https://glama.ai/mcp/servers/AliKarami/MikroMCP)
|
|
22
22
|
|
|
23
23
|
MikroMCP exists because raw router CLI access is the wrong abstraction for AI agents. RouterOS is powerful, but asking an LLM to improvise shell commands against production network gear is risky. MikroMCP gives agents a controlled tool surface: strict schemas, idempotent writes, dry-run previews, per-router circuit breakers, retry policies, RBAC, audit logs, snapshots, and rollback-aware change workflows.
|
|
@@ -46,7 +46,7 @@ That's the whole setup for a single-router stdio deployment. For standalone bina
|
|
|
46
46
|
| ๐ **Network operations** | Interfaces, VLANs, IP addresses, DHCP leases, DNS static records, bridge ports, WiFi clients |
|
|
47
47
|
| ๐ฅ **Firewall and policy** | Filter/NAT rules, mangle rules, address lists, route tables, routing rules |
|
|
48
48
|
| ๐ฐ๏ธ **Routing visibility** | Static routes, routing tables, BGP peers, OSPF neighbors |
|
|
49
|
-
| ๐ **SwOS switches** | *Experimental.* MikroTik SwOS and SwOS Lite switches (`deviceType: "swos"`) over the reverse-engineered `.b` HTTP API: port links, PoE, SFP diagnostics,
|
|
49
|
+
| ๐ **SwOS switches** | *Experimental.* MikroTik SwOS and SwOS Lite switches (`deviceType: "swos"`) over the reverse-engineered `.b` HTTP API: port links, PoE, SFP diagnostics, guarded whole-blob writes with a firmware-compatibility check, the whole switch config as one YAML document (export, dry-run, apply), backups and firmware upgrades |
|
|
50
50
|
| ๐ **Secure access** | HTTP bearer auth, bcrypt token hashes, RBAC, router/tool restrictions, confirmation tokens |
|
|
51
51
|
| ๐งช **Diagnostics** | Router-originated `ping`, `traceroute`, `torch`, log filtering, guarded SSH command execution |
|
|
52
52
|
| ๐ก๏ธ **Change safety** | Dry-run, idempotent writes, snapshots, write journal, `plan_changes`, `apply_plan`, `rollback_change` |
|
|
@@ -54,7 +54,7 @@ That's the whole setup for a single-router stdio deployment. For standalone bina
|
|
|
54
54
|
| ๐ค **AI-agent fit** | Human-readable responses plus structured JSON content for reasoning, chaining, and automation; server advertises an `instructions` string on MCP initialize so clients self-configure; optional [`routerId` resolved via `MIKROMCP_DEFAULT_ROUTER`](https://github.com/AliKarami/MikroMCP/wiki/Configuration) for single-router setups; [usage skill](docs/wiki/Using-the-Skill.md) for safe, guided tool use in Claude Code |
|
|
55
55
|
| ๐งฉ **MCP compatibility** | stdio for desktop clients, Streamable HTTP and legacy SSE for remote or service-style clients |
|
|
56
56
|
|
|
57
|
-
**
|
|
57
|
+
**132 typed tools** in total โ browse the full catalog with parameters, defaults, and copy-paste example prompts in **[Available Tools](https://github.com/AliKarami/MikroMCP/wiki/Available-Tools)**.
|
|
58
58
|
|
|
59
59
|
---
|
|
60
60
|
|
|
@@ -140,7 +140,7 @@ AI assistants can use MikroMCP to:
|
|
|
140
140
|
|
|
141
141
|
### What is MikroMCP?
|
|
142
142
|
|
|
143
|
-
MikroMCP is an open-source [Model Context Protocol](https://modelcontextprotocol.io) (MCP) server that exposes MikroTik RouterOS as
|
|
143
|
+
MikroMCP is an open-source [Model Context Protocol](https://modelcontextprotocol.io) (MCP) server that exposes MikroTik RouterOS as 132 typed, auditable tools โ letting AI assistants inspect, diagnose, and safely operate routers in natural language instead of improvising CLI commands.
|
|
144
144
|
|
|
145
145
|
### MikroMCP vs RouterOS API
|
|
146
146
|
|
|
@@ -189,7 +189,7 @@ The README stays intentionally short. Everything below is documented in depth in
|
|
|
189
189
|
| [Connecting to Claude Desktop](https://github.com/AliKarami/MikroMCP/wiki/Connecting-to-Claude-Desktop) | Register MikroMCP in Claude Desktop |
|
|
190
190
|
| [Connecting to AI Assistants](https://github.com/AliKarami/MikroMCP/wiki/Connecting-to-AI-Assistants) | Claude Code, Cursor, Codex, HTTP/Docker/systemd |
|
|
191
191
|
| [Using the Skill](docs/wiki/Using-the-Skill.md) | Install the MikroMCP usage skill so your assistant drives the tools safely |
|
|
192
|
-
| [Available Tools](https://github.com/AliKarami/MikroMCP/wiki/Available-Tools) | All
|
|
192
|
+
| [Available Tools](https://github.com/AliKarami/MikroMCP/wiki/Available-Tools) | All 132 tools โ parameters and example prompts |
|
|
193
193
|
| [Architecture](https://github.com/AliKarami/MikroMCP/wiki/Architecture) | System layers, request pipeline, auth model |
|
|
194
194
|
| [Error Handling](https://github.com/AliKarami/MikroMCP/wiki/Error-Handling) | Error categories, retry engine, circuit breaker |
|
|
195
195
|
| [Security](https://github.com/AliKarami/MikroMCP/wiki/Security) | Threat model, hardening checklist, vulnerability reporting |
|
|
@@ -221,6 +221,7 @@ Please open an issue before large changes so maintainers can align on scope.
|
|
|
221
221
|
### Acknowledgements
|
|
222
222
|
|
|
223
223
|
- [@f0086](https://github.com/f0086) โ SwOS / SwOS Lite switch support (v1.9.0), which took MikroMCP beyond RouterOS for the first time.
|
|
224
|
+
- [@karamble](https://github.com/karamble) โ full SwOS support (v1.14.0): the full-SwOS dialect, whole-switch config apply, backups, firmware upgrades, password changes and switch-bound secrets.
|
|
224
225
|
|
|
225
226
|
---
|
|
226
227
|
|
|
@@ -44,6 +44,7 @@
|
|
|
44
44
|
# source: "env"
|
|
45
45
|
# envPrefix: "SWITCH_CORE01" # -> SWITCH_CORE01_USER, SWITCH_CORE01_PASS
|
|
46
46
|
# tags: ["access", "layer2"]
|
|
47
|
+
# secrets: [SNMP_COMMUNITY] # the MIKROMCP_SECRET_<NAME> names a switch config may reference; none without this list
|
|
47
48
|
|
|
48
49
|
routers:
|
|
49
50
|
core-01:
|