Chatterbox MCP Server

🚀 Chatterbox MCP Server

Chatterbox MCP Server is a cutting - edge implementation based on the Model Context Protocol (MCP), designed for personal use. It serves as a bridge between applications and powerful AI models, enabling seamless communication with tools like WhatsApp. Whether you're building chatbots, automating tasks, or experimenting with AI, this server is your go - to solution!

🚀 Quick Start

1. Clone the repository:

   git clone https://github.com/your-repo/chatterbox_mcp_server.git
   cd chatterbox_mcp_server
   

2. Install dependencies:

   npm install
   

3. Run in development mode:

   npm run dev
   

4. Build and start:

   npm run build
   npm start
   

5. Run with Docker:

   npm run docker:local
   

✨ Features

• Dynamic Resource Management: Easily register and manage resources using the MCP framework.
• WhatsApp Integration: Fetch and send WhatsApp messages, and effortlessly find contact information using built - in tools.
• Environment - Driven Configuration: Securely manage and configure keys and environment variables for flexible deployment.
• Stdio Transmission: Communicate via standard input and output for simplicity and portability.
• Docker - Ready: Effortlessly deploy the server in a containerized environment.

🔧 Technical Details

This project leverages the following technologies to provide a robust and scalable solution:

• TypeScript: Ensures type safety and modern JavaScript features.
• Node.js: Provides a fast and efficient runtime environment.
• Model Context Protocol SDK: Powers the core functionality of the server.
• Zod: Validates input schemas for tools and resources.
• Express: Simplifies HTTP server creation and routing.
• Docker: Enables containerized deployment for a consistent environment.
• Nodemon: Facilitates real - time development with automatic restarts.

📚 Documentation

📂 Project Structure

The following is a brief overview of the project structure:

src/
    src/server.ts          # Main server entry point
    model/
        src/model/resources.ts   # Resource registration logic
        src/model/tools.ts       # Tool registration logic (e.g., WhatsApp tools)
    types/
        src/types/types.ts       # Project type definitions
secrets/               # Secure environment variable files
.vscode/               # VS Code configuration files
package.json           # Project metadata and scripts
tsconfig.json          # TypeScript configuration
dockerfile             # Docker configuration for containerization
README.md              # You're reading it!

💻 Usage Examples

Basic Usage

// Retrieve unread messages for a specific phone number
{
  "phoneNumber": "+1234567890",
  "numberOfRecords": "5"
}

// Send a message to a specific phone number
{
  "phoneNumber": "+1234567890",
  "message": "Greetings from the Chatterbox MCP Server!"
}

// Find a WhatsApp user by name and get their WhatsApp ID
{
  "contactName": "John Doe"
}

🤖 Why Choose Chatterbox MCP Server?

This project is not just a server—it's a playground for innovation. Whether you're a developer exploring AI integration or an enthusiast automating workflows, the Chatterbox MCP Server empowers you to turn your ideas into reality.

📄 License

This project is released under the MIT License. Feel free to use, modify, and share!

💬 Feedback and Contributions

We'd love to hear from you! Feel free to open an issue or submit a pull request to contribute to the project.

Happy coding!🎉