项目简介

CodeAlive MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端,它将 CodeAlive 代码分析平台 的强大功能(包括语义代码搜索和代码库深度理解)通过标准化的方式提供给兼容MCP协议的AI客户端,例如 Claude Desktop, Cursor, Windserf, VS Code (GitHub Copilot) 等。通过集成此服务器,AI客户端能够更有效地理解和处理您的项目代码库,提供更精确、更相关的代码协助。

主要功能点

该服务器通过MCP协议提供了以下核心功能作为可供AI客户端调用的“工具”:

  1. 代码库聊天 ('chat_completions'): 允许AI与CodeAlive平台进行代码感知的对话,利用已索引的代码库知识来回答关于代码实现、架构、功能等方面的问题。
  2. 获取数据源 ('get_data_sources'): 列出您在CodeAlive平台中已配置和索引的所有可用代码仓库(Repository)和工作区(Workspace)。AI可以使用这些数据源的ID作为上下文进行后续操作。
  3. 代码搜索 ('search_code'): 在指定的CodeAlive数据源(代码仓库或工作区)中执行语义搜索,通过自然语言或代码模式查找相关的代码片段和文件位置。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/CodeAlive-AI/codealive-mcp.git
    cd codealive-mcp
  2. 创建并激活虚拟环境: (推荐使用'uv'或'pip')

    使用 uv:

    uv venv
    source .venv/bin/activate # Windows 用户使用: .venv\Scripts\activate

    使用 pip:

    python -m venv .venv
    source .venv/bin/activate # Windows 用户使用: .venv\Scripts\activate
  3. 安装依赖:

    uv pip install -e . # 或使用 pip install -e .
  4. 获取 CodeAlive API Key: 访问 https://app.codealive.dev/ 登录您的CodeAlive账户,在组织设置中生成并复制您的API Key。

服务器配置

此MCP服务器设计为由兼容的AI客户端启动和管理。您需要在AI客户端的配置中指定如何启动该服务器。

通用的配置模式是在客户端的设置中找到一个用于配置MCP服务器的部分(通常是JSON或YAML格式),添加一个配置对象,包含以下关键信息:

  • 服务器名称: 用于标识该服务器的唯一名称(例如:'"codealive"')。
  • 启动命令 ('command'): 指定用于启动服务器进程的可执行文件路径。这通常是您虚拟环境中的Python解释器 ('/path/to/your/codealive-mcp/.venv/bin/python') 或 'uv' 命令 ('uv')。
  • 命令参数 ('args'): 一个字符串列表,包含传递给启动命令的参数。通常包括服务器主脚本的路径(例如:'/path/to/your/codealive-mcp/src/codealive_mcp_server.py')和可选参数(例如:'"--debug"' 启用详细日志)。
  • 环境变量 ('env'): 一个键值对对象,用于设置服务器运行时需要的环境变量。最重要的是您的 CodeAlive API Key,需要设置为 '{"CODEALIVE_API_KEY": "您的API密钥"}'。

请参考您的AI客户端文档,找到具体的MCP服务器配置位置和格式,并填入上述信息,替换其中的路径占位符和API密钥。

基本使用方法

完成安装并在您的AI客户端中正确配置CodeAlive MCP服务器后,您无需直接与服务器交互。AI客户端会在您需要代码库上下文时(例如询问关于项目代码的问题)自动启动并利用该服务器的功能。

当您向AI提问关于您CodeAlive中已索引的代码库的问题时,AI客户端会根据您的请求,通过MCP协议调用服务器提供的 'get_data_sources'、'search_code' 或 'chat_completions' 等工具来获取相关信息或进行对话。您只需像平时一样与AI客户端交流即可。

信息

分类

开发者工具