Vibe Coder MCP

🚀 振動 Vibe

本項目專注於現代 JavaScript 框架研究，能為不同類型的應用創建開發準則、生成產品需求文檔、用戶故事等。還具備代碼生成、重構、依賴分析等功能，提供全棧啟動套件，助力開發者高效開發。

🚀 快速開始

本項目功能豐富，涵蓋研究、開發準則生成、代碼處理等多個方面。在使用前，請確保完成安裝和配置，以便順利運行。

✨ 主要特性

• 研究：深入探討現代 JavaScript 框架。
• 生成規則：為移動銀行應用創建專業的開發準則。
• 生成產品需求文檔（PRD）：制定任務管理應用的詳細 PRD。
• 生成用戶故事：為電子商務網站編寫貼合用戶需求的故事。
• 生成任務列表：基於用戶故事生成天氣應用程序的任務清單。
• 順序思考：助力構思微服務架構的電子商務平臺。
• 全棧啟動套件：創建含用戶認證功能的 React/Node.js 博客應用啟動套件。
• 生成代碼片段：編寫名為 calculate_discount 的 Python 函數 stub。
• 重構代碼：將代碼重構為使用 async/await 的形式。
• 分析依賴項：審查 package.json 中的依賴關係。
• 顯示未提交更改：查看 Git 未提交的修改。
• 運行工作流：執行 newProjectSetup 等工作流。

📦 安裝指南

先決條件

1. Node.js：需安裝 Node.js 14 或以上版本。
2. npm：確保 npm 已正確安裝。

安裝步驟

1. 克隆倉庫

   git clone https://github.com/yourusername/yourrepo.git
   cd yourrepo
   

2. 安裝依賴

   npm install
   

3. 構建項目

   npm run build
   

4. 啟動服務
   • 生產模式：

     npm start
     

   • 開發模式：

     npm run dev
     

📚 詳細文檔

配置指南

環境變量

1. API 密鑰
   • OpenRouter API Key：在 .env 文件中設置 OPENROUTER_API_KEY，確保密鑰有效且有足夠額度。
2. 日誌級別
   • 在 .env 中添加 LOG_LEVEL=debug 以啟用調試模式。

工作流配置

1. 創建工作流文件：在 workflows/ 目錄下新建 JSON 文件，定義工作流步驟和參數。
2. 註冊工作流：

   {
     "id": "newProjectSetup",
     "name": "新項目設置",
     "description": "初始化新項目的必需工具",
     "steps": [
       { "tool": "projectName", "input": "{ \"projectName\": \"my-new-app\" }" },
       { "tool": "description", "input": "{ \"description\": \"A simple task manager\" }" }
     ]
   }
   

運行模式

標準輸入（AI 代理）

• 生產模式：

  npm start
  

  • 日誌輸出至標準錯誤流，模擬 AI 代理啟動。
  • 使用 NODE_ENV=production 環境變量。

• 開發模式：

  npm run dev
  

  • 日誌以彩色格式輸出，便於調試。
  • 需要安裝 nodemon 和 pino-pretty。

HTTP 接口（SSE 模式）

• 生產模式：

  npm run start:sse
  

• 開發模式：

  npm run dev:sse
  

  • 使用 HTTP 協議通信，默認監聽端口 3000。
  • 訪問地址：http://localhost:3000。

故障排除

連接問題

MCP 服務器未被 AI 代理識別

1. 檢查配置路徑：
   • 確認 args 數組中的絕對路徑正確無誤。
   • 使用全斜槓 /，即使在 Windows 上。
   • 直接運行 node <path-to-build/index.js> 測試 Node 是否能找到該路徑。
2. 檢查配置格式：
   • 確保 JSON 語法正確，無語句錯誤。
   • 核對 mcpServers 對象中的服務器配置是否完整。
3. 重啟代理程序：
   • 完全關閉（而非最小化）應用後重新打開。

服務器運行但工具不可用

1. 檢查禁用標誌：
   • 確認 "disabled": false 設置正確。
   • 移除任何可能導致此值為 true 的因素。
2. 檢查工作流注冊：
   • 確保所有自定義工作流已正確加載，特別是 newProjectSetup。

工具列表

1. 項目名稱
   • 描述：輸入新項目的名稱。
   • 示例："my-new-app"
2. 項目描述
   • 描述：簡要概述項目用途或目標。
   • 示例："A simple task manager"
3. 研究工具
   • 支持查詢技術趨勢、框架特性等。
4. 生成規則工具
   • 依據輸入生成具體的開發規範文檔。
5. 生成 PRD 工具
   • 輸出結構化的項目需求文檔。
6. 生成用戶故事工具
   • 制定用戶角色和對應需求。
7. 生成任務列表工具
   • 產出項目相關的任務清單，可排序和優先級設定。
8. 順序思考工具
   • 輔助進行系統架構設計或技術選型。
9. 全棧啟動套件工具
   • 提供基礎項目搭建模板，包括依賴管理、配置文件等。
10. 生成代碼片段工具
    • 依據輸入參數生成相應的代碼邏輯。
11. 重構代碼工具
    • 將現有代碼轉換為異步處理形式。
12. 分析依賴工具
    • 審查項目依賴，識別潛在風險或優化機會。
13. 顯示未提交更改工具
    • 展示 Git 倉庫中的未提交修改。

示例工作流

初始化新項目

{
  "id": "newProjectSetup",
  "name": "新項目設置",
  "description": "初始化新項目的必需配置和依賴",
  "steps": [
    { "tool": "projectName", "input": "{ \"projectName\": \"my-new-app\" }" },
    { "tool": "description", "input": "{ \"description\": \"A simple task manager\" }" }
  ]
}

生成開發規範

{
  "id": "generateDevelopmentGuidelines",
  "name": "生成開發準則",
  "description": "為項目制定詳細的技術規範和最佳實踐",
  "steps": [
    { "tool": "generateRules", "input": "{ \"project\": \"my-new-app\" }" }
  ]
}

日誌與監控

1. 日誌級別
   • 調試模式：DEBUG=true
   • 信息模式：默認
   • 錯誤模式：NODE_ENV=production
2. 監控工具
   • 使用 pm2 或其他進程管理器，確保服務穩定運行。
   • 配置日誌文件，便於排查問題。

安全注意事項

1. 環境變量安全：
   • 確保敏感信息如 API 密鑰不寫入版本控制系統。
2. 輸入驗證：
   • 對所有外部輸入進行嚴格驗證和 sanitization，防止注入攻擊或其他安全漏洞。
3. 日誌管理：
   • 避免在日誌中記錄敏感信息，確保合規性。

升級指南

1. 依賴升級

   npm update
   

2. 工作流更新
   • 檢查並更新 workflows/ 目錄下的所有 JSON 文件。
   • 確保新增或修改的工作流與現有系統兼容。
3. 配置調整
   • 更新 .env 文件中的參數，如新密鑰或日誌級別。
   • 重啟服務以應用更改。

貢獻指南

1. 代碼貢獻
   • Fork 倉庫後提交 Pull Request。
   • 遵循項目編碼規範和提交指南。