Netbox MCP Rw

🚀 NetBox MCP 讀寫服務器

這是首個具備完整讀寫功能的 NetBox 模型上下文協議（MCP）服務器。與現有的只讀 NetBox MCP 實現不同，該服務器提供全面的 CRUD（創建、讀取、更新、刪除）操作，讓你不僅可以查詢 NetBox 數據，還能通過支持 MCP 的大語言模型（LLMs）直接修改數據。

🚀 快速開始

本服務器是首個支持對 NetBox 進行讀寫操作的 MCP 服務器，能提供全面的 CRUD 操作，支持批量處理，覆蓋所有主要的 NetBox 模型，並且具備生產就緒的特性。

✨ 主要特性

特殊之處

• 首個支持讀寫的 NetBox MCP：唯一允許對 NetBox 進行讀寫操作的 MCP 服務器。
• 完整的 CRUD 操作：可創建、讀取、更新和刪除任何 NetBox 對象類型。
• 批量操作：能高效地一次性處理多個對象。
• 全面覆蓋：支持所有主要的 NetBox 模型（如 DCIM、IPAM、Circuits、Virtualization 等）。
• 生產就緒：具備完善的錯誤處理、驗證和安全實踐。

讀取操作

• 列出並過濾任何 NetBox 對象類型。
• 獲取特定對象的詳細信息。
• 訪問更改歷史和審計記錄。
• 具備高級過濾和搜索功能。

寫入操作

• 創建新的設備、IP 地址、站點、機架等。
• 更新現有對象的屬性。
• 刪除對象（具備適當的保護措施）。
• 支持批量創建、更新和刪除操作。

支持的對象類型

• DCIM（設備和基礎設施）：設備、設備類型、設備角色、製造商、站點、位置、機架、機架角色、電纜、接口、電源端口、控制檯端口、平臺、區域、虛擬機箱。
• IPAM（IP 地址管理）：IP 地址、前綴、VLAN、VRF、自治系統編號（ASNs）、聚合、服務、角色、區域互聯網註冊機構（RIRs）、路由目標。
• Circuits：電路、電路類型、提供商、電路終端、提供商網絡。
• Virtualization：虛擬機、集群、集群組、集群類型、虛擬機接口等。

📦 安裝指南

1. 克隆此倉庫：

git clone https://github.com/alexkiwi1/netbox-mcp-rw.git
cd netbox-mcp-rw

2. 安裝依賴項：

# 使用 UV（推薦）
uv sync

# 或者使用 pip
pip install -e .

3. 設置環境變量：

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

4. 測試服務器：

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

📚 詳細文檔

MCP 客戶端配置

Claude 桌面版（Mac/Windows）

在你的 Claude 桌面版配置中添加以下內容：

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

其他 MCP 客戶端

此服務器可與任何兼容 MCP 的客戶端配合使用。根據客戶端的要求調整命令和參數。

可用工具

設備管理

• netbox_get_objects - 列出/過濾任何對象類型。
• netbox_get_object_by_id - 獲取特定對象的詳細信息。
• netbox_create_object - 創建新對象。
• netbox_update_object - 更新現有對象。
• netbox_delete_object - 刪除對象。
• netbox_bulk_create_objects - 批量創建操作。
• netbox_bulk_update_objects - 批量更新操作。
• netbox_bulk_delete_objects - 批量刪除操作。

審計與歷史

• netbox_get_changelogs - 訪問更改歷史和審計記錄。

安全特性

• API 令牌存儲在環境變量中（絕不硬編碼）。
• 默認啟用 SSL/TLS 驗證。
• 具備完善的錯誤處理和驗證。
• 通過 NetBox 內置的更改日誌保留審計記錄。

要求

• Python 3.13 及以上版本。
• 具備 API 訪問權限的 NetBox 實例。
• 具有適當權限的有效 NetBox API 令牌。

貢獻

這是首個支持讀寫的 NetBox MCP 服務器，歡迎幫助我們改進它：

1. 分叉倉庫。
2. 創建功能分支。
3. 進行更改。
4. 添加測試。
5. 提交拉取請求。

路線圖

• [ ] 使用 Pydantic 模型添加輸入驗證。
• [ ] 實現緩存以提高性能。
• [ ] 添加異步支持。
• [ ] 創建全面的測試套件。
• [ ] 增加對自定義字段和插件的支持。

💻 使用示例

讀取數據

"顯示紐約數據中心的所有活動設備"
"列出 10.0.1.0/24 子網中的可用 IP 地址"
"上週對設備做了哪些更改？"

寫入數據

"在紐約數據中心 1 號站點的 R42 機架中創建一臺名為 'web-01' 的新服務器"
"將 IP 地址 192.168.1.100/24 添加到設備 'firewall-01'"
"將設備 'switch-01' 的狀態更新為維護模式"
"在總部站點創建一個名為 'DMZ' 的新 VLAN 100"

批量操作

"創建 10 臺新服務器，名稱從 web-01 到 web-10"
"將所有思科設備的平臺更新為 'ios'"
"刪除已停用子網中的所有 IP 地址"

📄 許可證

本項目採用 Apache 2.0 許可證 - 詳情請參閱 LICENSE 文件。

致謝

本項目基於優秀的 FastMCP 框架和 NetBox 全面的 REST API 構建。

⚠️ 重要提示

此服務器具備寫入功能。請先在開發環境中進行測試，並確保你的 API 令牌具有適當的權限。謹慎使用批量操作，因為它們可能會同時修改多個對象。