🚀 主教 MCP(主控制程序)
主教 MCP 是一款高级的企业级主控制程序,专注于在 Cursor IDE 中高效构建、部署和管理应用。它提供了一套全面的工具,可有效管理开发工作流,涵盖从构建自动化到部署编排的各个环节。
🚀 快速开始
先决条件
- Node.js (v18 或更高)
- PostgreSQL 数据库
- Redis 服务
- Docker 和 Docker Compose
安装步骤
- 克隆项目仓库:
git clone https://github.com/your-repository.git
cd bishop-mcp
- 安装依赖项:
npm install
- 配置环境变量,复制并修改
.env.example 文件:
cp .env.example .env
vim .env
- 启动项目:
npm run dev
✨ 主要特性
核心功能
-
高级构建系统
- 并行构建管理
- 构建 artifact 缓存
- 版本控制集成
- 构建日志和指标
- Artifact 保留策略
-
部署编排
- 多环境支持(开发/测试/生产)
- 零停机部署
- 自动回滚功能
- 健康检查监控
- 部署配置管理
-
用户管理
- 基于角色的访问控制 (RBAC)
- JWT 认证
- 会话管理
- 用户活动跟踪
高级功能
实时监控
- WebSocket 基础实时更新
- 构建和部署进度跟踪
- 系统指标可视化
- 资源使用情况监控
- 自定义警报配置
安全性
- 速率限制保护
- HTTPS 支持
- CORS 配置
- JWT 基于认证
- 角色基于访问控制
- 安全头与 Helmet
日志和分析
- 结构化 JSON 日志
- 日志轮转
- 审计追踪
- 性能指标
- 错误跟踪和报告
集成能力
- Docker 容器支持
- Git 仓库集成
- CI/CD 管道钩子
- Webhook 支持
- Email 通知
- Redis 缓存
监控和度量
- Prometheus 集成
- Grafana 仪表盘
- 健康检查端点
- 性能监控
- 资源使用情况跟踪
📚 详细文档
配置
环境变量
| 属性 |
详情 |
PORT |
应用程序运行的端口(默认:3000) |
DB_URL |
PostgreSQL 数据库连接 URL |
REDIS_URL |
Redis 服务连接 URL |
JWT_SECRET |
JWT 加密密钥 |
ENABLE_HTTPS |
是否启用 HTTPS(true/false) |
API 文档
完整的 API 文档可以在 api-docs 目录中找到,包括所有端点的详细信息。
监控
度量指标
访问度量仪表盘:
http://localhost:9090/metrics
Grafana 集成
- 在 Grafana 中配置 Prometheus 数据源
- 从
/grafana/dashboards 导入提供的仪表盘
安全
认证
- JWT 基于认证
- 角色基于访问控制
- 速率限制保护
- CORS 配置
SSL/TLS
生产环境中启用 HTTPS:
- 将
ENABLE_HTTPS 设置为 true 在 .env
- 提供 SSL 证书路径:
SSL_CERT_PATH
SSL_KEY_PATH
贡献指南
- 叉仓库
- 创建功能分支
- 提交您的更改
- 推送到分支
- 创建 Pull Request
📄 许可证
该项目在 MIT 许可证下发布 - 有关详细信息,请参阅 LICENSE 文件。
🙏 致谢
- 使用 TypeScript 和 Node.js 构建
- 由 Express.js 提供支持
- 数据库由 PostgreSQL 提供
- 缓存由 Redis 提供
- 容器化由 Docker 提供
- 监控由 Prometheus & Grafana 实现