使用说明

项目简介

Code Analysis MCP Server 是一个轻量级的MCP服务器,旨在帮助开发者使用Claude等AI模型以自然语言的方式探索和理解代码库。它通过提供代码库的结构信息和文件内容读取功能,使AI能够回答关于代码库的问题,例如系统架构、数据模型、代码逻辑等。

主要功能点

  • 自然语言代码探索: 通过自然语言提问,例如 "系统中集成了哪些支付提供商?" 来探索代码库。
  • 深入代码理解: 提取关于数据模型和系统架构的见解,例如 "用户认证流程从前端到数据库是如何工作的?"
  • 动态分析: 追踪数据流并理解系统关系,例如 "展示所有计算交易费用的地方"。
  • 成本效益: 利用现有的Claude Pro订阅,无需额外的API费用。
  • 简单设置: 快速启动,配置简单。
  • 基础代码分析: 适用于高层次的代码理解和探索。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/saiprashanths/code-analysis-mcp.git
    cd code-analysis-mcp
  2. 安装 Claude 桌面应用: 访问 Claude Desktop App 下载并安装Claude桌面应用程序。

  3. 配置 MCP 服务器: 打开 Claude 桌面应用的配置文件 'claude_desktop_config.json',根据你的操作系统选择对应的路径:

    • macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
    • Windows: '%APPDATA%\Claude\claude_desktop_config.json'

    在 'mcpServers' 字段中添加 'code-analysis' 服务器的配置信息。

服务器配置

将以下 JSON 配置添加到 'claude_desktop_config.json' 文件的 'mcpServers' 字段中。请务必将 '/PATH/TO/YOUR/REPO' 替换为你想要分析的代码仓库的绝对路径

{
  "mcpServers": {
    "code-analysis": {
      "command": "uv",
      "args": [
        "--directory",
        "/PATH/TO/YOUR/REPO", // 替换为你的代码仓库的绝对路径,例如 "/Users/yourname/projects/my-repo"
        "run",
        "code_analysis.py"
      ]
    }
  }
}

配置参数说明:

  • '"code-analysis"': 服务器名称,在Claude客户端中用于识别和选择该服务器。
  • '"command": "uv"': 启动服务器的命令,这里使用 'uv' (假设 uv 是一个可用的 Python 虚拟环境或包管理器,如果你的环境不同,可能需要调整为 'python3' 或 'python' 等).
  • '"args"': 传递给启动命令的参数列表。
    • '"--directory"': 指定代码仓库的根目录。
    • '"/PATH/TO/YOUR/REPO"': 重要! 请替换为你要分析的实际代码仓库的绝对路径。
    • '"run"': 'uv run' 命令的一部分,用于运行 Python 脚本。
    • '"code_analysis.py"': 服务器主程序文件名。

注意: 请确保你的系统已安装 Python 环境,并且配置的 'command' 和 'args' 能够正确执行 'code_analysis.py' 文件。 如果你没有安装 'uv',可以尝试将 'command' 修改为 'python3' (或 'python',取决于你的 Python 环境配置),并相应地调整 'args',例如:

{
  "mcpServers": {
    "code-analysis": {
      "command": "python3",
      "args": [
        "code_analysis.py",
        "--directory",
        "/PATH/TO/YOUR/REPO" // 替换为你的代码仓库的绝对路径
      ]
    }
  }
}

请根据你的实际 Python 环境和 'uv' 工具的可用性选择合适的配置。

  1. 重启 Claude 桌面应用: 保存配置文件后,重启 Claude 桌面应用程序,使配置生效。

基本使用方法

  1. 启动代码库分析 Prompt: 在 Claude 桌面应用中,点击 "integrations" (集成) 按钮,应该能看到名为 'analyze_code_repository' 的 Prompt。点击该 Prompt 即可开始代码库分析流程。

  2. 初始化代码仓库: 'analyze_code_repository' Prompt 会引导你输入代码仓库的路径。首次使用时,你需要使用 'initialize_repository' 工具初始化要分析的代码仓库。

  3. 使用工具探索代码: 初始化成功后,你可以使用以下工具通过自然语言与 Claude 进行代码库的交互分析:

    • 'get_repo_info': 获取已初始化代码仓库的基本信息。
    • 'get_repo_structure': 查看代码仓库的文件目录结构。
    • 'read_file': 读取并分析指定文件的内容。
  4. 提出问题并分析: 使用自然语言向 Claude 提问关于代码库的问题,例如 "请解释用户登录流程" 或 "数据库连接是如何配置的?"。Claude 会根据你的问题,调用相应的工具来分析代码库并给出答案。

请参考仓库 README 中的 Example UsageAvailable Tools 部分,了解更详细的使用示例和工具功能。

信息

分类

开发者工具