关键词

代码质量分析AI编程助手集成代码索引静态代码分析JavaScript TypeScript审计

项目简介

Code Auditor是一个全面的TypeScript/JavaScript代码质量审计工具，它能够分析您的代码库以评估SOLID原则合规性、DRY违规、安全模式等。通过内置的MCP服务器，它可以与各种AI助手（如Claude）集成，提供交互式代码分析、代码索引和AI工具配置功能，帮助开发者提升代码质量和开发效率。

主要功能点

  • 代码质量审计: 分析SOLID原则、DRY（代码重复）、安全模式、组件架构、数据访问模式等，生成详细报告。
  • 代码索引与搜索: 索引代码中的函数和组件，支持自然语言查询和高级搜索操作符，快速查找代码定义和用法。
  • AI工具配置: 自动为Cursor、Continue、Copilot、Claude等多种AI编码助手生成配置文件。
  • 上下文感知: 通过MCP协议向LLM客户端提供代码库的上下文信息和可调用工具，实现智能交互。
  • 依赖分析与维护: 追踪函数调用、依赖关系，检测循环依赖，并提供索引清理和同步工具。

安装步骤

为了运行Code Auditor MCP服务器，您首先需要安装它。可以通过全局安装或本地安装两种方式进行：

  • 全局安装: 在命令行中执行以下命令： 
    npm install -g code-auditor-mcp
  • 本地安装: 如果希望在项目内部使用，可以在项目根目录执行： 
    npm install --save-dev code-auditor-mcp

MCP服务器配置

MCP服务器通常通过标准输入/输出（stdio）与客户端通信。以下是Claude Code CLI和Claude Desktop手动配置MCP服务器的示例，配置中包含了服务器的启动命令和参数。

  • 对于Claude Code CLI: 在您的项目根目录中，使用Claude Code CLI添加Code Auditor MCP服务器： 'claude mcp add code-auditor -- npx code-auditor-mcp' 这条命令会将名为 'code-auditor' 的MCP服务器添加到您的Claude会话中，它会使用 'npx code-auditor-mcp' 命令启动服务器。

  • 对于Claude Desktop (手动配置):

    1. 确保您已全局安装 'code-auditor-mcp' ('npm install -g code-auditor-mcp')。
    2. 编辑您的Claude Desktop配置文件。根据您的操作系统，文件路径可能为：
      • macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
      • Windows: '%APPDATA%\Claude\claude_desktop_config.json'
      • Linux: '~/.config/Claude/claude_desktop_config.json'
    3. 在 'mcpServers' 部分添加以下JSON配置，确保路径 'dist/mcp.js' 相对于 'process.cwd()' 正确： 
      {
  "mcpServers": {
    "code-auditor": {
      // 启动MCP服务器的命令，建议使用npx确保路径正确
      "command": "npx",
      // 传递给命令的参数，此处为启动code-auditor-mcp工具
      "args": ["code-auditor-mcp"]
      // 您也可以指定完整的Node路径和mcp.js文件，例如：
      // "command": "node",
      // "args": ["<您的项目根目录>/node_modules/code-auditor-mcp/dist/mcp.js", "--mcp-mode"]
      // 或者如果全局安装，直接使用可执行名称
      // "command": "code-auditor-mcp",
      // "args": []
    }
  }
}
      这个配置告诉Claude Desktop，当需要与 'code-auditor' MCP服务器通信时，执行 'npx code-auditor-mcp' 命令来启动它。
    4. 重启Claude Desktop，MCP服务器便会可用。

基本使用方法

一旦MCP服务器配置并启动，AI助手就可以通过调用其提供的工具来进行代码分析和查询。

  • 运行代码审计: 您可以请求AI助手运行全面的代码审计，例如：“对我的项目进行代码审计，并显示所有关键问题。” (这将调用 'audit' 工具，默认会索引函数)
  • 代码健康检查: 询问AI助手代码库的健康状况：“检查src目录的代码健康评分。” (这将调用 'audit_health' 工具，默认会索引函数)
  • 搜索代码: 使用自然语言或特定操作符搜索代码中的函数和组件，例如：“搜索验证电子邮件地址的函数。” 或 “查找使用 useState hook 的 React 组件。” (这将调用 'search_code' 工具)
  • 查找定义: 请求AI助手查找特定函数或组件的定义：“找到 'validateUser' 函数的精确定义。” (这将调用 'find_definition' 工具)
  • 同步代码索引: 如果代码库有改动，可以请求AI助手同步索引：“更新我的代码索引以反映最新更改。” (这将调用 'sync_index' 工具) AI助手会根据您的请求，选择合适的MCP工具并返回相应结果。

信息

分类

开发者工具

访问项目