Hula MCP

🚀 HuLa Instant Messaging Application's MCP Service

The MCP (Message Communication Protocol) service of the HuLa instant messaging application is an HTTP-based protocol implementation designed to provide message communication capabilities in instant messaging applications. This service enables message sending, receiving, and management through a set of RESTful APIs and Server-Sent Events (SSE) interfaces.

✨ Features

• Implements message communication functions in instant messaging applications.
• Defines RESTful APIs and SSE interfaces for message operations.

📦 Installation

Clone the Repository

Clone this project using Git:

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

Install Dependencies

Install the required dependency packages for the project:

npm install
# Or use pnpm
pnpm install

Start the Service

Start the MCP service:

npm run start
# Or use pnpm
pnpm run start

By default, the service will run on http://localhost:3100.

💻 Usage Examples

Resources

Messages

• Get Messages

  GET /messages
  

• Send a Message

  POST /messages
  

Users

• Get User List

  GET /users
  

Tools

Message Tool

server.tool('message', (context) => {
    // Tool implementation
});

📚 Documentation

Integrate into AI Assistant

Mobile Integration

Method 1: Use CLI Tool

1. Install the CLI:

   npm install -g hula-mcp-cli
   

2. Start the service:

   hula-mcp start
   

3. Configure the integration:

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

Method 2: Manual Integration

1. Start the service.
2. Create a configuration file config.json:

   {
     "name": "HuLa-Mobile",
     "version": "1.0.0",
     "description": "MCP configuration for mobile clients",
     "baseUrl": "http://localhost:3100"
   }
   

Server Integration

Method 1: Use CLI Tool

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

Development Instructions

Add New Resources

Create or modify files in the src/resources directory and register resources using the server.resource() method.

Add New Tools

Register tools using the server.tool() method in the src/tools/index.ts file.

Contribution Guidelines

1. Fork this repository.
2. Create a feature branch:

   git checkout -b feature/your-feature
   

3. Commit your changes:

   git commit -m 'Add new feature'
   

4. Push the branch:

   git push origin feature/your-feature
   

5. Create a Pull Request.

🔧 Technical Details

Technology Stack

• TypeScript: Used for backend development.
• Express.js: A Node.js-based web application framework.
• MCP SDK: Provides the specific implementation of the MCP protocol.
• Zod: A library for data validation.

Project Structure

The following is the project's directory structure:

src/
├── resources/                 # Resource module directory
│   ├── messages.ts           # Message resource implementation
│   └── users.ts             # User resource implementation
├── tools/                    # Tool module directory
│   └── index.ts             # Entry file for registering tools
└── server.ts                 # Service initialization file

📄 License

This project is licensed under the MIT License.