Nautobot Network Infrastructure

🚀 Nautobot MCP Plugin

This Nautobot plugin integrates the MCP (Model Context Protocol) server with Nautobot, providing AI-ready tools and interfaces for network automation and management.

🚀 Quick Start

The Nautobot MCP allows AI assistants or applications to interact with your network data through a standardized protocol. This plugin runs an MCP server on Nautobot, exposing tools that can be used by AI systems.

For more information, please refer to: https://modelcontextprotocol.io/introduction

💻 Usage Examples

Librechat Connecting to Nautobot MCP

https://github.com/user-attachments/assets/283d68c2-d35f-4506-b909-45c1850e7281

📦 Installation

1. Install the Package

pip install nautobot-mcp

2. Add to INSTALLED_APPS in Nautobot Configuration

# In your nautobot_config.py
PLUGINS = [
    "nautobot_mcp",
    # Other plugins...
]

3. Configuration

Configure through Nautobot's configuration system:

# In your nautobot_config.py
PLUGINS_CONFIG = {
    "nautobot_mcp": {
        "MCP_PORT": 8005,  # MCP server port
        "MCP_HOST": "0.0.0.0",  # Default is 0.0.0.0
        "MCP_CUSTOM_TOOLS_DIR": "/path/to/your/custom/tools",  # Custom tools directory
        "MCP_LOAD_CORE_TOOLS": False,  # Load built-in tools
    },
}

4. Run the Post-Upgrade Command for Nautobot

nautobot-server post_upgrade

🔧 Technical Details

Custom Tools

You can create your own custom tools by defining Python functions in the directory specified by MCP_CUSTOM_TOOLS_DIR.

Example custom tool:

# In /path/to/your/custom/tools/my_tools.py

def some_tool(param1: str, param2: str) -> dict:
    """Some tool description"""
    # Your implementation code
    return {"result": f"Tool result for {param1} and {param2}"}

The MCP server will automatically discover and register all functional tools in the specified directory.

Deployment Options

Method 1: Manual Startup

You can manually start the MCP server:

nautobot-server start_mcp_server

Method 2: Systemd Service (Recommended for Production)

Create a systemd service file at /etc/systemd/system/nautobot-mcp.service:

[Unit]
Description=Nautobot MCP Server
After=network-online.target
Wants=network-online.target

[Service]
User=nautobot
Group=nautobot
WorkingDirectory=/opt/nautobot
ExecStart=/opt/nautobot/venv/bin/nautobot-server start_mcp_server
Restart=on-failure
RestartSec=30
PrivateTmp=true

[Install]
WantedBy=multi-user.target

Then enable and start the service:

sudo systemctl daemon-reload
sudo systemctl enable --now nautobot-mcp.service

View Available Tools

You can view all registered tools in the Nautobot web interface:

https://your_domain/nautobot/

TODO

• Add detailed documentation.
• Implement a complete API interface.
• Support multi-language functionality.
• Add an error handling mechanism.
• Optimize performance.

The entire project is still under development, and various functions will be gradually improved in the future.