Vibe Check

🚀 Vibe Check MCP Server

A tool designed to assist Large Language Models (LLMs) in conducting metacognitive checks, preventing models from deviating from their goals due to over - complication.

🚀 Quick Start

This tool is used to help Large Language Models (LLMs) perform metacognitive checks, aiming to prevent the model from deviating from the target due to over - complication. It achieves this goal by introducing three key mechanisms: vibe_check, vibe_distill, and vibe_learn.

✨ Features

• vibe_check: A pattern interruption mechanism that intervenes when the LLM deviates.
• vibe_distill: When the model's plan becomes overly complex, this tool steps in to simplify the thinking process.
• vibe_learn: Records and learns from the errors the model encounters when dealing with complex problems, thereby continuously optimizing its performance.

📦 Installation

Installation via Smithery (for Claude Desktop)

Use Smithery to automatically install the tool into the Claude Desktop environment:

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

Manual Installation (Recommended)

1. Clone the repository:

   git clone https://github.com/PV-Bhat/vibe-check-mcp-server.git
   cd vibe-check-mcp-server
   

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

4. Start the server:

   npm run start
   

📚 Documentation

Integration with Claude

Add the following configuration to the claude_desktop_config.json file:

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

Environment Configuration

Create a file named .env with the following content:

GEMINI_API_KEY=your_gemini_api_key_here

Proxy Prompt Guide

To effectively interrupt the pattern, include the following instructions in the system prompt:

As an autonomous agent, you need to:
1. Treat vibe_check as a crucial pattern interruption mechanism.
2. Always include the full user request in each call.
3. Indicate the current stage (planning/implementation/review).
4. Use vibe_distill for recalibration when complexity increases.
5. Record and resolve encountered problems through vibe_learn.

Tool Usage Scenarios

API Reference

Refer to the Technical Reference for the full API documentation.

Architectural Principles

💻 Usage Examples

Basic Usage

# Install dependencies
npm install @pvbhat/vibe-check-mcp-server

# Configure environment variables
export GEMINI_API_KEY='your_api_key_here'

# Run the server
node index.js

📄 License

This project is licensed under the MIT License, as follows:

MIT License

Copyright (c) 2023 Your Name

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Contribution Guide

We welcome community contributions! Please refer to the Contribution Guide to learn how to participate in the development.

Contact Information

For feedback or questions, please contact: contact@yourdomain.com