article
README
🚀 NetBox MCP 服务器
NetBox MCP 服务器是一个基于 Model Context Protocol (MCP) 的服务器,它能够连接到 NetBox,为 Claude 等与 MCP 兼容的大语言模型(LLM)提供网络基础设施数据。借助该服务器,用户可便捷地查询、分析网络基础架构数据,查看设备配置与连接情况等。
🚀 快速开始
此服务器作为 NetBox 和 MCP 兼容的 LLM(如 Claude)之间的桥梁,为您提供了强大的网络基础设施数据查询和分析能力。您可以使用它来执行以下操作:
- 查询和分析您的网络基础架构数据
- 检查设备配置和连接
- 查看虚拟化集群和虚拟机
- 分析 VLAN、IP 地址分配等
- 生成网络拓扑信息
- 检测集群中的 NVMe 存储
服务器还提供了执行操作的工具功能。
✨ 主要特性
- 充当 NetBox 和 MCP 兼容的 LLM 之间的桥梁,实现数据交互。
- 提供多种网络基础设施数据的查询和分析功能。
- 支持与 Claude Desktop 集成,方便使用。
📦 安装指南
使用 uv(推荐)
# 创建虚拟环境
uv venv
source .venv/bin/activate # 在 Windows 上:.venv\Scripts\activate
# 安装所需包
uv add mcp httpx
使用 pip
# 创建虚拟环境
python -m venv venv
source venv/bin/activate # 在 Windows 上:venv\Scripts\activate
# 安装所需包
pip install mcp httpx
安装要求
- Python 3.10 或更高版本
- 带有 API 访问权限的 NetBox 实例
- 具有读取权限的 NetBox API 令牌
httpx库用于 HTTP 请求mcpPython SDK 用于 Model Context Protocol
💻 使用示例
直接运行服务器
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 集成,请按照以下步骤操作:
- 从 https://claude.ai/download 安装 Claude Desktop。
- 打开 Claude 菜单,选择 "设置..."。
- 点击左侧边栏中的 "开发者"。
- 点击 "编辑配置"。
- 将 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"
]
}
}
}
- 保存文件并重新启动 Claude Desktop。
可用工具
该服务器提供以下工具:
get_all_clusters- 获取所有集群的列表及关键信息get_cluster_virtual_machines- 获取特定集群中的所有虚拟机get_cluster_interfaces- 获取集群中所有虚拟机的所有接口
扫码联系在线客服