Vibe Coder MCP

🚀 Vibe

Vibe is a tool that offers a variety of functions in the software development process, including research, rule generation, and code snippet generation.

🚀 Quick Start

Vibe provides a range of features for software development, from research on modern JavaScript frameworks to generating various documents and code snippets. To get started, follow the installation and configuration steps below.

✨ Features

• Research: Explore modern JavaScript frameworks.
• Generate Rules: Create development guidelines for mobile banking applications.
• Generate Product Requirement Document (PRD): Develop a PRD for task management applications.
• Generate User Stories: Write user stories for e - commerce websites.
• Generate Task Lists: Generate task lists for weather applications based on user stories.
• Sequential Thinking: Conceive an e - commerce platform with a microservice architecture.
• Full - stack Starter Kit: Create a starter kit for a React/Node.js blog application with user authentication.
• Generate Code Snippets: Write a Python function stub named calculate_discount that takes price and discount rate as parameters.
• Refactor Code: Refactor code to use async/await.
• Analyze Dependencies: Review dependencies in package.json.
• Show Uncommitted Changes: View uncommitted Git modifications.
• Run Workflows: Execute the newProjectSetup workflow with input parameters including "projectName": "my-new-app" and "description": "A simple task manager".

📦 Installation

Prerequisites

1. Node.js: You need to install Node.js version 14 or higher.
2. npm: Ensure that npm is installed correctly.

Installation Steps

1. Clone the repository

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

2. Install dependencies

   npm install
   

3. Build the project

   npm run build
   

4. Start the service
   • Production mode:

     npm start
     

   • Development mode:

     npm run dev
     

📚 Documentation

Configuration Guide

Environment Variables

1. API Key
   • OpenRouter API Key: Set OPENROUTER_API_KEY in the .env file. Make sure the key is valid and has sufficient quota.
2. Log Level
   • Add LOG_LEVEL=debug to .env to enable debug mode.

Workflow Configuration

1. Create a workflow file: Create a new JSON file in the workflows/ directory to define workflow steps and parameters.
2. Register the workflow:

   {
     "id": "newProjectSetup",
     "name": "New Project Setup",
     "description": "Necessary tools to initialize a new project",
     "steps": [
       { "tool": "projectName", "input": "{ \"projectName\": \"my-new-app\" }" },
       { "tool": "description", "input": "{ \"description\": \"A simple task manager\" }" }
     ]
   }
   

Running Modes

Standard Input (AI Agent)

• Production mode:

  npm start
  

  • Logs are output to the standard error stream, simulating the startup of an AI agent.
  • Use the NODE_ENV=production environment variable.

• Development mode:

  npm run dev
  

  • Logs are output in color for easy debugging.
  • You need to install nodemon and pino - pretty.

HTTP Interface (SSE Mode)

• Production mode:

  npm run start:sse
  

• Development mode:

  npm run dev:sse
  

  • Communicate using the HTTP protocol, listening on port 3000 by default.
  • Access address: http://localhost:3000.

Troubleshooting

Connection Issues

MCP server not recognized by the AI agent

1. Check the configuration path:

   • Make sure the absolute path in the args array is correct.
   • Use full slashes /, even on Windows.
   • Run node <path - to - build/index.js> directly to test if Node can find the path.

2. Check the configuration format:

   • Ensure that the JSON syntax is correct without statement errors.
   • Verify that the server configuration in the mcpServers object is complete.

3. Restart the proxy program:

   • Completely close (not minimize) the application and then reopen it.

Server is running but tools are unavailable

1. Check the disable flag:

   • Make sure the "disabled": false setting is correct.
   • Remove any factors that may cause this value to be true.

2. Check workflow registration:

   • Ensure that all custom workflows are correctly loaded, especially newProjectSetup.

Tool List

1. Project Name

   • Description: Enter the name of a new project.
   • Example: "my-new-app"

2. Project Description

   • Description: Briefly summarize the purpose or goal of the project.
   • Example: "A simple task manager"

3. Research Tool

   • Supports queries on technology trends, framework features, etc.

4. Generate Rules Tool

   • Generate specific development specification documents based on input.

5. Generate PRD Tool

   • Output a structured project requirement document.

6. Generate User Stories Tool

   • Develop user roles and corresponding requirements.

7. Generate Task Lists Tool

   • Produce project - related task lists that can be sorted and prioritized.

8. Sequential Thinking Tool

   • Assist in system architecture design or technology selection.

9. Full - stack Starter Kit Tool

   • Provide a basic project setup template, including dependency management and configuration files.

10. Generate Code Snippets Tool

    • Generate corresponding code logic based on input parameters.

11. Refactor Code Tool

    • Convert existing code to use asynchronous processing.

12. Analyze Dependencies Tool

    • Review project dependencies to identify potential risks or optimization opportunities.

13. Show Uncommitted Changes Tool

    • Display uncommitted modifications in the Git repository.

Example Workflows

Initialize a New Project

{
  "id": "newProjectSetup",
  "name": "New Project Setup",
  "description": "Necessary configurations and dependencies to initialize a new project",
  "steps": [
    { "tool": "projectName", "input": "{ \"projectName\": \"my-new-app\" }" },
    { "tool": "description", "input": "{ \"description\": \"A simple task manager\" }" }
  ]
}

Generate Development Guidelines

{
  "id": "generateDevelopmentGuidelines",
  "name": "Generate Development Guidelines",
  "description": "Develop detailed technical specifications and best practices for the project",
  "steps": [
    { "tool": "generateRules", "input": "{ \"project\": \"my-new-app\" }" }
  ]
}

Logging and Monitoring

1. Log Levels

   • Debug mode: DEBUG=true
   • Information mode: Default
   • Error mode: NODE_ENV=production

2. Monitoring Tools

   • Use pm2 or other process managers to ensure the stable operation of the service.
   • Configure log files for easy problem troubleshooting.

Security Considerations

1. Environment Variable Security:

   • Ensure that sensitive information such as API keys is not written to the version control system.

2. Input Validation:

   • Strictly validate and sanitize all external inputs to prevent injection attacks or other security vulnerabilities.

3. Log Management:

   • Avoid recording sensitive information in logs to ensure compliance.

Upgrade Guide

1. Dependency Upgrade

   npm update
   

2. Workflow Update

   • Check and update all JSON files in the workflows/ directory.
   • Ensure that new or modified workflows are compatible with the existing system.

3. Configuration Adjustment

   • Update the parameters in the .env file, such as new keys or log levels.
   • Restart the service to apply the changes.

Contribution Guide

1. Code Contribution
   • Fork the repository and submit a Pull Request.
   • Follow the project's coding standards and submission guidelines.