🚀 Vibe - Coder MCP 服务器
Vibe - Coder MCP 服务器是一个用于基于大语言模型（LLM）编码的模型上下文协议（MCP）服务器，它实现了结构化的开发工作流程，能有效辅助 LLM 构建特性。
🚀 快速开始
Vibe - Coder MCP 服务器可帮助 LLM 构建特性，具备结构化的特性澄清过程、生成产品需求文档和实现计划、分阶段开发与任务跟踪、进度跟踪和状态报告以及文档存储和检索等功能。使用时，需与兼容的 MCP 客户端配合，按以下步骤操作：
- 安装依赖：
npm install
- 构建服务器：
npm run build
- 若需使用自动重建进行开发：
npm run watch
- 配置客户端：
- 在 MacOS 上：
~/Library/Application Support/Claude/claude_desktop_config.json - 在 Windows 上：
%APPDATA%/Claude/claude_desktop_config.json
- 在 MacOS 上：
{
"mcpServers": {
"vibe - coder - mcp": {
"command": "/path/to/vibe - coder - mcp/build/mcp - server.js"
}
}
}
✨ 主要特性
此 MCP 服务器通过提供以下功能帮助 LLM 构建特性：
- 结构化的特性澄清过程，带有引导式问题
- 生成产品需求文档 (PRD) 和实现计划
- 分阶段开发，任务跟踪
- 进度跟踪和状态报告
- 文档存储和检索能力
📦 安装指南
依赖安装
npm install
服务器构建
npm run build
开发模式（自动重建）
npm run watch
客户端配置
与兼容的 MCP 客户端一起使用，不同系统的配置文件路径如下：
- 在 MacOS 上：
~/Library/Application Support/Claude/claude_desktop_config.json - 在 Windows 上：
%APPDATA%/Claude/claude_desktop_config.json配置内容如下：
{
"mcpServers": {
"vibe - coder - mcp": {
"command": "/path/to/vibe - coder - mcp/build/mcp - server.js"
}
}
}
💻 使用示例
基础用法
资源使用
该服务器提供的资源包括特性详细信息、PRDs 和实现计划、进度报告和状态跟踪、阶段和任务详细信息。
工具调用
以下是部分工具的调用示例：
// 开始特性澄清过程
server.tool(
"start_feature_clarification",
(request) => {
// 开始特性澄清的逻辑
}
);
// 回答关于特性的澄清问题
server.tool(
"provide_clarification",
(request) => {
// 回答澄清问题的逻辑
}
);
高级用法
文档存储与检索
该服务器包含一个混合式文档存储系统，以下是相关操作示例：
默认存储
文档默认存储在 documents/{featureId}/ 目录下，例如产品需求文档存储在 documents/{featureId}/prd.md，实现计划存储在 documents/{featureId}/implementation - plan.md。
自定义存储
使用 save_document 工具将文档保存到自定义位置：
{
"featureId": "feature - 123",
"documentType": "prd",
"filePath": "/custom/path/feature - 123 - prd.md"
}
路径检索
使用 get_document_path 工具获取文档的路径：
{
"featureId": "feature - 123",
"documentType": "prd"
}
📚 详细文档
资源
| 资源类型 | 详情 |
|---|---|
| 特性详细信息、PRDs 和实现计划 | 提供特性的详细描述、产品需求文档和实现计划 |
| 进度报告和状态跟踪 | 跟踪特性开发的进度和状态 |
| 阶段和任务详细信息 | 包含开发阶段和任务的具体信息 |
工具
| 工具名称 | 功能 |
|---|---|
start_feature_clarification |
开始特性澄清过程 |
provide_clarification |
回答关于特性的澄清问题 |
generate_prd |
生成产品需求文档和实现计划 |
create_phase |
为特性创建开发阶段 |
add_task |
向开发阶段添加任务 |
update_phase_status |
更新阶段的状态 |
update_task_status |
更新任务的完成状态 |
get_next_phase_action |
获取下一步行动的指导 |
get_document_path |
获取生成文档的路径 |
save_document |
将文档保存到特定位置 |
提示
| 提示名称 | 用途 |
|---|---|
feature - planning |
用于计划特性开发的提示模板 |
🔧 技术细节
该服务器使用 Model Context Protocol TypeScript SDK 中的高级 McpServer 类实现，简化了创建 MCP 服务器的过程，提供了干净的 API 来定义资源、工具和提示。以下是部分实现代码：
import { McpServer, ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
// 创建一个 MCP 服务器
const server = new McpServer({
name: "Vibe - Coder",
version: "0.3.0"
});
// 添加资源
server.resource(
"features - list",
"features://list",
(request) => {
// 处理请求的逻辑
}
);
// 添加工具
server.tool(
"generate_prd",
(request) => {
// 生成 PRD 的逻辑
}
);
// 添加提示
server.prompt(
"feature - planning",
(request) => {
// 处理提示的逻辑
}
);
通过以上步骤，您可以设置一个功能齐全的 MCP 服务器来辅助基于 LLM 的编码开发。
💡 使用建议 由于 MCP 服务器通过标准输入输出进行通信，调试可能会比较困难。推荐使用 MCP Inspector，它作为一个包脚本提供：
npm run inspector
Inspector 将提供一个访问调试工具的 URL，在您的浏览器中打开。