Vibe Coder Server 使用说明

项目简介

Vibe Coder Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在增强 AI 助手(如 Cursor、Cline AI、Claude Desktop 等)在软件开发方面的能力。它集成了一系列强大的工具,可以辅助进行软件开发过程中的研究、规划、需求生成、项目创建等任务。

主要功能点

  • 顺序思考 (Sequential Thinking): 采用灵活的步骤分解方法处理复杂问题。
  • 请求处理器 (Request Processor): 路由和管理客户端请求,分配给合适的工具处理。
  • 研究管理器 (Research Manager): 使用 Perplexity Sonar 进行深入研究。
  • 规则生成器 (Rules Generator): 为特定项目创建定制的开发规则。
  • PRD 生成器 (PRD Generator): 生成详细的产品需求文档 (PRD)。
  • 用户故事生成器 (User Stories Generator): 创建包含验收标准的用户故事。
  • 任务列表生成器 (Task List Generator): 生成包含依赖关系的详细开发任务列表。
  • 全栈脚手架生成器 (Fullstack Starter Kit Generator): 创建定制化的全栈项目脚手架,包含技术栈选择和基础代码。

安装步骤

  1. 安装前提条件

    • 确保已安装 Node.js (推荐 v18 或更高版本) 和 npm。
    • 确保已安装 Git。
    • 准备 OpenRouter API Key (访问 openrouter.ai 获取)。
  2. 获取代码: 使用 Git 克隆仓库到本地:

    git clone https://github.com/freshtechbro/vibe-coder-mcp.git
    cd vibe-coder-mcp
  3. 运行安装脚本: 根据你的操作系统运行相应的安装脚本:

    • Windows: 'setup.bat'
    • macOS/Linux:
      chmod +x setup.sh
      ./setup.sh

    此脚本将安装依赖、构建项目并准备配置文件。

  4. 添加 API Key: 打开 '.env' 文件,将 'OPENROUTER_API_KEY=your_openrouter_api_key_here' 中的 'your_openrouter_api_key_here' 替换为你的 OpenRouter API Key,并保存文件。

服务器配置

要将 Vibe Coder Server 集成到 MCP 客户端(如 Cursor、Cline AI、Claude Desktop),你需要配置客户端的 MCP 服务器设置。以下是一个典型的配置示例,你需要根据实际情况修改路径和 API Key:

{
  "vibe-coder-mcp": {
    "command": "node",
    "args": ["<你的Vibe Coder Server绝对路径>/vibe-coder-mcp/build/index.js"],
    "env": {
      "NODE_ENV": "production",
      "OPENROUTER_API_KEY": "<你的OpenRouter API Key>",
      "OPENROUTER_BASE_URL": "https://openrouter.ai/api/v1",
      "GEMINI_MODEL": "google/gemini-2.0-flash-001",
      "PERPLEXITY_MODEL": "perplexity/sonar-deep-research"
    },
    "disabled": false,
    "autoApprove": [
      "research",
      "generate-rules",
      "generate-prd",
      "generate-user-stories",
      "generate-task-list",
      "generate-fullstack-starter-kit",
      "process-request"
    ]
  }
}

配置参数说明

  • '"vibe-coder-mcp"': 服务器名称,用于在客户端中标识。
  • '"command": "node"': 启动服务器的命令,这里使用 Node.js 运行。
  • '"args": ["<你的Vibe Coder Server绝对路径>/vibe-coder-mcp/build/index.js"]': 启动命令的参数,指向 'build/index.js' 文件的绝对路径。请务必替换为你的实际路径
  • '"env"': 环境变量配置:
    • '"NODE_ENV": "production"': 设置为生产环境,优化日志输出。
    • '"OPENROUTER_API_KEY": "<你的OpenRouter API Key>"': 你的 OpenRouter API Key。请务必替换为你的实际 Key
    • '"OPENROUTER_BASE_URL"': OpenRouter API 基地址,默认使用官方地址。
    • '"GEMINI_MODEL"': 用于代码生成等任务的 Gemini 模型,可以根据需要调整。
    • '"PERPLEXITY_MODEL"': 用于研究的 Perplexity Sonar 模型,可以根据需要调整。
  • '"disabled": false': 设置为 'false' 启用该服务器。
  • '"autoApprove"': 自动批准执行的工具列表,可以根据需要调整。

配置方法

根据你使用的 MCP 客户端,将上述 JSON 配置添加到客户端的 MCP 服务器配置文件中。具体配置文件的位置请参考 README.md 文档中 "Step 5: Integrate with Your AI Assistant" 部分。

基本使用方法

配置完成后,重启你的 AI 助手客户端。现在你可以通过自然语言指令调用 Vibe Coder Server 提供的工具,例如:

  • 研究: 'Research modern JavaScript frameworks'
  • 生成规则: 'Create development rules for a mobile banking application'
  • 生成 PRD: 'Generate a PRD for a task management application'
  • 生成用户故事: 'Generate user stories for an e-commerce website'
  • 生成任务列表: 'Create a task list for a weather app based on [user stories]'
  • 顺序思考: 'Think through the architecture for a microservices-based e-commerce platform'
  • 全栈脚手架: 'Create a starter kit for a React/Node.js blog application with user authentication'

在 AI 助手中使用自然语言描述你的需求,Vibe Coder Server 将会自动匹配并调用相应的工具来辅助你完成开发任务。

信息

分类

开发者工具