CodeIntel MCP 服务器

使用说明

• 项目简介
  • CodeIntel MCP 服务器是一个实际可运行的后端服务，实现了 MCP 协议的核心能力：托管资源与数据访问、注册和执行工具、以及渲染与提供提示/模板以帮助 LLM 客户端获取上下文信息。服务器通过 JSON-RPC 风格的调用与客户端通信，并提供健康检查、鉴权、以及多传输模式的支持。
• 主要功能点
  • 通过 MCP 接口向 LLM 客户端暴露工具清单并处理工具调用，支持通过工具定义的输入模式与 JSON-Schema 进行输入校验。
  • 注册并调度“Tools”来执行外部功能（如代码搜索、依赖分析、代码风格分析、代码洞察等）。
  • 提供健康检查、身份认证和权限控制，支持多种传输协议（stdio 与 streamable-http）。
  • 提供后端路由和 WebSocket/HTTP 集成，确保长时任务的实时进度反馈能力（例如异步索引、部署中的任务状态等）。
  • 具备日志、错误处理、以及对外部后端服务的代理调用（通过统一的后端 API 客户端实现）。
• 安装步骤（快速上手）
  • 获取源码：将仓库克隆到本地。
  • 安装依赖：基于 Python 的后端组件通常使用 pip 安装依赖（请在实际环境中执行项目自带的依赖安装命令，例如 pip install -r requirements.txt）。
  • 启动方式（两种传输模式可选）：
    • 纯本地/stdio 模式（默认）：
      • 直接执行服务入口脚本，服务通过 stdin/stdout 与 MCP 客户端通讯。
    • HTTP 流式模式（远程部署）：
      • 以 streamable-http 模式启动，监听指定端口，通过 HTTP 代理与客户端通信。
  • 服务器配置（运行前须知）
    • 服务器名称与版本在配置中固定，后端需要配置后端 API 地址、访问密钥等信息。
• 服务器配置（给 MCP 客户端的 JSON 配置示例） 说明：以下配置用于 Claude Desktop 等 MCP 客户端在启动时连接到该 MCP 服务器。客户端需要的仅是“server”名称、启动命令及参数信息，实际参数请按所属平台/客户端的要求设置；配置示例仅作参考注释用途。
  • server: codeintel-mcp
  • command: python
  • args: ["/path/to/opencodeintel/mcp-server/server.py"]
  • env（可选）：{ "BACKEND_API_URL": "http://localhost:8000", "API_KEY": "your-api-key" }
  • 注释：该配置指定服务器名称与启动命令，环境变量用于后端服务地址和鉴权，具体路径请按实际部署环境填写。MCP 客户端不需要知晓后端实现细节，只需要能够启动该服务器进程并将其作为上下文提供者接入即可。
• 基本使用方法
  • 启动服务器后，确保后端依赖的服务（如后端 API、数据库、缓存等）就绪。
  • 在 MCP 客户端（如 Claude Desktop 等）中配置一个 MCP 服务器实例，使用上述命令和环境变量启动信息。
  • 向 MCP 服务器请求资源、调用工具、获取提示模板等，服务器将按 MCP 协议返回标准 JSON-RPC 响应或通知。
  • 根据实际需求，可通过 WebSocket/HTTP 传输实现实时进度与交互反馈。