Hula MCP

🚀 HuLa 即時通訊應用的 MCP 服務

HuLa 即時通訊應用的 MCP 服務基於 HTTP 協議實現，為即時通訊應用提供消息通信功能。它通過定義 RESTful API 和 Server - Sent Events (SSE) 接口，實現消息的發送、接收與管理。

🚀 快速開始

HuLa 即時通訊應用的 MCP（Message Communication Protocol）服務是一個基於 HTTP 的協議實現，用於在即時通訊應用中提供消息通信功能。該服務通過定義一組 RESTful API 和 Server - Sent Events (SSE) 接口，實現了消息的發送、接收和管理。

✨ 主要特性

• 基於 HTTP 協議，利用 RESTful API 和 Server - Sent Events (SSE) 接口實現消息通信。
• 採用 TypeScript 進行後端開發，結合 Express.js 框架，保證開發效率與靈活性。
• 藉助 MCP SDK 實現 MCP 協議，使用 Zod 進行數據驗證，確保數據準確性。

📦 安裝指南

克隆倉庫

使用 Git 克隆本項目：

git clone git@github.com:your-repository.git
cd huila-mcp

安裝依賴

安裝項目所需的依賴包：

npm install
# 或者使用 pnpm
pnpm install

啟動服務

啟動 MCP 服務：

npm run start
# 或者使用 pnpm
pnpm run start

默認情況下，服務將在 http://localhost:3100 上運行。

💻 使用示例

基礎用法

消息資源（Messages）

• 獲取消息

  GET /messages
  

• 發送消息

  POST /messages
  

用戶資源（Users）

• 獲取用戶列表

  GET /users
  

高級用法

消息工具（Message Tool）

server.tool('message', (context) => {
    // 工具實現
});

📚 詳細文檔

項目結構

以下是項目的目錄結構：

src/
├── resources/                 # 資源模塊目錄
│   ├── messages.ts           # 消息資源實現
│   └── users.ts             # 用戶資源實現
├── tools/                    # 工具模塊目錄
│   └── index.ts             # 註冊工具的入口文件
└── server.ts                 # 服務初始化文件

集成到 AI 助手

移動端集成

方式一：使用 CLI 工具

1. 安裝 CLI：

   npm install -g hula-mcp-cli
   

2. 啟動服務：

   hula-mcp start
   

3. 配置集成：

   hula-mcp setup http://localhost:3100 --client mobile
   

方式二：手動集成

1. 啟動服務。
2. 創建配置文件 config.json：

   {
     "name": "HuLa-Mobile",
     "version": "1.0.0",
     "description": "移動客戶端的 MCP 配置",
     "baseUrl": "http://localhost:3100"
   }
   

服務端集成

方式一：使用 CLI 工具

hula-mcp start
hula-mcp setup http://localhost:3100 --client server

開發說明

添加新資源

在 src/resources 目錄下創建或修改文件，並使用 server.resource() 方法註冊資源。

添加新工具

在 src/tools/index.ts 文件中使用 server.tool() 方法註冊工具。

貢獻指南

1. Fork 本倉庫。
2. 創建功能分支：

   git checkout -b feature/your-feature
   

3. 提交更改：

   git commit -m '添加新功能'
   

4. 推送分支：

   git push origin feature/your-feature
   

5. 創建 Pull Request。

🔧 技術細節

技術棧

• TypeScript：用於後端開發。
• Express.js：基於 Node.js 的 Web 應用框架。
• MCP SDK：提供 MCP 協議的具體實現。
• Zod：用於數據驗證的庫。

📄 許可證

本項目遵循 MIT 協議。