NetBox MCP Server

NetBox MCP 服务

一个模型上下文协议（MCP）服务，可连接 NetBox，并公开网络基础设施数据，供 Claude 和其他兼容 MCP 的大模型使用。

概述

此服务在 NetBox 与兼容 MCP 的大模型（如 Claude）之间搭建桥梁，让你能够：

• 查询和分析网络基础设施数据
• 检查设备配置和连接
• 查看虚拟化集群和虚拟机
• 分析 VLAN、IP 地址分配等
• 生成网络拓扑信息
• 检测集群中的 NVMe 存储

服务提供：

• 工具：用于执行操作的函数

要求

• Python 3.10 或更高版本
• 可通过 API 访问的 NetBox 实例
• 具有读取权限的 NetBox API 令牌
• 用于 HTTP 请求的 httpx 库
• 用于模型上下文协议的 mcp Python SDK

安装

使用 uv（推荐）

# Create a virtual environment
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install required packages
uv add mcp httpx

使用 pip

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install required packages
pip install mcp httpx

用法

直接运行服务

python netbox_server.py --url https://your-netbox-instance.example.com --token your-api-token

你也可以设置环境变量，而不使用命令行参数：

export NETBOX_URL="https://your-netbox-instance.example.com"
export NETBOX_TOKEN="your-api-token"
python netbox_server.py

与 Claude Desktop 集成

若要与 Claude Desktop 集成：

1. 从 https://claude.ai/download 安装 Claude Desktop
2. 打开 Claude 菜单并选择“Settings...”
3. 点击左侧边栏中的“Developer”
4. 点击“Edit Config”
5. 将 NetBox 服务配置添加到 claude_desktop_config.json：

{
  "mcpServers": {
    "netbox": {
      "command": "python",
      "args": [
        "/path/to/netbox_server.py",
        "--url",
        "https://your-netbox-instance.example.com",
        "--token",
        "your-api-token"
      ]
    }
  }
}

6. 保存文件并重启 Claude Desktop

可用功能

工具

服务提供以下工具：

• get_all_clusters - 获取包含关键信息的所有集群列表
• get_cluster_virtual_machines - 获取指定集群中的所有虚拟机
• get_cluster_interfaces - 获取集群中所有虚拟机的全部接口

Claude 查询示例

服务连接到 Claude Desktop 后，你可以提出如下问题：

• “列出 NetBox 实例中的所有集群”
• “列出主集群中的所有虚拟机”

许可证

本项目采用 MIT 许可证授权，详情请参阅 LICENSE 文件。

致谢

• NetBox - 网络基础设施建模
• Model Context Protocol - 为大模型提供上下文的协议
• Claude - Anthropic 的 AI 助手