关键词

软件开发工具AI助手后端代码生成文档生成工作流自动化

Vibe Coder MCP 服务器 使用说明

Vibe Coder 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在通过提供强大的工具来增强您的AI助手（如 Cursor, Cline AI, 或 Claude Desktop），使其更好地协助软件开发任务。它可以帮助你进行研究、规划、生成需求文档、创建项目基础结构等。

主要功能点

Vibe Coder MCP 服务器通过与兼容MCP的AI客户端集成，提供以下功能：

  • 智能请求路由： 根据你的自然语言请求，智能地识别意图并路由到最合适的工具。
  • 工具注册与管理： 集中管理多种针对软件开发场景设计的工具。
  • 直接调用大型语言模型 (LLM)： 生成类工具直接与LLM交互，以获得更可靠、结构化的输出。
  • 工作流执行： 运行预定义的多步工具序列，自动化复杂任务。
  • 代码重构： 根据你的具体指令修改现有代码片段。
  • Git集成： 快速获取当前项目仓库的Git变更摘要（已暂存或未暂存）。
  • 研究与规划： 进行技术主题的深入研究，并生成产品需求文档 (PRD)、用户故事、任务列表、开发规范等文档。
  • 项目脚手架： 根据你的需求生成定制化的全栈项目基础代码。
  • 异步执行： 对于长时间运行的任务（如代码/文档生成、研究、工作流），服务器会在后台执行，并立即返回一个任务ID。
  • 任务结果检索： 你可以通过返回的任务ID随时查询任务的当前状态和最终结果。
  • 会话状态管理： 在同一会话中保持一些基本状态信息。
  • 标准化错误处理： 工具执行失败时提供一致的错误报告格式。

安装步骤

请按照以下步骤设置并运行 Vibe Coder MCP 服务器：

  1. 安装依赖：
    • 确保你的电脑已安装 Node.js (v18.0.0 或更高版本) 和 Git。
    • 从 nodejs.org 和 git-scm.com 获取。
  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'
    • 脚本会自动安装项目依赖，构建 TypeScript 代码，创建必要的输出目录，并复制 '.env.example' 文件为 '.env'。
  4. 配置环境变量：
    • 打开项目根目录下的 '.env' 文件。
    • 找到 'OPENROUTER_API_KEY=' 这一行，将 '"Your OPENROUTER_API_KEY here"' 替换为你从 openrouter.ai 获取的实际 API Key。这是运行工具必需的。
    • 你也可以选择修改 'VIBE_CODER_OUTPUT_DIR' 来改变生成文件的默认保存位置。

服务器配置 (用于AI客户端)

要让你的AI助手连接到 Vibe Coder，你需要编辑AI助手的MCP设置文件（通常是JSON格式），并添加 Vibe Coder 的配置信息。具体的文件位置因客户端而异（请查阅你的AI助手文档）。在 'mcpServers' 对象中，添加类似以下的配置块：

注意：这只是一个示例说明AI客户端需要哪些配置项和填什么内容，不是可以直接复制的代码块。请根据你的AI助手客户端文档，在正确的JSON文件中填写以下信息，并确保路径是绝对路径。

  • 服务器名称: 你给这个MCP服务器实例起的唯一名字，如 '"vibe-coder-mcp"'。
  • 启动命令 (command): 启动Node.js的命令，通常是 '"node"'。
  • 启动参数 (args): 一个字符串数组。第一个参数是服务器入口脚本 'build/index.js' 文件在你电脑上的绝对路径。
  • 工作目录 (cwd): 服务器进程运行时的工作目录。需要提供 'vibe-coder-mcp' 项目在你电脑上的绝对路径。
  • 传输协议 (transport): 客户端和服务器之间通信的方式。对于本地运行通常是 '"stdio"' (标准输入/输出)。
  • 环境变量 (env): 一个包含键值对的对象，用于设置传递给服务器进程的环境变量。例如，'"LLM_CONFIG_PATH"' 需要设置为项目根目录下 'llm_config.json' 文件在你电脑上的绝对路径。你也可以在这里设置日志级别等。
  • 禁用 (disabled): 一个布尔值，设置为 'false' 表示启用此服务器配置。
  • 自动批准 (autoApprove): 一个字符串数组，列出AI助手无需额外确认即可自动调用的工具名称。

请务必将示例中的 '/path/to/your/vibe-coder-mcp/...' 替换为你系统上的实际绝对路径，并使用正斜杠 '/' 作为路径分隔符，即使在 Windows 上也是如此。

配置完成后，完全关闭并重新启动你的AI助手，以使更改生效。

基本使用方法

在配置好服务器并重启AI助手后，你就可以在AI助手聊天界面中直接输入命令来调用 Vibe Coder 的工具了。以下是一些示例：

  • 进行研究： 'Research [你的研究主题]'
  • 生成开发规则： 'Create development rules for [你的产品描述]'
  • 生成PRD： 'Generate a PRD for [你的产品描述]'
  • 生成用户故事： 'Generate user stories for [你的产品描述]'
  • 生成任务列表： 'Create a task list for [你的产品描述] based on [用户故事描述]'
  • 思考复杂问题： 'Think through the architecture for a [你的主题]'
  • 生成项目脚手架： 'Create a starter kit for a [你的用例/技术栈] project'
  • 重构代码： 'Refactor this code to [你的指令]: [粘贴代码]'
  • 查看Git变更： 'Show unstaged git changes' 或 'Show staged git changes'
  • 运行工作流： 'Run workflow [工作流名称] with input { "key": "value", ... }' (根据 workflows.json 定义)
  • 获取任务结果： 'Get result for job [Job ID]' (用于获取异步任务的最终输出)

生成的文档和项目文件默认会保存在项目根目录下的 'VibeCoderOutput/' 文件夹中。

信息

分类

开发者工具

访问项目