Chatterbox MCP Server

🚀 Chatterbox MCP 服務器

Chatterbox MCP 服務器是基於模型上下文協議（MCP）的前沿實現，專為個人使用量身打造。它就像一座橋樑，連接應用程序與強大的 AI 模型，讓與 WhatsApp 等工具的通信無縫銜接。無論是開發聊天機器人、實現任務自動化，還是開展 AI 試驗，這個服務器都是您的理想之選！

🚀 快速開始

克隆倉庫

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

安裝依賴項

npm install

開發模式下運行

npm run dev

構建並啟動

npm run build
npm start

使用 Docker 運行

npm run docker:local

✨ 主要特性

• 動態資源管理：藉助 MCP 框架，輕鬆完成資源的註冊與管理。
• WhatsApp 集成：可以獲取和發送 WhatsApp 消息，還能利用內置工具輕鬆查找聯繫人信息。
• 環境驅動配置：通過靈活的部署方式，安全地管理和配置密鑰及環境變量。
• Stdio 傳輸：通過標準輸入輸出進行通信，既簡單又便於攜帶。
• Docker 就緒：可輕鬆在容器化環境中部署服務器。

🔧 技術細節

該項目運用了以下技術，構建出強大且可擴展的解決方案：

• TypeScript：保障類型安全，支持現代 JavaScript 功能。
• Node.js：提供快速高效的運行時環境。
• 模型上下文協議 SDK：為服務器的核心功能提供支持。
• Zod：用於驗證工具和資源的輸入模式。
• Express：簡化 HTTP 服務器的創建和路由設置。
• Docker：實現容器化部署，確保環境的一致性。
• Nodemon：支持即時開發，可自動重啟。

📚 詳細文檔

📂 項目結構

以下是項目結構的簡要介紹：

src/
    src/server.ts          # 主服務器入口點
    model/
        src/model/resources.ts   # 資源註冊邏輯
        src/model/tools.ts       # 工具註冊邏輯（例如 WhatsApp 工具）
    types/
        src/types/types.ts       # 項目類型定義
secrets/               # 安全環境變量文件
.vscode/               # VS Code 配置文件
package.json           # 項目元數據和腳本
tsconfig.json          # TypeScript 配置
dockerfile             # Docker 配置用於容器化
README.md              # 您正在閱讀它！

🌐 WhatsApp 工具

基礎用法

檢索消息

為特定電話號碼獲取未讀消息：

{
  "phoneNumber": "+1234567890",
  "numberOfRecords": "5"
}

發送消息

向特定電話號碼發送消息：

{
  "phoneNumber": "+1234567890",
  "message": "來自 Chatterbox MCP 服務器的問候！"
}

檢索用戶

通過姓名查找 WhatsApp 用戶並獲取其 WhatsApp ID：

{
  "contactName": "John Doe"
}

📄 許可證

該項目遵循 MIT 許可證發佈，您可以自由使用、修改和分享！

💬 反饋與貢獻

我們期待您的聲音！歡迎提出問題或提交拉取請求，為項目貢獻力量。

祝您編碼愉快！🎉