关键词

云信IMRTC即时通讯音视频

项目简介

yunxin-mcp-server 是一个基于 Model Context Protocol (MCP) 构建的应用后端，专为云信客户设计。它旨在帮助用户通过大型语言模型 (LLM) 访问和利用云信 IM (即时通讯) 和 RTC (实时音视频) 的功能与数据。该服务器提供了一系列工具，使得 LLM 客户端能够便捷地与云信服务集成，实现更智能的应用场景。

主要功能点

  • 消息发送: 支持发送单聊和群聊消息，用于运营消息推送等场景。
  • 消息查询: 提供单聊和群聊历史消息查询功能，辅助运营分析。
  • 统计数据: 能够查询应用 IM 和 RTC 的每日统计数据，以及实时的在线人数、消息量、API 调用情况、SDK 调用情况等，用于监控服务状态和进行数据分析。
  • RTC 房间管理: 提供 RTC 房间成员查询、卡顿率查询、Top 房间分析、质量分布分析等功能，用于 RTC 服务监控和质量优化。
  • 时间戳转换工具: 提供时间戳格式化工具，方便处理时间数据。

安装步骤

  1. 环境准备: 确保已安装 Python 3.x 环境。
  2. 配置环境变量: 需要设置以下环境变量：
    • 'AppKey': 您的云信 AppKey。
    • 'AppSecret': 您的云信 AppSecret。 请联系云信技术支持获取您的 'AppKey' 和 'AppSecret'。
  3. 运行服务器: 在项目根目录下，执行以下命令启动 MCP 服务器： 
    python src/yunxin_mcp/server.py

服务器配置

MCP 客户端需要配置以下信息以连接到 yunxin-mcp-server：

{
  "serverName": "yunxin-mcp-server",
  "command": "python",
  "args": ["src/yunxin_mcp/server.py"]
}

配置参数说明:

  • 'serverName': 服务器名称，可以自定义。
  • 'command': 启动服务器的命令，这里使用 'python'。
  • 'args': 启动命令的参数，这里指定服务器脚本的路径 'src/yunxin_mcp/server.py'。

基本使用方法

  1. 启动 MCP 服务器。
  2. 在 MCP 客户端中，配置上述服务器连接信息。
  3. 使用 MCP 客户端调用服务器提供的工具，例如 'send_p2p_msg' 发送单聊消息，'query_im_online_connect_latest' 查询实时在线人数等。
  4. 工具的具体输入参数和返回结果请参考每个工具的 'description' 字段。

信息

分类

通信与社交

访问项目