README
🚀 企业级MCP服务器
企业级模型上下文协议(MCP)服务器,具备与ServiceNow集成和健康监控功能,可有效解决企业工作流中的模型上下文管理问题,为企业环境提供稳定、高效的服务。
🚀 快速开始
前提条件
- Python 3.11 及以上版本
- uv 包管理器
安装步骤
- 克隆仓库:
git clone <repository-url>
cd enterprise-mcp
- 使用 uv 安装依赖:
uv sync
- 激活虚拟环境:
source .venv/bin/activate
启动服务器
uv run enterprise-mcp
服务器默认将在 http://localhost:3001 启动。
健康检查端点
GET /health- 基本健康检查GET /health/ready- 就绪探针GET /health/live- 存活探针
✨ 主要特性
- 健康监控:内置健康检查和系统指标监控功能。
- ServiceNow 集成:与 ServiceNow MCP 服务全面集成,适用于企业工作流。
- 生产就绪:专为企业环境设计,具备完善的日志记录和错误处理机制。
- FastAPI 后端:基于 Starlette 和 FastMCP 构建的高性能 REST API。
- 异步支持:支持全异步操作。
- 模块化架构:基于服务的架构,拥有基础服务类。
📦 安装指南
前提条件
- Python 3.11+
- uv 包管理器
安装步骤
- 克隆仓库:
git clone <repository-url>
cd enterprise-mcp
- 使用 uv 安装依赖:
uv sync
- 激活虚拟环境:
source .venv/bin/activate
💻 使用示例
启动服务器
uv run enterprise-mcp
服务器默认将在 http://localhost:3001 启动。
健康检查端点
GET /health- 基本健康检查GET /health/ready- 就绪探针GET /health/live- 存活探针
📚 详细文档
开发相关
搭建开发环境
- 安装开发依赖:
uv sync --extra dev
- 安装预提交钩子:
make dev
运行测试
make test
# 或者
uv run pytest
代码格式化
make format
# 或者
uv run ruff format .
uv run ruff check --fix .
可用的 Make 命令
make help # 显示可用命令
make install # 安装依赖
make install-dev # 安装开发依赖
make test # 运行测试
make test-cov # 运行带覆盖率的测试
make lint # 运行代码检查
make format # 格式化代码
make run # 启动服务器
make run-dev # 在开发模式下启动服务器
make clean # 清理构建产物
make dev # 搭建开发环境
配置相关
服务器使用环境变量进行配置。将 .env.example 复制为 .env 并进行自定义:
cp .env.example .env
可用的设置项:
HOST- 服务器主机(默认:0.0.0.0)PORT- 服务器端口(默认:3001)DEBUG- 调试模式(默认:false)MCP_BASE- MCP 基础 URL(默认:http://localhost:3001)SERVICENOW_INSTANCE- ServiceNow 实例 URLSERVICENOW_USERNAME- ServiceNow 用户名SERVICENOW_PASSWORD- ServiceNow 密码HEALTH_CHECK_INTERVAL- 健康检查间隔(秒,默认:30)
服务相关
健康服务
提供全面的健康监控,包括:
- 系统健康状态
- 正常运行时间信息
- 内存使用统计
- CPU 使用统计
- 平台信息
ServiceNow 服务
与 ServiceNow 实例集成,用于企业工作流管理:
- 获取事件
- 创建事件
- 更新事件
- 获取变更请求
架构相关
src/enterprise_mcp/
├── main.py # 主入口点
├── server/ # 核心服务器实现
│ ├── __init__.py
│ ├── base.py # 基础服务器类
│ └── mcp_server.py # MCP 服务器实现
├── services/ # MCP 服务
│ ├── __init__.py
│ ├── base_service.py # 基础服务类
│ ├── health/ # 健康监控服务
│ │ ├── __init__.py
│ │ ├── service.py
│ │ └── settings.py
│ └── servicenow/ # ServiceNow 集成服务
│ ├── __init__.py
│ ├── service.py
│ └── settings.py
└── settings/ # 配置设置
└── __init__.py
VS Code 集成
项目包含用于 MCP 调试的 VS Code 配置:
.vscode/mcp.json- MCP 服务器配置.vscode/tasks.json- 构建和运行任务.devcontainer/- 开发容器设置
Docker 支持
使用 Docker 构建和运行:
docker build -t enterprise-mcp .
docker run -p 3001:3001 enterprise-mcp
🔧 技术细节
架构设计
采用模块化架构,基于服务的设计理念,拥有基础服务类,便于扩展和维护。核心服务器使用 FastAPI 后端,基于 Starlette 和 FastMCP 构建,具备高性能的 REST API,支持全异步操作。
健康监控
内置健康检查和系统指标监控功能,通过多个健康检查端点(如 /health、/health/ready、/health/live)提供系统的健康状态信息,包括系统健康状态、正常运行时间、内存使用统计、CPU 使用统计和平台信息等。
ServiceNow 集成
与 ServiceNow MCP 服务全面集成,可实现获取事件、创建事件、更新事件和获取变更请求等功能,满足企业工作流管理的需求。
📄 许可证
企业许可证 - 详情请参阅 LICENSE 文件。
Scan to join WeChat group