JinDaGe - netbox-mcp-server MCP Details

article

README

🚀 NetBox MCP 服务器

这是一个简单的只读模型上下文协议服务器，专为 NetBox 打造。借助它，您能直接通过支持 MCP 的大型语言模型（LLM）与 NetBox 数据进行交互，为数据使用带来极大便利。

✨ 主要特性

此服务器提供了一系列实用工具，可帮助您与 NetBox 数据进行交互： | 工具 | 描述 | |------|-------------| | get_objects | 根据类型和过滤器检索 NetBox 核心对象 | | get_object_by_id | 通过 ID 获取特定 NetBox 对象的详细信息 | | get_changelogs | 根据过滤器检索变更日志（审核记录） |

⚠️ 重要提示

当前支持的对象类型是明确定义且有限的，仅限于核心 NetBox 对象，暂时不支持插件对象类型。

🚀 快速开始

📦 安装指南

在 NetBox 中创建一个只读 API 令牌，并确保其具有访问您希望通过 MCP 提供的数据的足够权限。
安装依赖：uv add -r requirements.txt

💻 使用示例

基础用法

验证服务器是否可以运行：

NETBOX_URL=https://netbox.example.com/ NETBOX_TOKEN=<your-api-token> uv run server.py

将 MCP 服务器配置添加到您的 LLM 客户端中。例如，在 Claude Desktop（Mac）上：

{
  "mcpServers": {
        "netbox": {
            "command": "uv",
            "args": [
                "--directory",
                "/path/to/netbox-mcp-server",
                "run",
                "server.py"
            ],
            "env": {
                "NETBOX_URL": "https://netbox.example.com/",
                "NETBOX_TOKEN": "<your-api-token>"
            }
        }
}

⚠️ 重要提示

在 Windows 上，请使用完整的、已转义的路径来指向您的实例，例如 C:\\Users\\myuser\\.local\\bin\\uv 和 C:\\Users\\myuser\\netbox-mcp-server。有关详细故障排除步骤，请参阅 MCP 快速入门。

高级用法

在您的 LLM 客户端中使用这些工具。例如：

> 获取“Equinix DC14”站点的所有设备
...
> 告诉我我的 IPAM 使用情况
...
> 我的网络中有哪些Cisco 设备？
...
> 谁对 NYC 站点进行了更改？
...
> 显示过去一个月核心路由器的所有配置更改

🔧 开发

欢迎贡献！请打开问题或提交 PR。

📄 许可证

该项目在 Apache 2.0 许可证下。

netbox-mcp-server