返回市场
云信-MCP服务器

云信-MCP服务器

作者:netease-im7 星标更新:2025-04-28

项目介绍

yunxin-mcp-server

  • 如果您是云信的客户,并希望通过大型模型来处理云信IM/RTC相关的功能和数据,那么云信MCP服务器可能适合您。
  • 云信MCP服务器提供了一系列工具来访问和分析云信IM/RTC相关的功能和数据。
  • 如果您对目前提供的工具有任何建议或其他工具需求,请随时联系我们!
  • 如有任何疑问,请随时联系云信技术支持或添加微信 hdnxttl

架构图

img.png

使用方法

示例:如何使用

介绍文章:微信公众号

工具集合

send_p2p_msg/send_team_msg

  • 功能:发送单聊/群聊消息
  • 解释:基于发送者accid和接收者accid发送单聊文本消息;基于发送者accid和群组tid发送群聊文本消息
  • 场景:发送运营消息
  • 示例:发送消息

query_p2p_msg_history/query_team_msg_history

  • 功能:查询单聊/群聊历史消息
  • 解释:根据发送者accid、接收者accid和时间戳范围查询历史消息;根据accid、群组tid和时间戳范围查询群聊历史消息
  • 场景:分析历史消息以辅助运营
  • 示例:查询消息

query_application_im_daily_stats

  • 功能:查询应用IM的日统计数据
  • 解释:当前包括:日活跃用户数、上下行消息量、累计文件存储量、CC(次数、成功率和平均时长)、第三方回调(次数、成功率和平均时长)
  • 场景:分析日统计数据并检查服务是否有异常
  • 示例:查询应用IM日统计数据

query_rtc_room_members/query_rtc_room_members_by_uids

  • 功能:查询RTC房间成员信息
  • 描述:可以查询RTC房间内所有成员信息,也可以指定UID列表查询部分成员信息。还可以查询成员在线时长、地区和运营商、设备信息等
  • 场景:分析RTC房间的基本信息
  • 示例:查询RTC房间成员

query_rtc_room_stuck_rate/query_rtc_room_user_stuck_rate

  • 功能:查询房间音频和视频卡顿率指标,可以在房间级别或UID级别进行查询
  • 解释:检查一个或多个房间的延迟率
  • 场景:检查房间占用率并监控在线服务
  • 示例:查询RTC房间卡顿率

query_rtc_room_top_20

  • 功能:根据指标获取前20个房间,并基于这前20个房间查询过去30分钟内的其他相关指标
  • 描述:支持的指标有:呼叫用户数、用户在房间中的平均停留时间、视频卡顿率、音频卡顿率、音频网络延迟、视频网络延迟
  • 场景:监控监控系统的整体运行状态
  • 示例:查询RTC房间前20

query_rtc_quality_distribution

  • 功能:实时多维度分布查询指标
  • 描述:支持的维度有:操作系统、国家、省份、SDK版本、网络;支持的指标有:5秒房间进入成功率、音频卡顿率、视频卡顿率
  • 场景:监控监控系统的整体运行状态
  • 示例:查询RTC质量分布

query_im_online_connect_latest/query_im_online_connect

  • 功能:检查在线用户数量
  • 描述:支持查询最新的在线用户数量,以及基于时间范围查询在线用户数量。允许查询最近7天的数据,每次查询的最大时间为8小时
  • 场景:分析在线人口波动
  • 示例:查询在线连接

query_im_msg_latest/query_im_msg

  • 功能:查询上下行消息量,每分钟一点
  • 描述:支持查询最近n分钟的上下行消息量,以及基于时间范围查询上下行消息量。允许查询最近7天的数据,每次查询的最大时间为8小时
  • 场景:分析上下行消息波动
  • 示例:查询IM消息

query_im_api_stats/query_im_api_stats_last

  • 功能:查询API调用状态,包括调用量、平均响应时间、错误码状态,每分钟一点
  • 描述:支持查询最近n分钟的API调用状态,以及基于时间范围查询。允许查询最近7天的数据,每次查询的最大时间为8小时;支持查询API的整体情况,以及查询单个接口的情况
  • 场景:分析API调用情况
  • 示例:查询IM API统计

query_im_sdk_stats/query_im_sdk_stats_last

  • 功能:查询SDK调用状态,包括调用次数、平均响应时间、错误码状态,每分钟一点
  • 描述:支持查询最近n分钟的SDK调用状态,以及基于时间范围查询。允许查询最近7天的数据,每次查询的最大时间为8小时;支持查询API的整体情况,以及查询单个接口的情况(当前支持接口级别的统计:登录、单聊消息、群聊消息、系统通知、聊天室消息)
  • 场景:分析SDK调用情况
  • 示例:查询IM SDK统计