Netbox MCP Server

🚀 NetBox MCP 服務器

這是一個簡單的只讀 模型上下文協議 服務器，專為 NetBox 打造。它能讓您藉助支持 MCP 的大型語言模型（LLM），直接與 NetBox 數據進行交互，為數據訪問提供了便捷途徑。

✨ 主要特性

工具列表

⚠️ 重要提示

當前支持的對象類型是明確定義且有限的，僅限於核心 NetBox 對象，暫時不支持插件對象類型。

📦 安裝指南

1. 在 NetBox 中創建一個只讀 API 令牌，並確保其具有訪問您希望通過 MCP 提供的數據的足夠權限。
2. 安裝依賴：uv add -r requirements.txt

💻 使用示例

基礎用法

啟動服務器

驗證服務器是否可以運行：

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

配置 LLM 客戶端

將 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 客戶端中使用工具

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

> 獲取“Equinix DC14”站點的所有設備
...
> 告訴我我的 IPAM 使用情況
...
> 我的網絡中有哪些Cisco 設備？
...
> 誰對 NYC 站點進行了更改？
...
> 顯示過去一個月核心路由器的所有配置更改

🚀 快速開始

按照上述安裝和使用示例的步驟，您可以快速啟動 NetBox MCP 服務器，並通過 LLM 客戶端與 NetBox 數據進行交互。

🤝 開發貢獻

歡迎貢獻！請打開問題或提交 PR。

📄 許可證

該項目在 Apache 2.0 許可證下。