Bishop MCP (主控程序)

一个先进的企业级主控程序，用于在 Cursor IDE 中高效地构建、部署和管理应用程序。该系统提供了一套全面的工具，用于管理您的开发工作流程，从构建自动化到部署编排。

🌟 功能特性

核心功能

• 高级构建系统

  • 并发构建管理
  • 构建产物缓存
  • 版本控制集成
  • 构建日志和指标
  • 产物保留策略

• 部署编排

  • 多环境支持 (开发/测试/生产)
  • 零停机部署
  • 自动回滚功能
  • 健康检查监控
  • 部署配置管理

• 用户管理

  • 基于角色的访问控制 (RBAC)
  • JWT 身份验证
  • 会话管理
  • 用户活动跟踪

高级功能

实时监控

• 基于 WebSocket 的实时更新
• 构建和部署进度跟踪
• 系统指标可视化
• 资源使用监控
• 自定义警报配置

安全性

• 速率限制保护
• HTTPS 支持
• CORS 配置
• 基于 JWT 的身份验证
• 基于角色的访问控制
• 使用 Helmet 的安全标头

日志和分析

• 结构化 JSON 日志记录
• 日志轮换
• 审计跟踪
• 性能指标
• 错误跟踪和报告

集成能力

• Docker 容器支持
• Git 仓库集成
• CI/CD 管道钩子
• Webhook 支持
• 电子邮件通知
• Redis 缓存

监控和指标

• Prometheus 集成
• Grafana 仪表板
• 健康检查端点
• 性能监控
• 资源使用跟踪

🚀 快速开始

前提条件

• Node.js (v18 或更高版本)
• PostgreSQL (v13 或更高版本)
• Redis (v6 或更高版本)
• Docker (可选)

安装

1. 克隆仓库:

git clone https://github.com/your-username/bishop-mcp.git
cd bishop-mcp

2. 安装依赖:

npm install

3. 设置环境变量:

cp .env.example .env
# 编辑 .env 文件进行配置

4. 设置数据库:

# 启动 PostgreSQL
npm run migrate:up
npm run seed

5. 启动服务器:

# 开发环境
npm run dev

# 生产环境
npm run build
npm start

Docker 部署

1. 构建 Docker 镜像:

npm run docker:build

2. 运行容器:

npm run docker:run

📚 API 文档

身份验证

• POST /api/auth/login
• POST /api/auth/register
• POST /api/auth/refresh-token
• POST /api/auth/logout

应用

• GET /api/apps
• GET /api/apps/:id
• POST /api/apps
• PUT /api/apps/:id
• DELETE /api/apps/:id

构建

• POST /api/apps/:id/build
• GET /api/apps/:id/builds
• GET /api/apps/:id/builds/:buildId
• DELETE /api/apps/:id/builds/:buildId
• GET /api/apps/:id/builds/:buildId/status
• GET /api/apps/:id/builds/:buildId/logs
• GET /api/apps/:id/builds/:buildId/artifacts

部署

• POST /api/apps/:id/deploy
• GET /api/apps/:id/deployments
• GET /api/apps/:id/deployments/:deploymentId
• POST /api/apps/:id/deployments/:deploymentId/rollback
• DELETE /api/apps/:id/deployments/:deploymentId
• GET /api/apps/:id/deployments/:deploymentId/status
• GET /api/apps/:id/deployments/:deploymentId/logs

环境

• GET /api/environments
• POST /api/environments
• PUT /api/environments/:id
• DELETE /api/environments/:id

🔧 配置

环境变量

• 服务器配置

  • PORT: 服务器端口 (默认: 3000)
  • NODE_ENV: 环境模式
  • DATABASE_URL: PostgreSQL 连接字符串

• 安全性

  • JWT_SECRET: JWT 签名密钥
  • JWT_EXPIRES_IN: Token 过期时间
  • RATE_LIMIT_WINDOW: 速率限制窗口
  • RATE_LIMIT_MAX_REQUESTS: 每个窗口的最大请求数

• 构建系统

  • BUILD_TIMEOUT: 最大构建持续时间
  • MAX_CONCURRENT_BUILDS: 并发构建限制
  • BUILD_CACHE_TTL: 缓存保留期
  • BUILD_ARTIFACT_RETENTION_DAYS: 产物保留天数

• 部署

  • DEPLOYMENT_TIMEOUT: 最大部署持续时间
  • MAX_CONCURRENT_DEPLOYMENTS: 并发部署限制
  • DEPLOYMENT_ROLLBACK_ENABLED: 启用自动回滚
  • DEPLOYMENT_HEALTH_CHECK_TIMEOUT: 健康检查超时

📊 监控

指标

访问指标仪表板:

http://localhost:9090/metrics

Grafana 集成

1. 使用 Prometheus 配置 Grafana 数据源
2. 从 /grafana/dashboards 导入提供的仪表板

🔒 安全性

身份验证

• 基于 JWT 的身份验证
• 基于角色的访问控制
• 速率限制保护
• CORS 配置

SSL/TLS

在生产环境中启用 HTTPS:

1. 在 .env 文件中设置 ENABLE_HTTPS=true
2. 提供 SSL 证书路径:
   • SSL_CERT_PATH
   • SSL_KEY_PATH

🤝 贡献

1. Fork 仓库
2. 创建您的特性分支
3. 提交您的更改
4. 推送到分支
5. 创建 Pull Request

📝 许可证

该项目基于 MIT 许可证 - 详情请查看 LICENSE 文件。

🙏 鸣谢

• 使用 TypeScript 和 Node.js 构建
• 由 Express.js 驱动
• 数据库使用 PostgreSQL
• 缓存使用 Redis
• 容器化使用 Docker
• 监控使用 Prometheus & Grafana