NetBox MCP Server

NetBox MCP Server

site icon
2025.04.03 26
Python数据查询变更跟踪网络设备管理开发效率数据库
NetBox MCP Server 是一个基于 Model Context Protocol (MCP) 的只读服务器,用于与 NetBox 数据进行交互。它允许支持 MCP 的 LLM 直接访问和查询 NetBox 中的数据。该服务器提供了多种工具来检索 NetBox 核心对象、详细信息和变更历史记录。
View on GitHub

Overview

基本能力

产品定位

NetBox MCP Server 是一个用于与 NetBox 数据进行交互的只读服务器,通过 MCP 协议支持 LLM 直接访问和查询数据。

核心功能

  • get_objects: 根据类型和过滤器检索 NetBox 核心对象。
  • get_object_by_id: 通过 ID 获取特定 NetBox 对象的详细信息。
  • get_changelogs: 根据过滤器检索变更历史记录(审计跟踪)。

适用场景

  • 通过 LLM 查询 NetBox 中的设备、IPAM 利用率等信息。
  • 跟踪特定站点或设备的变更历史。
  • 获取网络设备的详细信息和配置变更。

工具列表

  • get_objects: 检索 NetBox 核心对象。
  • get_object_by_id: 获取特定对象的详细信息。
  • get_changelogs: 检索变更历史记录。

常见问题解答

  • 目前仅支持 NetBox 核心对象,不支持插件中的对象类型。
  • 需要创建具有足够权限的只读 API 令牌。

使用教程

使用依赖

  1. 安装依赖:uv add -r requirements.txt

安装教程

  1. 创建 NetBox 的只读 API 令牌。
  2. 运行服务器:NETBOX_URL=https://netbox.example.com/ NETBOX_TOKEN=<your-api-token> uv run server.py
  3. 在 LLM 客户端中添加 MCP 服务器配置。

调试方式

  • 确保环境变量 NETBOX_URLNETBOX_TOKEN 正确设置。
  • 参考 MCP quickstart 进行详细故障排除。

许可证

该项目遵循 Apache-2.0 开源许可条款,请参阅 Apache-2.0 了解完整条款。