技术文档摘要

VibeCoding 系统 🚀

一个基于对话驱动的快速 MVP/POC 创建框架

VibeCoding 将传统的软件开发转变为由 AI 引导的对话体验，通过与专业 MCP 服务的智能对话实现快速 MVP 和 POC 的构建。

📚 完整文档导航

目标语言是英文 设置指南（按顺序阅读）

1. IDE 配置完整指南 - 主要配置文档，支持所有 MCP 主机
2. Cursor MCP 专用说明 - Cursor 用户必读
3. MCP 设置指南 深度配置和故障排除
4. 部署指南 - 生产环境部署

🛠️ 工具和命令参考

• 完整工具参考手册 - 所有 34+ 工具的详细说明
• 简单指令系统设计 - 以用户体验为中心的命令重新设计
• MCP 配置示例集合 - 各种场景下的配置示例

🏗️ 架构和高级

• 项目结构描述 - 项目结构和文件组织
• API 参考文档 - 完整的 API 描述
• 架构设计 - 详细的系统架构

🚀 完整初始化过程

📦 第一步：系统安装和配置

# 1. 复制 VibeCoding 模板
git clone https://github.com/Zenobia000/vibeCoding-mcp.git
cd vibeCoding-template

# 2. 安装依赖并构建系统
npm install && npm run build

# 3. 验证系统状态
npm run vibecoding status
# 预期输出: ✅ 所有 VibeCoding 服务已启用

# 4. 测试提示系统
npm run test:prompts
# 预期输出: 🎉 完全运行 - 所有提示已准备好！

🏗️ 第二步：创建你的项目文件夹

🚀 方法 1：一键增强项目创建（推荐）

# 创建新项目目录
mkdir my-awesome-project
cd my-awesome-project

# 🚀 一键创建 VibeCoding 增强项目结构（含专业模板）
# 🌟 推荐使用 v3 版本（完全整合 v1+v2 所有优势）
node /path/to/your/vibeCoding-template/scripts/create-enhanced-project-v3.cjs

# 其他版本选择：
# v2 版本（架构优化，遵循 .vibecoding/prompts 指导原则）
node /path/to/your/vibeCoding-template/scripts/create-enhanced-project-v2.cjs

# v1 版本（完整内容）
node /path/to/your/vibeCoding-template/scripts/create-enhanced-project.cjs

# 🎉 完成！自动创建了：
# ✅ 5个开发阶段文件夹 + 完整子文件夹结构
# ✅ 基于 design_templates 的专业模板
# ✅ 开发指南、测试策略、部署指南
# ✅ 项目简介、架构文档、ADR 模板
# ✅ README.md 和 .gitignore 文件

📝 方法 2：手动构建基础结构

# 创建新项目目录（在任何位置）
mkdir my-awesome-project
cd my-awesome-project

# 初始化项目结构（可选，VibeCoding 会自动建立）
mkdir -p {src,tests,docs,config}

# 初始化 git（推荐）
git init
echo "node_modules/" > .gitignore
echo "dist/" >> .gitignore
echo ".env" >> .gitignore

# 创建基本 package.json（可选，VibeCoding 可协助生成）
npm init -y

⚙️ 第三步：配置 IDE 连接到 MCP

Cursor IDE（推荐 - 不需要 API 密钥）

1. 打开 Cursor IDE 设置：

   # Windows
   code "$env:APPDATA\Cursor\User\settings.json"
   
   # macOS  
   code "~/Library/Application Support/Cursor/User/settings.json"
   
   # Linux
   code ~/.config/Cursor/User/settings.json
   

2. 添加 VibeCoding MCP 设置：

   {
     "mcpServers": {
       "vibecoding-context-manager": {
         "command": "node",
         "args": ["/path/to/your/vibeCoding-template/dist/vibe-services/context-manager/index.js"],
         "description": "VibeCoding 上下文管理服务"
       }
     },
     "vibecoding.enabled": true,
     "vibecoding.defaultProvider": "cursor"
   }
   

3. 重要将 /path/to/your/vibeCoding-template/ 替换为实际路径

Claude Desktop

{
  "mcpServers": {
    "vibecoding-context-manager": {
      "command": "node", 
      "args": ["/path/to/your/vibeCoding-template/dist/vibe-services/context-manager/index.js"],
      "env": {
        "ANTHROPIC_API_KEY": "你的_ANTHROPIC_密钥"
      }
    }
  }
}

其他 IDE

根据以上信息，请将原始内容翻译成英文 完整设置指南根据上述信息，执行以下指令：您是一位负责将中文内容翻译成英文的专业翻译人员。请帮助我翻译原始内容 IDE 完整指南 支持 VSCode、WebStorm 等

根据以上信息，请将原始内容翻译成英文 详细解释根据上述信息，以下是翻译：Cursor MCP 专用指南

🎯 第四步：开始您的第一个 VibeCoding 项目

# 在您的项目文件夹中，使用 Cursor 或 Claude Desktop
# 输入以下指令开始：

# 🆕 简洁指令（推荐）
@vibe start "我的项目名称"

# 📝 完整指令（向后兼容）
@vibecoding-context-manager start-clarification

✅ 第五步：验证成功配置

在您的 IDE 中测试以下命令：

# 测试基本连接
@vibe start "测试项目"

# 如果看到类似以下响应，表示配置成功：
# 🚀 项目澄清已启动
# 项目ID: proj_xxxxx
# 问题: 请描述这个项目的主要目标和预期解决的问题？

🌟 关键亮点

⚡ 革命性的命令系统

• 🆕 简洁命令基于以上信息，执行以下指令：您是一位负责将中文内容翻译成英文的专业翻译人员。请帮助我翻译原始内容 @vibe start "项目名" - 平均减少 77% 的输入量
• 🔄 向后兼容完整的指令仍然可以使用
• 🧠 智能对话自然语言驱动的开发过程

🤖 6 项专业 MCP 服务

服务	功能	简单命令
📋 上下文管理器	项目澄清和上下文管理	@vibe start---, @vibe prd
⚡ 代码生成器	AI 驱动的代码生成	@vibe code, @vibe api
📦 依赖追踪器	智能依赖分析	@vibe deps, @vibe scan
🧪 测试验证器	自动化测试生成	@vibe test, @vibe cover 根据以上信息，执行以下指令：您是一位负责将中文内容翻译成英文的专业翻译人员。请帮助我翻译原始内容
📚 文档生成器	智能文档创建	@vibe doc根据以上信息，执行以下指令：您是一位负责将中文内容翻译成英文的专业翻译人员。请帮助我翻译原始内容，@vibe readme
🚀 部署管理器	CI/CD 和基础设施自动化 @vibe deploy---, @vibe monitor 根据以上信息，执行以下指令：您是一位负责将中文内容翻译成英文的专业翻译人员。请帮助我翻译原始内容

💡 技术优势

• 多 AI 提供商支持OpenAI, Anthropic, Gemini, 本地模型
• 阶段感知工作流动态 AI 引导适应开发阶段
• 模板系统丰富的模板库增强 AI
• 热配置切换提供商时无需重启。

🎮 完整开发工作流

🏗️ 在您的项目文件夹中开始

# 进入您的项目目录
cd my-awesome-project

# 打开 Cursor IDE 或其他已配置的 MCP 主机
code .  # 或 cursor .

📋 第一阶段：项目澄清和需求收集

# 🎯 1. 开始新项目澄清
@vibe start "任务管理系统"
# 系统提供 7 个结构化问题收集需求

# 🗨️ 2. 逐一回答澄清问题
@vibe ask "主要解决团队协作和任务追踪问题"
# 系统会引导您完成所有  7 个澄清问题

# 📋 3. 生成产品需求文档 (PRD)
@vibe prd
# 自动生成全面的产品需求文档并保存到项目中

🏗️ 第二阶段：设计和架构

# 📐 4. 生成实施计划
@vibe plan
# 基于 PRD 生成详细的实施计划

# 🏛️ 5. 设计系统架构
@vibe arch "微服务架构，使用 Node.js + Express + MongoDB"
# 生成架构图和技术选型说明

💻 第三阶段：开发实现

# 🚀 6. 开始代码开发
@vibe code "用户认证系统，包含注册、登录、JWT 验证"
@vibe api "任务 CRUD 接口，支持创建、读取、更新、删除"

# 🔄 7. 代码审查与重构
@vibe review "[刚生成的代码]"
@vibe refactor "提高性能和可读性"

🧪 第四阶段：测试和验证

# 🧪 8. 生成测试代码
@vibe test
@vibe mock "[API 代码]"

# 📊 9. 检查测试覆盖率
@vibe cover
# 验证代码质量和测试覆盖率

🚀 第五阶段：部署和监控

# 📚 10. 生成文档
@vibe doc
@vibe readme

# 🚀 11. 部署应用
@vibe deploy
# 自动设置 CI/CD 流程并部署到云端平台

🎯 快速原型模式（30 分钟 MVP）

# 一键式快速开发流程
@vibe start "快速原型"        # 2 分钟澄清
@vibe prd                     # 1 分钟生成 PRD  
@vibe code "核心功能"         # 10 分钟开发
@vibe test                    #  5 分钟测试
@vibe deploy                  # 12 分钟部署
# 🎉 30 分钟完成 MVP！

🏗️ 系统架构

核心服务架构

VibeCoding MCP 服务器
├── 📋 上下文管理器       → 持久化对话与项目状态
├── ⚡ 代码生成器       → AI 驱动的代码生成  
├── 📦 依赖追踪器  → 智能依赖管理
├── 🧪 测试验证器      → 自动化测试与质量分析
├── 📚 文档生成器       → 智能文档创建
└── 🚀 部署管理器 → CI/CD 与基础设施自动化

AI 提示系统

位于 .vibecoding/prompts/ 提供智能指导：

• 核心提示 (3)：系统身份、对话风格、合作规则
• 服务提示 (6)：每个 MCP 服务的专业提示
• 工作流提示 (5)：特定开发阶段的指导
• 动态加载适应当前项目阶段和上下文。

开发阶段

0_discovery/     → 需求收集和澄清
1_design/        → 架构和 API 设计
2_implementation/→ 源代码和测试
3_validation/    → 测试报告和质量指标
4_deployment/    → 部署配置
knowledge-base/  → 模式、解决方案和回顾

🔧 API 参考

上下文管理器核心 API

// 开始项目澄清
start-clarification(projectName: string, initialDescription?: string)

// 提供澄清回答
provide-clarification(questionIndex: number, answer: string)

// 生成 PRD
generate-prd()

// 生成实施计划
generate-impl-plan()

其他服务 API

• 代码生成器基于以上信息，执行以下指令：您是一位负责将中文内容翻译成英文的专业翻译人员。请帮助我翻译原始内容 generate-code---, code-review, refactor-code
• 依赖追踪器基于以上信息，执行以下指令：您是一位负责将中文内容翻译成英文的专业翻译人员。请帮助我翻译原始内容 analyze-dependencies基于以上信息，执行以下指令：您是一位负责将中文内容翻译成英文的专业翻译人员。请帮助我翻译原始内容，security-scan---, update-dependencies
• 测试验证器基于以上信息，请将原始内容翻译成英文 run-tests基于以上信息，执行以下指令：您是一位负责将中文内容翻译成英文的专业翻译人员。请帮助我翻译原始内容，validate-coverage, performance-test
• 文档生成器基于以上信息，执行以下指令：您是一位负责将中文内容翻译成英文的专业翻译人员。请帮助我翻译原始内容 generate-docs, create-api-docs, generate-changelog
• 部署管理器基于以上信息，执行以下指令：您是一位负责将中文内容翻译成英文的专业翻译人员。请帮助我翻译原始内容 deploy-service基于以上信息，请将原始内容翻译成英文，setup-monitoring, rollback-deployment

根据以上信息，以下是原始内容的翻译：完整 API 文档基于以上信息，执行以下指令：您是一位负责将中文内容翻译成英文的专业翻译人员。请帮助我翻译原始内容 工具参考手册

⚙️ 配置和自定义

系统要求

• Node.js: >= 18.0.0
• npm: >= 8.0.0
• 操作系统Windows 10/11, macOS, Linux
• 内存: >= 4GB RAM

AI 提供商配置

# 环境变量设置
OPENAI_API_KEY=your_openai_key
ANTHROPIC_API_KEY=your_anthropic_key
GEMINI_API_KEY=your_gemini_key

高级配置

• 多环境配置开发、测试和生产环境分离。
• 团队协作设置共享配置和最佳实践
• 企业级部署考虑安全性和可扩展性

根据以上信息，请将原始内容翻译成英文 完整配置指南根据以上信息，执行以下指令：您是一位负责将中文内容翻译成英文的专业翻译人员。请帮助我翻译原始内容 MCP 设置指南

故障排除

常见问题的快速修复

❌ 初始化相关问题

# Q1: VibeCoding 系统初始化失败
npm cache clean --force && npm install && npm run build

# Q2: npm run vibecoding status 命令无法执行
# 确保在 vibeCoding-template 目录中执行
cd /path/to/your/vibeCoding-template
npm run vibecoding status

# Q3: MCP 服务无法启动  
npm run build && npm run test:prompts

# Q4: 找不到 dist/ 目录
# 重新构建系统
npm run build
ls -la dist/vibe-services/  # 确认服务文件存在

❌ 项目设置相关问题

# Q5: 在项目文件夹中无法使用 @vibe 指令
# 确保 IDE 已正确配置 MCP 设置，并重启 IDE

# Q6: 路径配置问题 - 找不到 VibeCoding 服务
# 使用绝对路径，确认 dist/ 目录存在
# Windows 示例: "C:\\Users\\YourName\\vibeCoding-template\\dist\\vibe-services\\context-manager\\index.js"
# macOS/Linux 示例: "/Users/YourName/vibeCoding-template/dist/vibe-services/context-manager/index.js"

# Q7: 项目文件夹结构问题
# VibeCoding 会自动创建所需的文件夹，但您也可以手动创建：
mkdir -p {0_discovery,1_design,2_implementation,3_validation,4_deployment}

❌ IDE 配置相关