MCP Dc

GitHub Codespaces配置的NetBox MCP服务器开发环境，包含完整的开发工具链和模拟服务

开发者工具网络自动化 #开发环境 #MCP服务 #NetBox集成 #状态管理 .Python

评分 : 2分

下载量 : 3.9K

更新时间 : 2025-11-12

打开站点

什么是NetBox MCP Server?

NetBox MCP Server是一个基于Model Context Protocol (MCP)标准的服务器，专门用于与NetBox网络基础设施管理平台集成。它允许AI助手和应用程序通过标准化的MCP协议访问和管理网络设备、IP地址、虚拟电路等网络资源。

如何使用NetBox MCP Server?

通过GitHub Codespaces可以快速启动完整的开发环境，系统会自动配置所有必要的服务，包括模拟的NetBox API服务器、Vault密钥管理器和PostgreSQL数据库。用户可以直接开始开发或测试MCP工具功能。

适用场景

适用于网络自动化、基础设施管理、DevOps工作流、AI助手集成等场景。特别适合需要实时访问网络配置数据和设备信息的应用程序开发。

主要功能

NetBox深度集成

完全集成NetBox API，支持设备管理、IP地址管理、虚拟电路等核心功能

状态可信度管理

通过PostgreSQL数据库维护操作状态的可信度，确保数据一致性

Vault密钥管理

集成HashiCorp Vault进行安全的密钥和凭证管理

Codespaces就绪

预配置的GitHub Codespaces开发环境，一键启动完整开发栈

MCP标准兼容

完全符合Model Context Protocol标准，可与任何MCP客户端集成

优势

开箱即用的开发环境，无需复杂配置

完整的模拟服务栈，支持离线开发

标准化的MCP协议，易于与其他工具集成

强大的网络基础设施管理能力

安全的密钥管理和状态跟踪

局限性

需要基本的网络管理知识背景

依赖NetBox API的特定版本

生产环境需要额外的安全配置

部分高级功能需要NetBox企业版许可

如何使用

启动Codespaces环境

在GitHub仓库页面点击'Code'按钮，选择'Codespaces' → 'Create codespace on main'

等待环境初始化

系统会自动设置Python环境、Docker服务和其他依赖组件，大约需要2-3分钟

验证服务状态

检查所有开发服务是否正常运行，包括NetBox Mock、Vault Mock和数据库

开始开发或测试

使用提供的测试脚本验证功能，或开始开发新的MCP工具

使用案例

网络设备清单查询

查询当前网络中的所有设备及其状态信息

IP地址管理

查找可用的IP地址或检查特定IP的分配状态

虚拟电路配置

创建或查询站点之间的虚拟电路连接

常见问题

Codespaces环境启动后服务无法访问怎么办？

数据库连接失败如何解决？

测试运行失败如何调试？

如何添加新的MCP工具？

生产环境部署需要注意什么？

🚀 NetBox MCP Server v1.0

NetBox MCP Server v1.0 是一个精心设计的 Python MCP（模型上下文协议）服务器，用于访问 NetBox 基础设施。它既适合用于教导新手程序员，也可用于生产环境。

🚀 快速开始

前提条件

Python 3.12 及以上版本
NetBox 实例
HashiCorp Vault
PostgreSQL 数据库

安装

# 克隆仓库
git clone https://github.com/fringemonkey/mcp-dc.git
cd mcp-dc

# 安装依赖
pip install -r requirements.txt
pip install -r requirements-dev.txt

# 运行测试
python -m pytest tests/ -v

配置

设置环境变量：

export NETBOX_URL="http://your-netbox-instance"
export VAULT_ADDR="http://your-vault-instance"
export VAULT_TOKEN="your-vault-token"
export POSTGRES_HOST="localhost"
export POSTGRES_DB="mcp_state"
export POSTGRES_USER="mcp_user"
export POSTGRES_PASSWORD="mcp_password"

✨ 主要特性

核心功能

NetBox API 集成：可全面访问设备、虚拟机、IP 地址和 VLAN。
HashiCorp Vault 集成：通过 AppRole 认证实现即时（JIT）令牌生成。
PostgreSQL 状态可信度：查询模块引用 muse 确定性模式。
MCP 工具：提供全面的基础设施管理工具集。

高级功能

结构化 JSON 协议：实现组件间的清晰通信。
性能优化：采用连接池、缓存和重试策略。
大语言模型（LLM）优化：进行令牌估计、响应格式化和流式传输。

🧪 测试套件

测试成功率达 100%：使用精简的测试套件，所有测试均通过。

测试覆盖范围

✅ 核心 MCP 服务器功能
✅ 结构化 JSON 协议
✅ 端到端工作流
✅ 性能优化
✅ 工具功能（主机、虚拟机、IP 地址、VLAN）
✅ 错误处理和边界情况

🛠️ 开发

运行测试

# 运行所有测试
python -m pytest tests/ -v

# 运行特定测试类别
python -m pytest tests/ -m unit
python -m pytest tests/ -m integration
python -m pytest tests/ -m performance

# 运行测试并生成覆盖率报告
python -m pytest tests/ --cov=src --cov-report=html

代码质量

# 格式化代码
black src/ tests/
isort src/ tests/

# 代码检查
flake8 src/ tests/
mypy src/

# 安全检查
bandit -r src/
safety check

📁 项目结构

mcp-dc/
├── src/                          # 源代码
│   ├── server.py                 # 主 MCP 服务器
│   ├── netbox_client.py          # NetBox API 客户端
│   ├── vault_client.py           # Vault 认证
│   ├── state_confidence.py       # PostgreSQL 客户端
│   ├── structured_protocol.py    # JSON 协议
│   ├── llm_optimizer.py         # LLM 优化
│   ├── llm_mcp_server.py        # LLM MCP 服务器
│   ├── structured_mcp_server.py # 结构化 MCP 服务器
│   └── tools/                    # MCP 工具
│       ├── hosts.py
│       ├── virtual_machines.py
│       ├── ip_addresses.py
│       └── vlans.py
├── tests/                        # 测试套件
│   ├── test_server.py
│   ├── test_llm_optimization.py
│   ├── test_simple_performance.py
│   └── test_structured_protocol.py
├── examples/                     # 示例脚本
├── scripts/                      # 实用脚本
├── docs/                         # 文档
└── .devcontainer/               # 开发容器