Vibe Check

🚀 项目 README 文件

本项目提供了 vibe-check-mcp-server 的安装、配置和使用指南，帮助用户将其集成到 Claude 中，并介绍了相关工具、API 参考、架构原理等内容。

🚀 快速开始

本项目提供了 vibe-check-mcp-server 的使用方案，可自动或手动安装该服务，并集成到 Claude 中使用。同时，项目还提供了代理提示和工具使用的指南，以及 API 参考和架构原理的说明。

📦 安装指南

使用 Smithery 自动安装

通过 Smithery 自动为 Claude Desktop 安装 vibe-check-mcp-server：

npx -y @smithery/cli install @PV-Bhat/vibe-check-mcp-server --client claude

手动安装（推荐）

# 克隆仓库
git clone https://github.com/PV-Bhat/vibe-check-mcp-server.git
cd vibe-check-mcp-server

# 安装依赖项
npm install

# 构建项目
npm run build

# 启动服务
npm run start

💻 使用示例

集成到 Claude

在 claude_desktop_config.json 中添加：

"vibe-check": {
  "command": "node",
  "args": [
    "/path/to/vibe-check-mcp/build/index.js"
  ],
  "env": {
    "GEMINI_API_KEY": "YOUR_GEMINI_API_KEY"
  }
}

环境配置

在项目根目录创建一个 .env 文件：

GEMINI_API_KEY=your_gemini_api_key_here

📚 详细文档

代理提示指南

为有效模式中断，在系统提示中包含以下指令：

作为自主代理，您将：
1. 将 vibe_check 视为关键模式中断机制
2. 在每次调用时始终包含完整的用户请求
3. 指定当前阶段（计划/实施/审查）
4. 在复杂度增加时使用 vibe_distill 作为重新校准锚点
5. 使用 vibe_learn 构建反馈回路以记录解决的错误

使用工具指南

📄 API 参考

有关完整 API 文档，请参阅 技术参考。

🔧 技术细节

📄 许可证

请查看项目的许可证文件以获取详细信息。

🤝 贡献指南

有关如何为该项目做出贡献的详细信息，请参阅 CONTRIBUTING.md 文件。

📦 联系我们

如需联系项目维护人员，请发送邮件至 project-maintainers@example.com。