Unimus MCP Server

<p align="center"> <img src="./assets/unimus-mcp-mascot.png" alt="Unimus MCP Mascot" width="150" /> </p> <h1 align="center">Unimus MCP Server</h1> <p align="center"> <img src="https://img.shields.io/github/v/release/Deployment-Team/unimus-mcp" alt="Latest Release"> <img src="https://img.shields.io/docker/pulls/controlaltautomate/unimus-mcp" alt="Docker Pulls"> <img src="https://img.shields.io/github/license/Deployment-Team/unimus-mcp" alt="License"> <img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="Python Version"> <img src="https://img.shields.io/badge/MCP%20Tools-15-brightgreen" alt="MCP Tools"> </p> <p align="center"> <img src="https://img.shields.io/github/stars/Deployment-Team/unimus-mcp" alt="GitHub Stars"> <img src="https://img.shields.io/github/issues/Deployment-Team/unimus-mcp" alt="GitHub Issues"> <img src="https://img.shields.io/github/last-commit/Deployment-Team/unimus-mcp" alt="Last Commit"> <img src="https://img.shields.io/badge/Unimus%20API-v2-blue" alt="Unimus API"> </p> <p align="center"><em>"Talk" to your network configurations as you would a colleague.</em></p> Meet the Unimus MCP, symbolized by our LEGO parrot. Just as a parrot synthetically mimics human speech, this server allows you to "talk" to your Unimus network using natural language (LLMs). Ask a question about a backup, search for a specific configuration, or request the network topology; our parrot translates it into the correct, safe, read-only API calls. This project is a read-only [Model Context Protocol](https://modelcontextprotocol.io/) server for the Unimus network management platform. It exposes all your network data for conversational AI, making complex queries and analyses easier than ever. ## 📚 Documentation **📖 [Complete Documentation - Visit Our Wiki](../../wiki)** - **[Installation & Setup](../../wiki/Installation)** - Get started quickly - **[Docker Deployment](../../wiki/Docker)** - Container deployment guide - **[API Reference](../../wiki/API-Reference)** - All 15 MCP tools - **[Usage Examples](../../wiki/Examples)** - Example queries and use cases - **[Development & Roadmap](../../wiki/Development)** - Contributing and roadmap ## Quick Start ### Docker (Recommended) 🐳 ```bash docker run -d \ --name unimus-mcp \ -e UNIMUS_URL="https://your-unimus.example.com" \ -e UNIMUS_TOKEN="your-api-token" \ -p 8080:8080 \ controlaltautomate/unimus-mcp:latest ``` ### Python Installation ```bash git clone https://github.com/Deployment-Team/unimus-mcp.git cd unimus-mcp pip install . ``` ## Current Version **Version**: 1.0.0 (Production-Ready Enterprise Network Intelligence) **🎉 FULLY TESTED & VALIDATED**: All 15 MCP tools tested against live Unimus instance **📦 [Download Latest Release](https://github.com/Deployment-Team/unimus-mcp/releases/latest)** ## Key Features - **15 MCP Tools**: Complete device and backup management - **Enhanced Metadata**: 12 comprehensive calculated fields for device analysis - **Flexible Attributes**: Granular control over device data retrieval - **Backup Content Search**: Regex pattern matching in configurations - **Network Topology**: Device relationship analysis and topology mapping - **Change Tracking**: Find devices with recent configuration changes - **Docker Ready**: Enterprise-grade containerization with health checks - **100% Tested**: Validated against live Unimus instances ## Requirements - Python 3.10+ - Unimus 1.7.x or newer (API v.2 support) - Valid Unimus API token with read permissions ## Configuration Set these environment variables: - `UNIMUS_URL`: Full URL to your Unimus instance - `UNIMUS_TOKEN`: API token from Unimus ## Example Usage ```text > Show me all Cisco devices in my network > Get the latest backup for device ID 15 > Search for "interface GigabitEthernet" in device backups > Find devices that had backup changes in the last 24 hours > Compare backup 100 with backup 105 and show differences ``` ## License MIT License - see [LICENSE](LICENSE) for details. ## Support - **Documentation**: [Visit Our Wiki](../../wiki) - **Issues**: [GitHub Issues](https://github.com/Deployment-Team/unimus-mcp/issues) - **Discussions**: [GitHub Discussions](https://github.com/Deployment-Team/unimus-mcp/discussions)