使用说明

项目简介

Claude Code MCP 是 Claude Code 作为 Model Context Protocol (MCP) 服务器的实现。它旨在通过 MCP 接口,将 Claude Code 强大的软件工程能力提供给任何兼容 MCP 的客户端。该项目提供了一系列工具,用于文件操作、Shell 命令执行、代码分析等,并提供访问文件系统和环境信息的资源。

主要功能点

  • MCP 服务器实现: 实现了 Model Context Protocol 服务器,可以作为 MCP 客户端的后端。
  • Claude Code 功能集成: 集成了 Claude Code 的核心功能,例如代码生成、编辑、代码审查和分析等。
  • 丰富的工具集: 提供了多种工具,包括:
    • 'bash': 执行 Shell 命令。
    • 'readFile': 读取文件内容。
    • 'listFiles': 列出目录中的文件和目录。
    • 'searchGlob': 根据 Glob 模式搜索文件。
    • 'grep': 在文件中搜索文本。
    • 'think': 一个无操作工具,用于模拟思考过程。
    • 'codeReview': 代码审查。
    • 'editFile': 创建或编辑文件。
  • 资源访问: 提供了资源访问能力,允许客户端获取:
    • 文件内容 ('file://{path}')。
    • 目录内容 ('dir://{path}')。
    • 系统环境信息 ('env://info')。
  • Prompt 模板: 定义了 Prompt 模板,用于支持各种交互场景,例如:
    • 'generalCLI': 通用 CLI 交互 Prompt。
    • 'codeReview': 代码审查 Prompt。
    • 'prReview': PR 审查 Prompt。
    • 'initCodebase': 初始化 CLAUDE.md 文件的 Prompt。

安装步骤

  1. 克隆仓库
    git clone https://github.com/auchenberg/claude-code-mcp.git
    cd claude-code-mcp
  2. 安装依赖
    npm install
  3. 构建项目
    npm run build

服务器配置

MCP 客户端需要配置以下信息才能连接到 Claude Code MCP 服务器。配置信息为 JSON 格式,示例如下:

{
  "server name": "claude-code-mcp",
  "command": "node",
  "args": ["dist/index.js"]
}
  • 'server name': 服务器名称,可以自定义,用于在客户端配置中标识该服务器。例如 '"claude-code-mcp"'。
  • 'command': 启动服务器的命令。这里是 'node',表示使用 Node.js 运行时环境。
  • 'args': 启动服务器命令的参数数组。这里 '["dist/index.js"]' 指定了服务器入口文件 'dist/index.js',该文件在项目构建后生成。

基本使用方法

  1. 启动服务器: 在仓库根目录下运行命令 'npm start' 启动 Claude Code MCP 服务器。
  2. 配置 MCP 客户端: 在您的 MCP 客户端中,配置连接到 Claude Code MCP 服务器。您需要提供上述 服务器配置 中生成的 JSON 信息。
  3. 使用 MCP 客户端与服务器交互: 通过 MCP 客户端,您可以向 Claude Code MCP 服务器发送符合 MCP 协议的请求,例如调用工具、访问资源或使用 Prompt 模板。具体的请求方法和参数,请参考 MCP 客户端的文档和 MCP 协议规范。例如,您可以使用 'test-client.js' 中的示例代码进行测试。

信息

分类

开发者工具