关键词

代码生成自动化上下文服务智能助手软件开发

使用说明

项目简介

Claude Crew 是一个用于构建自主编码智能体的工具，它基于 Model Context Protocol (MCP) 协议，并与 Claude Desktop 协同工作。该项目旨在通过为 Claude Desktop 提供项目相关的上下文信息和定制化工具，使其能够更好地理解和执行代码相关的任务，从而实现更高效的自动化软件开发流程。

主要功能点

  • 项目配置管理: 通过交互式命令行界面 (CLI) 配置和管理项目信息，包括项目名称、编程语言、构建和测试命令、Git 设置以及集成配置等。
  • MCP 服务器: 提供 MCP 服务器功能，允许 Claude Desktop 等 MCP 客户端连接并利用项目上下文和工具。
  • 资源管理: 通过数据库管理项目资源（如代码文件、文档等），并支持基于向量嵌入的语义搜索功能（通过 RAG 集成）。
  • 工具注册与执行: 注册并提供一系列项目专属工具，例如文件系统操作（读取、写入、替换文件）、代码检查、运行测试、执行 Shell 命令等，供 Claude Desktop 调用。
  • Prompt 模板: 自动生成优化的 Prompt 指令 ('instruction.md')，指导 Claude Desktop 如何有效地利用提供的工具和上下文信息。
  • 集成扩展: 支持多种集成扩展，例如 TypeScript 集成（提供 TypeScript 声明搜索工具）、RAG 集成（基于 OpenAI API 提供文档和资源检索工具）、Shell 集成（允许执行受限的 Shell 命令）。
  • Memory Bank: 创建和维护项目 Memory Bank ('memory-bank.md')，用于存储项目概要、产品背景、系统模式和编码规范等持久化知识，帮助 Claude Desktop 在会话间保持项目理解。
  • 代码片段 (Snippet) 生成: 提供生成 Claude Desktop 代码片段的功能，用于自动批准可信工具和自定义快捷键等。

安装步骤

  1. 环境准备: 确保已安装 Claude Desktop、Node.js (>= v20)、Docker (如果需要使用内置数据库)。
  2. 进入项目目录: 打开终端，导航至你的项目根目录： 
    cd /path/to/your-project
  3. 运行 Setup 命令: 执行以下命令启动交互式配置向导： 
    npx claude-crew@latest setup
    根据提示完成项目名称、语言、命令、集成等配置。配置文件将生成在 '.claude-crew' 目录下。
  4. (可选) 数据库 Setup: 如果需要使用内置数据库，运行以下命令初始化数据库（'<config-path>' 为 '.claude-crew/config.json' 的路径）： 
    npx claude-crew setup-db <config-path>

服务器配置

要将 Claude Crew MCP 服务器连接到 MCP 客户端（例如 Claude Desktop），您需要配置客户端的 MCP 设置。以下是一个示例 'mcp.json' 配置，您需要根据实际情况进行调整：

{
  "claude-crew-<项目名称>": {  // "claude-crew-" 前缀加上项目名称，作为服务器名称
    "command": "/path/to/npx",  // npx 命令的绝对路径 (例如: /usr/bin/npx)，请替换为你的 npx 实际路径
    "args": [
      "-y",
      "claude-crew@latest",
      "serve-mcp",
      "/path/to/your-project/.claude-crew/config.json" // config.json 文件的绝对路径，请替换为你的实际路径
    ]
  }
}

参数说明:

  • 'claude-crew-<项目名称>': 服务器名称，需要替换为你在 setup 过程中设置的项目名称。
  • 'command': 启动 MCP 服务器的命令，通常是 'npx'。你需要替换为 'npx' 命令的实际路径。可以使用 'which npx' 命令在终端中查找。
  • 'args': 传递给 'npx' 命令的参数列表:
    • '-y': 'npx' 参数，自动确认安装 'claude-crew' 包。
    • 'claude-crew@latest': 指定要执行的 npm 包和版本。
    • 'serve-mcp': 'claude-crew' 的子命令，用于启动 MCP 服务器。
    • '/path/to/your-project/.claude-crew/config.json': 'serve-mcp' 子命令的参数，指定配置文件 'config.json' 的路径。你需要替换为你的项目配置文件 'config.json' 的实际绝对路径。

基本使用方法

  1. 配置 Claude Desktop: 将 '.claude-crew/mcp.json' 文件中的配置内容复制到 Claude Desktop 的 MCP 配置文件 ('~/Library/Application Support/Claude/claude_desktop_config.json'，macOS 路径示例)。
  2. 创建 Claude 项目: 在 Claude Desktop 中为你的项目创建一个新的 Claude 项目。
  3. 导入指令: 将 '.claude-crew/instruction.md' 文件中的内容复制到 Claude 项目的自定义指令 (Custom Instructions) 中。
  4. 开始使用: 启动 Claude Desktop，即可开始与你的项目进行交互。Claude Crew 提供的工具可以通过 'claude-crew-<项目名称>-<工具名称>' 的格式在 Claude Desktop 中调用，例如 'claude-crew-myproject-read-file'。

信息

分类

开发者工具

访问项目