🚀 Nautobot MCP插件

此Nautobot插件将MCP（模型上下文协议）服务器与Nautobot集成，为网络自动化和管理提供AI就绪工具和接口，助力用户更高效地进行网络管理与自动化操作。

🚀 快速开始

Nautobot MCP使AI助手或应用程序能够通过标准化协议与您的网络数据交互。该插件在Nautobot上运行一个MCP服务器，暴露可用于AI系统的工具。 更多信息可查看：MCP介绍

💻 使用示例

Librechat连接到Nautobot MCP

可参考此链接示例：Librechat连接示例

📦 安装指南

1. 安装包

pip install nautobot-mcp

2. 添加到Nautobot配置中的INSTALLED_APPS

# 在您的nautobot_config.py中
PLUGINS = [
    "nautobot_mcp",
    # 其他插件...
]

3. 配置

通过Nautobot的配置系统进行设置：

# 在您的nautobot_config.py中
PLUGINS_CONFIG = {
    "nautobot_mcp": {
        "MCP_PORT": 8005,  # MCP服务器端口
        "MCP_HOST": "0.0.0.0",  # 默认是0.0.0.0
        "MCP_CUSTOM_TOOLS_DIR": "/path/to/your/custom/tools",  # 自定义工具目录
        "MCP_LOAD_CORE_TOOLS": False,  # 加载内置工具
    },
}

4. 运行nautobot升级后命令

nautobot-server post_upgrade

🔧 技术细节

自定义工具

您可以通过在MCP_CUSTOM_TOOLS_DIR指定的目录中定义Python函数来创建自己的自定义工具。

示例自定义工具

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

def some_tool(param1: str, param2: str) -> dict:
    """Some tool description"""
    # 您的实现代码
    return {"result": f"Tool result for {param1} and {param2}"}

MCP服务器将自动发现并注册指定目录中的所有函数工具。

部署选项

方法1：手动启动

您可以手动启动MCP服务器：

nautobot-server start_mcp_server

方法2：Systemd服务（生产推荐）

创建一个systemd服务文件，路径为/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

然后启用并启动服务：

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

查看可用工具

您可以在Nautobot web界面中查看所有注册的工具：

https://您的域名/nautobot/

📄 待办事项

• 添加详细的文档说明。
• 实现完整的API接口。
• 支持多语言功能。
• 增加错误处理机制。
• 优化性能表现。

整个项目仍在开发中，后续将逐步完善各项功能。