使用说明
Vibe编码器MCP服务器
Vibe Coder是一个MCP(模型上下文协议)服务器,旨在为您的AI助手(如Cursor、Cline AI或Claude Desktop)提供强大的软件开发工具。它有助于研究、规划、生成需求、创建启动项目等等!
概述和功能
Vibe Coder MCP与MCP兼容客户端集成,提供以下功能:
- 顺序思维:通过灵活、循序渐进的思维方式处理问题。
- 请求处理器:将请求路由并管理到适当的专用工具。
- 研究经理:使用困惑声纳进行深入研究。
- 规则生成器:创建针对特定项目的开发规则。
- PRD发电机:编制详细的产品要求文件。
- 用户故事生成器:创建具有接受标准的结构化用户故事。
- 任务列表生成器:制定具有依赖关系的详细开发任务列表。
- 全栈入门套件生成器:使用定制的技术栈创建定制的项目入门套件。
(有关更多信息,请参阅下面的“详细工具文档”和“功能详细信息”部分)
安装指南
按照以下步骤操作,使Vibe Coder MCP服务器运行并连接到您的AI助手。
第一步:先决条件
确保您的系统上安装了以下内容:
- Node.js: 建议使用18或更高版本。(这包括
npm,节点包管理器)。您可以从以下网址下载 nodejs.org. - Git: 用于克隆存储库。您可以从以下网址下载 git-scm.com.
- OpenRouter API密钥: Vibe Coder通过OpenRouter使用模型。获取免费钥匙 openrouter.cn.
第二步:获取代码
打开终端或命令提示符并克隆此存储库:
git clone https://github.com/freshtechbro/vibe-coder-mcp.git # Or your fork's URL
导航到新克隆的目录:
cd vibe-coder-mcp
步骤3:运行安装脚本
此脚本安装依赖项、构建项目并准备必要的文件。
-
在Windows上:
setup.bat -
在macOS或Linux上:
chmod +x setup.sh ./setup.sh
脚本会告诉你它是否创建了 .env 文件。
步骤4:添加您的API密钥
- 打开
.env文件位于vibe-coder-mcp带有文本编辑器的目录。 - 找到那条线
OPENROUTER_API_KEY=your_openrouter_api_key_here. - 替换
your_openrouter_api_key_here使用您的实际OpenRouter API密钥。 - 保存并关闭
.env文件。
步骤5:与您的AI助手集成
这是将Vibe Coder连接到您的AI工具的关键步骤。您需要为您的助手编辑特定的配置文件。
A.找到项目的绝对路径:
你需要完整的路径 build/index.js 文件内 vibe-coder-mcp 您克隆的目录。
- 简单的方法: 导航到
vibe-coder-mcp/build在终端中打开目录并运行:- 窗户:
cd build然后echo %cd%\index.js(复制输出) - macOS/Linux:
cd build然后pwd(复制输出并附加/index.js)
- 窗户:
- 例子:
C:/Users/YourName/Projects/vibe-coder-mcp/build/index.js或/Users/YourName/Projects/vibe-coder-mcp/build/index.js
B.准备配置块:
复制以下JSON块 替换 <ABSOLUTE_PATH_TO_BUILD_INDEX_JS> 使用您在上面找到的实际路径。也, 替换 <YOUR_OPENROUTER_API_KEY> 用你的钥匙。
"vibe-coder-mcp": {
"command": "node",
"args": ["<ABSOLUTE_PATH_TO_BUILD_INDEX_JS>"],
"env": {
"NODE_ENV": "production",
"OPENROUTER_API_KEY": "<YOUR_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"
]
}
C.编辑助手的配置文件:
-
光标/风帆(使用VS代码
settings.json):- 打开光标/风帆。
- 打开命令选项板(
Ctrl+Shift+P或Cmd+Shift+P). - 搜索并选择
Preferences: Open User Settings (JSON). - 查找
"mcpServers": { ... }对象。如果它不存在,请按如下方式添加:"mcpServers": {}. - 将准备好的配置块(来自步骤B)粘贴到花括号内
{}属于的mcpServers。如果已列出其他服务器,请添加逗号,在粘贴之前。 - 保存
settings.json文件。
-
Cline AI(VS代码扩展):
- 打开VS代码。
- 找到设置文件,通常位于:
- 窗户:
C:\Users\[YourUsername]\AppData\Roaming\Cursor\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json - macOS:
~/Library/Application Support/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json(路径可能略有不同) - Linux:
~/.config/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
- 窗户:
- 打开这个
cline_mcp_settings.json文件。 - 查找
"mcpServers": { ... }对象。如果它不存在,请添加它。 - 将准备好的配置块(来自步骤B)粘贴到
mcpServers对象(如果需要,添加逗号)。 - 保存文件。
-
克劳德桌面:
- 找到设置文件:
- 窗户:
C:\Users\[YourUsername]\AppData\Roaming\Claude\claude_desktop_config.json - macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
- 窗户:
- 打开这个
claude_desktop_config.json文件。 - 查找
"mcpServers": { ... }对象。如果它不存在,请添加它。 - 将准备好的配置块(来自步骤B)粘贴到
mcpServers对象(如果需要,添加逗号)。 - 保存文件。
- 找到设置文件:
配置的重要注意事项:
- 绝对路径至关重要: 确保路径正确
"args"是通往build/index.js相对路径通常不起作用。 - 使用正向划水: 即使在Windows上,也要使用正斜杠
/在JSON文件内的路径中(例如。,C:/Users/...). NODE_ENV: 保持"NODE_ENV": "production"在env块。这确保了日志记录在不干扰AI助手的情况下正常工作。
步骤6:重新启动AI助手
完全关闭并重新打开 光标、VS代码(使用Cline AI)或克劳德桌面。这允许它加载新的MCP服务器配置。
就是这样!您的Vibe Coder MCP服务器现在应该已连接并准备好在您的AI助手中使用。
项目结构
vibe-coder-mcp/
├── .env # Environment configuration (for local runs)
├── mcp-config.json # Example MCP configuration snippet
├── package.json # Project dependencies
├── README.md # This file
├── setup.bat # Windows setup script
├── setup.sh # macOS/Linux setup script
├── tsconfig.json # TypeScript configuration
├── build/ # Compiled JavaScript output (created by npm run build)
└── src/ # Source code
├── index.ts # Entry point
├── logger.ts # Logging configuration
├── server.ts # MCP server setup
├── services/ # Support services (request processing, matching)
│ ├── hybrid-matcher/
│ ├── intent-service/
│ ├── matching-service/
│ └── request-processor/
├── tools/ # Tool implementations
│ ├── fullstack-starter-kit-generator/
│ │ └── README.md # Detailed tool documentation
│ ├── prd-generator/
│ │ └── README.md # Detailed tool documentation
│ ├── research-manager/
│ │ └── README.md # Detailed tool documentation
│ ├── rules-generator/
│ │ └── README.md # Detailed tool documentation
│ ├── sequential-thinking.ts
│ ├── task-list-generator/
│ │ └── README.md # Detailed tool documentation
│ └── user-stories-generator/
│ └── README.md # Detailed tool documentation
├── utils/ # Shared utility functions
│ └── researchHelper.ts # Centralized Perplexity research functionality
└── types/ # TypeScript type definitions
├── globals.d.ts
├── tools.ts
└── workflow.ts
详细的工具文档
每个工具 src/tools/ 该目录在其自己的README.md文件(如果可用)中包含了全面的文档。这些文件包括:
- 工具概述和用途
- 输入/输出规格
- 工作流程图(Mermaid)
- 使用示例
- 使用的系统提示
- 错误处理详细信息
有关详细信息,请参阅这些单独的自述文件:
src/tools/fullstack-starter-kit-generator/README.mdsrc/tools/prd-generator/README.mdsrc/tools/research-manager/README.mdsrc/tools/rules-generator/README.mdsrc/tools/task-list-generator/README.mdsrc/tools/user-stories-generator/README.md- (顺序思维工具的详细信息主要在
src/tools/sequential-thinking.ts)
功能详细信息
顺序思维工具(sequential-thinking.ts)
实施动态解决问题的方法:
- 动态问题分析:将复杂的问题分解为连续的思维。
- 自适应处理:根据复杂性调整思考步骤的数量。
- 修订能力:可以质疑、修改或从以前的想法中分支出来。
- 解决方案验证:根据思维链验证假设。
- 通过OpenRouter利用LLM进行认知处理。
请求处理器(src/services/request-processor/)
编排层:
- 处理将请求路由到适当的专用工具。
- 验证所有工具的输入。
- 处理工具特定参数。
- 管理MCP协议的请求/响应处理。
发电机工具(src/tools/*-generator/)
这些工具遵循类似的模式:
- 验证输入。
- 使用困惑进行预生成研究(
researchHelper.ts). - 收集一个提示,包括输入和研究背景。
- 使用Gemini通过以下方式生成主要输出(PRD、规则等)
processWithSequentialThinking. - 格式化并保存输出工件。
- 通过MCP返回结果。
- 研究经理(
research): 执行研究作为其主要功能,由Gemini增强。 - 规则生成器(
generate-rules): 创建特定于项目的开发规则。 - PRD发电机(
generate-prd): 生成全面的产品需求文档。 - 用户故事生成器(
generate-user-stories): 创建具有接受标准的详细用户故事。 - 任务列表生成器(
generate-task-list): 构建具有依赖关系的结构化开发任务列表。 - 全栈入门套件生成器(
generate-fullstack-starter-kit): 创建自定义的项目启动工具包(定义JSON和设置脚本)。
系统流量
flowchart TD
User[User] -->|Request| Server[MCP Server]
Server -->|Process Request| RP[Request Processor]
RP -->|May use Sequential Thinking| ST[Sequential Thinking]
ST -->|Returns Analysis/Result| RP
RP -->|Route to Tool| SpecificTool{Specific Tool}
SpecificTool -- Pre-Generation Research --> ResearchUtil[researchHelper.ts (Perplexity)]
ResearchUtil -->|Research Context| SpecificTool
SpecificTool -- Generation --> SeqThinkingUtil[processWithSequentialThinking (Gemini)]
SeqThinkingUtil -->|Generated Content| SpecificTool
SpecificTool -->|Save Artifact| FileSystem[workflow-agent-files]
SpecificTool -->|Tool Results| Server
Server -->|Response| User
顺序思维过程
flowchart TD
A[Start] --> B[Initial Estimate of Thoughts]
B --> C[Generate First Thought]
C --> D{More Thoughts Needed?}
D -->|Yes| E[Generate Next Thought]
E --> F[Add to Context]
F --> D
D -->|No| G[Extract Solution]
G --> H[End]
E -->|Revise Previous| I[Mark as Revision]
I --> F
E -->|Branch New Path| J[Mark as Branch]
J --> F
生成的文件存储
生成器工具的输出(PRD、规则、研究报告等)存储在 workflow-agent-files 目录,按工具名称组织到子目录中:
workflow-agent-files/
├── research-manager/
├── rules-generator/
├── prd-generator/
├── user-stories-generator/
├── task-list-generator/
└── fullstack-starter-kit-generator/
文件带有时间戳(例如。, [timestamp]-[sanitized-name]-prd.md).
使用示例
通过连接的AI助手与工具交互:
- 研究:
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助手集成(使用stdio),但您可以直接运行服务器进行测试:
- 生产模式(标准):
npm start(日志转到stderr,模拟AI助手启动) - 开发模式(标准、漂亮日志):
npm run dev(日志转到stdout,需要nodemon,pino-pretty) - SSE模式(HTTP接口):
npm run start:sse或npm run dev:sse(使用HTTP,通过配置PORT在……里面.env)
故障排除
- AI助手中的连接错误:
- 编辑配置文件后,您是否完全重新启动了AI助手?
- 配置中的绝对路径是
"args"正确使用正斜杠/? - 是
"disabled": false设置为vibe-coder-mcp在配置中?
- API密钥错误:
- 是
OPENROUTER_API_KEYAI助手的配置正确env块? - (对于本地运行)密钥是否正确
.env文件? - 你的OpenRouter帐户有信用吗?
- 是
- 启动时出现JSON错误(在AI助手中):
- 确保
"NODE_ENV": "production"在AI助手的配置中设置env块为vibe-coder-mcp。这对于正确记录日志至关重要。
- 确保
- 文件权限问题(在设置或工具使用过程中):
- 确保您的用户在
vibe-coder-mcp目录及其子目录(尤其是workflow-agent-files).
- 确保您的用户在
许可证
麻省理工学院