An MCP server implementation based on RongCloud IM Server.
Project description
Rcloud MCP Server
📌 Project Overview
rongcloud-server-mcp-python is an MCP server built on the FastMCP framework, integrating RongCloud instant messaging services. It supports user management, message sending, group operations, and more.
✨ Tools
| Tool | Description |
|---|---|
register_user |
Register a new user via RongCloud and return the user's token |
get_user_info |
Retrieve user information using RongCloud |
send_private_text_message |
Sends private messages and returns generated message IDs mapped to each recipient user ID |
send_group_text_message |
Sends group messages and returns generated message IDs mapped to each target group ID |
get_private_messages |
Retrieves historical private messages between two users within a specified time range |
create_group |
Creates a new group chat in RongCloud with specified members |
dismiss_group |
Permanently deletes a group chat from RongCloud |
get_group_members |
Retrieves the complete member list of an existing group chat in RongCloud |
join_group |
Adds one or more users to a specified group chat via RongCloud |
quit_group |
Removes one or more users from a RongCloud group chat |
get_current_time_millis |
Get the current time in milliseconds since Unix epoch (January 1, 1970 UTC). |
⚙️ Configuration
🔧 Environment Variables
| Variable Name | Required | Default | Description |
|---|---|---|---|
RONGCLOUD_APP_KEY |
✅ Yes | - | RongCloud Application App Key |
RONGCLOUD_APP_SECRET |
✅ Yes | - | RongCloud Application App Secret |
RONGCLOUD_API_BASE |
❌ No | https://api-cn.ronghub.com |
RongCloud API base URL |
RONGCLOUD_API_TIMEOUT |
❌ No | 10 |
API request timeout (seconds) |
FASTMCP_LOG_LEVEL |
❌ No | WARNING |
Log level (e.g., DEBUG, INFO) |
🧪 Example Configuration
RONGCLOUD_APP_KEY=your_app_key
RONGCLOUD_APP_SECRET=your_app_secret
RONGCLOUD_API_BASE=https://api-cn.ronghub.com
RONGCLOUD_API_TIMEOUT=10
FASTMCP_LOG_LEVEL=WARNING
💻 Claude Desktop Configuration
-
Config file paths:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%/Claude/claude_desktop_config.json
- macOS:
-
Example configuration:
{
"mcpServers": {
"rongcloud-server-mcp": {
"command": "uvx",
"args": [
"rongcloud-server-mcp-python"
],
"env": {
"RONGCLOUD_APP_KEY": "your_app_key",
"RONGCLOUD_APP_SECRET": "your_app_secret",
"RONGCLOUD_API_BASE": "https://api-cn.ronghub.com",
"RONGCLOUD_API_TIMEOUT": "10"
}
}
}
}
🧑💻 Development Guide
🚀 Quick Start
-
Clone the repository and enter the project directory:
git clone https://github.com/your-username/rcloud-server-mcp-python.git cd rcloud-server-mcp-python
-
Copy example environment file and edit variables:
cp .env.example .env
Edit
.envfile to set:RONGCLOUD_APP_KEY=your_app_key RONGCLOUD_APP_SECRET=your_app_secret RONGCLOUD_API_BASE=https://api-cn.ronghub.com FASTMCP_LOG_LEVEL=INFO
-
Create virtual environment, install dependencies, and start development server:
make venv make sync make install make dev
💡 Run
make helpto see all available commands.
✅ Running Tests
make test # Run all tests
make lint # Check code style and quality
make fix # Auto-fix formatting issues
🤝 Contribution Guide
Contributions are welcome! Please follow these steps:
- Fork the repository
- Create a feature branch:
git checkout -b feature/YourFeature - Commit your changes:
git commit -m 'Add YourFeature' - Push the branch:
git push origin feature/YourFeature - Open a Pull Request
Please ensure the following before submitting:
- No errors with
make lint- All tests pass with
make test- Code is properly formatted with
make format
📄 License
This project is licensed under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rongcloud_server_mcp_python-0.1.0.tar.gz.
File metadata
- Download URL: rongcloud_server_mcp_python-0.1.0.tar.gz
- Upload date:
- Size: 42.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b34d286a34e04663708496e62c6b72c811f4161270b5ae141f00a2d07ff4314f
|
|
| MD5 |
b578b49081538f0e7f7f8450bac48aec
|
|
| BLAKE2b-256 |
451fade8abb5fd400a99cb5a386c20e21906c1d872476928bbfb6411e4538709
|
File details
Details for the file rongcloud_server_mcp_python-0.1.0-py3-none-any.whl.
File metadata
- Download URL: rongcloud_server_mcp_python-0.1.0-py3-none-any.whl
- Upload date:
- Size: 15.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f5ca293f8323d02a10d8e71059b00bc89f37a3d2fe18eca6f00d7c9df7c579ce
|
|
| MD5 |
23021d3a4c1f169539fcc313e01b355d
|
|
| BLAKE2b-256 |
ab4f2f513c38dfa5039805e31379f5d30c6fd8001672e7ec44e9d60f6341987f
|