vbnmxcz-mcp-server


Namevbnmxcz-mcp-server JSON
Version 0.1.6 PyPI version JSON
download
home_pageNone
Summaryyunxin mcp server to request im/rtc api
upload_time2025-08-13 09:50:40
maintainerNone
docs_urlNone
authorcaojiajun
requires_python>=3.11
licenseMIT
keywords im mcp rtc yunxin
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            
# yunxin-mcp-server

* 如果你是云信的客户，并且希望通过大模型来处理云信IM/RTC相关的功能和数据，那么yunxin-mcp-server可能适合你
* yunxin-mcp-server提供了一系列的工具，来访问和分析云信IM/RTC相关的功能和数据
* 如果你对当前提供的工具有什么建议，或者有其他的工具需求，欢迎留言告诉我们！
* 有任何问题欢迎联系云信技术支持，或者添加微信 `hdnxttl`

# 架构图

![img.png](docs/img_39.png)

# 如何使用

示例：[how_to_use](docs/how_to_use.md)

介绍文章：[微信公众号](https://mp.weixin.qq.com/s/u7ghW78T_E6X2i-urxk1ig)




# 工具集合

## send_p2p_msg/send_team_msg

* 功能：发送单聊/群聊消息
* 说明：根据发送方accid和接收方accid，发送一条单聊文本消息；根据发送方accid和群tid，发送一条群聊文本消息
* 场景：发送运营类消息
* 示例：[send_msg](docs/send_msg.md)

## query_p2p_msg_history/query_team_msg_history

* 功能：查询单聊/群聊历史消息
* 说明：根据发送方accid和接受方accid，以及时间戳范围，查询历史消息；根据accid和群tid，以及时间戳范围，查询群聊历史消息
* 场景：分析历史消息辅助运营
* 示例：[query_msg](docs/query_msg.md)

## query_application_im_daily_stats

* 功能：查询应用IM每日统计数据
* 说明：当前包括：日活、上下行消息量、累积的文件存储量、抄送（次数、成功率和平均耗时）、第三方回调（次数、成功率和平均耗时）
* 场景：分析每日统计数据，检查服务是否有异常
* 示例：[query_application_im_daily_stats](docs/query_application_im_daily_stats.md)

## query_rtc_room_members/query_rtc_room_members_by_uids

* 功能：查询rtc房间的成员信息
* 说明：查询一个rtc房间中的成员信息，可以查询所有成员，也可以指定uid列表查询部分成员，可以查询成员在线时长、所在的地区和运营商、设备信息等
* 场景：分析rtc房间基本信息
* 示例：[query_rtc_room_members](docs/query_rtc_room_members.md)

## query_rtc_room_stuck_rate/query_rtc_room_user_stuck_rate

* 功能：查询房间音视频卡顿率指标，可以是房间级别或者uid级别
* 说明：查询某个或者某几个房间的卡顿率
* 场景：查询房间卡顿率，监控线上服务
* 示例：[query_rtc_room_stuck_rate](docs/query_rtc_room_stuck_rate.md)

## query_rtc_room_top_20

* 功能：按照指标获取 Top 20 的房间，根据 Top 20 房间查询近 30 分钟其它相关指标
* 说明：支持指标：通话用户数、用户平均进房时长、视频卡顿率、音频卡顿率、音频网络延时、视频网络延时
* 场景：监控系统整体运行状况
* 示例：[query_rtc_room_top_20](docs/query_rtc_room_top_20.md)

## query_rtc_quality_distribution

* 功能：查询指标实时多维度分布
* 说明：支持的维度：操作系统、国家、省份、sdk版本、网络；支持的指标：5s 进房成功率、音频卡顿率、视频卡顿率
* 场景：监控系统整体运行状况
* 示例：[query_rt_quality_distribution](docs/query_rt_quality_distribution.md)

## query_im_online_connect_latest/query_im_online_connect

* 功能：查询在线人数
* 说明：支持查询最新的在线人数，也支持根据时间范围查询在线人数，允许查询最近7天的数据，每次查询最多8小时
* 场景：分析在线人数波动情况
* 示例：[query_online_connect](docs/query_online_connect.md)

## query_im_msg_latest/query_im_msg

* 功能：查询上下行消息量，1分钟一个点
* 说明：支持查询最近n分钟的上下行消息量，也支持根据时间范围查询上下行消息量，允许查询最近7天的数据，每次查询最多8小时
* 场景：分析上下行消息的波动情况
* 示例：[query_im_msg](docs/query_im_msg.md)

## query_im_api_stats/query_im_api_stats_last

* 功能：查询api调用情况，包括调用数量、平均响应时间、错误码情况，1分钟一个点
* 说明：支持查询最近n分钟的api调用情况，也支持根据时间范围查询，允许查询最近7天的数据，每次查询最多8小时；支持查询api的整体情况，也支持查询单个接口的情况
* 场景：分析api调用的情况
* 示例：[query_im_api_stats](docs/query_im_api_stats.md)

## query_im_sdk_stats/query_im_sdk_stats_last

* 功能：查询sdk调用情况，包括调用数量、平均响应时间、错误码情况，1分钟一个点
* 说明：支持查询最近n分钟的sdk调用情况，也支持根据时间范围查询，允许查询最近7天的数据，每次查询最多8小时；支持查询api的整体情况，也支持查询单个接口的情况(目前支持以下接口级别的统计：登录、单聊消息、群聊消息、系统通知、聊天室消息)
* 场景：分析sdk调用的情况
* 示例：[query_im_sdk_stats](docs/query_im_sdk_stats.md)

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "vbnmxcz-mcp-server",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "caojiajun <zj_caojiajun@163.com>",
    "keywords": "im, mcp, rtc, yunxin",
    "author": "caojiajun",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/b5/bb/7f7c7791d64e59a82b86796323080c9ca7a63beb6792d9e0bdba9e70f00b/vbnmxcz_mcp_server-0.1.6.tar.gz",
    "platform": null,
    "description": "\n# yunxin-mcp-server\n\n* \u5982\u679c\u4f60\u662f\u4e91\u4fe1\u7684\u5ba2\u6237\uff0c\u5e76\u4e14\u5e0c\u671b\u901a\u8fc7\u5927\u6a21\u578b\u6765\u5904\u7406\u4e91\u4fe1IM/RTC\u76f8\u5173\u7684\u529f\u80fd\u548c\u6570\u636e\uff0c\u90a3\u4e48yunxin-mcp-server\u53ef\u80fd\u9002\u5408\u4f60\n* yunxin-mcp-server\u63d0\u4f9b\u4e86\u4e00\u7cfb\u5217\u7684\u5de5\u5177\uff0c\u6765\u8bbf\u95ee\u548c\u5206\u6790\u4e91\u4fe1IM/RTC\u76f8\u5173\u7684\u529f\u80fd\u548c\u6570\u636e\n* \u5982\u679c\u4f60\u5bf9\u5f53\u524d\u63d0\u4f9b\u7684\u5de5\u5177\u6709\u4ec0\u4e48\u5efa\u8bae\uff0c\u6216\u8005\u6709\u5176\u4ed6\u7684\u5de5\u5177\u9700\u6c42\uff0c\u6b22\u8fce\u7559\u8a00\u544a\u8bc9\u6211\u4eec\uff01\n* \u6709\u4efb\u4f55\u95ee\u9898\u6b22\u8fce\u8054\u7cfb\u4e91\u4fe1\u6280\u672f\u652f\u6301\uff0c\u6216\u8005\u6dfb\u52a0\u5fae\u4fe1 `hdnxttl`\n\n# \u67b6\u6784\u56fe\n\n![img.png](docs/img_39.png)\n\n# \u5982\u4f55\u4f7f\u7528\n\n\u793a\u4f8b\uff1a[how_to_use](docs/how_to_use.md)\n\n\u4ecb\u7ecd\u6587\u7ae0\uff1a[\u5fae\u4fe1\u516c\u4f17\u53f7](https://mp.weixin.qq.com/s/u7ghW78T_E6X2i-urxk1ig)\n\n\n\n\n# \u5de5\u5177\u96c6\u5408\n\n## send_p2p_msg/send_team_msg\n\n* \u529f\u80fd\uff1a\u53d1\u9001\u5355\u804a/\u7fa4\u804a\u6d88\u606f\n* \u8bf4\u660e\uff1a\u6839\u636e\u53d1\u9001\u65b9accid\u548c\u63a5\u6536\u65b9accid\uff0c\u53d1\u9001\u4e00\u6761\u5355\u804a\u6587\u672c\u6d88\u606f\uff1b\u6839\u636e\u53d1\u9001\u65b9accid\u548c\u7fa4tid\uff0c\u53d1\u9001\u4e00\u6761\u7fa4\u804a\u6587\u672c\u6d88\u606f\n* \u573a\u666f\uff1a\u53d1\u9001\u8fd0\u8425\u7c7b\u6d88\u606f\n* \u793a\u4f8b\uff1a[send_msg](docs/send_msg.md)\n\n## query_p2p_msg_history/query_team_msg_history\n\n* \u529f\u80fd\uff1a\u67e5\u8be2\u5355\u804a/\u7fa4\u804a\u5386\u53f2\u6d88\u606f\n* \u8bf4\u660e\uff1a\u6839\u636e\u53d1\u9001\u65b9accid\u548c\u63a5\u53d7\u65b9accid\uff0c\u4ee5\u53ca\u65f6\u95f4\u6233\u8303\u56f4\uff0c\u67e5\u8be2\u5386\u53f2\u6d88\u606f\uff1b\u6839\u636eaccid\u548c\u7fa4tid\uff0c\u4ee5\u53ca\u65f6\u95f4\u6233\u8303\u56f4\uff0c\u67e5\u8be2\u7fa4\u804a\u5386\u53f2\u6d88\u606f\n* \u573a\u666f\uff1a\u5206\u6790\u5386\u53f2\u6d88\u606f\u8f85\u52a9\u8fd0\u8425\n* \u793a\u4f8b\uff1a[query_msg](docs/query_msg.md)\n\n## query_application_im_daily_stats\n\n* \u529f\u80fd\uff1a\u67e5\u8be2\u5e94\u7528IM\u6bcf\u65e5\u7edf\u8ba1\u6570\u636e\n* \u8bf4\u660e\uff1a\u5f53\u524d\u5305\u62ec\uff1a\u65e5\u6d3b\u3001\u4e0a\u4e0b\u884c\u6d88\u606f\u91cf\u3001\u7d2f\u79ef\u7684\u6587\u4ef6\u5b58\u50a8\u91cf\u3001\u6284\u9001\uff08\u6b21\u6570\u3001\u6210\u529f\u7387\u548c\u5e73\u5747\u8017\u65f6\uff09\u3001\u7b2c\u4e09\u65b9\u56de\u8c03\uff08\u6b21\u6570\u3001\u6210\u529f\u7387\u548c\u5e73\u5747\u8017\u65f6\uff09\n* \u573a\u666f\uff1a\u5206\u6790\u6bcf\u65e5\u7edf\u8ba1\u6570\u636e\uff0c\u68c0\u67e5\u670d\u52a1\u662f\u5426\u6709\u5f02\u5e38\n* \u793a\u4f8b\uff1a[query_application_im_daily_stats](docs/query_application_im_daily_stats.md)\n\n## query_rtc_room_members/query_rtc_room_members_by_uids\n\n* \u529f\u80fd\uff1a\u67e5\u8be2rtc\u623f\u95f4\u7684\u6210\u5458\u4fe1\u606f\n* \u8bf4\u660e\uff1a\u67e5\u8be2\u4e00\u4e2artc\u623f\u95f4\u4e2d\u7684\u6210\u5458\u4fe1\u606f\uff0c\u53ef\u4ee5\u67e5\u8be2\u6240\u6709\u6210\u5458\uff0c\u4e5f\u53ef\u4ee5\u6307\u5b9auid\u5217\u8868\u67e5\u8be2\u90e8\u5206\u6210\u5458\uff0c\u53ef\u4ee5\u67e5\u8be2\u6210\u5458\u5728\u7ebf\u65f6\u957f\u3001\u6240\u5728\u7684\u5730\u533a\u548c\u8fd0\u8425\u5546\u3001\u8bbe\u5907\u4fe1\u606f\u7b49\n* \u573a\u666f\uff1a\u5206\u6790rtc\u623f\u95f4\u57fa\u672c\u4fe1\u606f\n* \u793a\u4f8b\uff1a[query_rtc_room_members](docs/query_rtc_room_members.md)\n\n## query_rtc_room_stuck_rate/query_rtc_room_user_stuck_rate\n\n* \u529f\u80fd\uff1a\u67e5\u8be2\u623f\u95f4\u97f3\u89c6\u9891\u5361\u987f\u7387\u6307\u6807\uff0c\u53ef\u4ee5\u662f\u623f\u95f4\u7ea7\u522b\u6216\u8005uid\u7ea7\u522b\n* \u8bf4\u660e\uff1a\u67e5\u8be2\u67d0\u4e2a\u6216\u8005\u67d0\u51e0\u4e2a\u623f\u95f4\u7684\u5361\u987f\u7387\n* \u573a\u666f\uff1a\u67e5\u8be2\u623f\u95f4\u5361\u987f\u7387\uff0c\u76d1\u63a7\u7ebf\u4e0a\u670d\u52a1\n* \u793a\u4f8b\uff1a[query_rtc_room_stuck_rate](docs/query_rtc_room_stuck_rate.md)\n\n## query_rtc_room_top_20\n\n* \u529f\u80fd\uff1a\u6309\u7167\u6307\u6807\u83b7\u53d6 Top 20 \u7684\u623f\u95f4\uff0c\u6839\u636e Top 20 \u623f\u95f4\u67e5\u8be2\u8fd1 30 \u5206\u949f\u5176\u5b83\u76f8\u5173\u6307\u6807\n* \u8bf4\u660e\uff1a\u652f\u6301\u6307\u6807\uff1a\u901a\u8bdd\u7528\u6237\u6570\u3001\u7528\u6237\u5e73\u5747\u8fdb\u623f\u65f6\u957f\u3001\u89c6\u9891\u5361\u987f\u7387\u3001\u97f3\u9891\u5361\u987f\u7387\u3001\u97f3\u9891\u7f51\u7edc\u5ef6\u65f6\u3001\u89c6\u9891\u7f51\u7edc\u5ef6\u65f6\n* \u573a\u666f\uff1a\u76d1\u63a7\u7cfb\u7edf\u6574\u4f53\u8fd0\u884c\u72b6\u51b5\n* \u793a\u4f8b\uff1a[query_rtc_room_top_20](docs/query_rtc_room_top_20.md)\n\n## query_rtc_quality_distribution\n\n* \u529f\u80fd\uff1a\u67e5\u8be2\u6307\u6807\u5b9e\u65f6\u591a\u7ef4\u5ea6\u5206\u5e03\n* \u8bf4\u660e\uff1a\u652f\u6301\u7684\u7ef4\u5ea6\uff1a\u64cd\u4f5c\u7cfb\u7edf\u3001\u56fd\u5bb6\u3001\u7701\u4efd\u3001sdk\u7248\u672c\u3001\u7f51\u7edc\uff1b\u652f\u6301\u7684\u6307\u6807\uff1a5s \u8fdb\u623f\u6210\u529f\u7387\u3001\u97f3\u9891\u5361\u987f\u7387\u3001\u89c6\u9891\u5361\u987f\u7387\n* \u573a\u666f\uff1a\u76d1\u63a7\u7cfb\u7edf\u6574\u4f53\u8fd0\u884c\u72b6\u51b5\n* \u793a\u4f8b\uff1a[query_rt_quality_distribution](docs/query_rt_quality_distribution.md)\n\n## query_im_online_connect_latest/query_im_online_connect\n\n* \u529f\u80fd\uff1a\u67e5\u8be2\u5728\u7ebf\u4eba\u6570\n* \u8bf4\u660e\uff1a\u652f\u6301\u67e5\u8be2\u6700\u65b0\u7684\u5728\u7ebf\u4eba\u6570\uff0c\u4e5f\u652f\u6301\u6839\u636e\u65f6\u95f4\u8303\u56f4\u67e5\u8be2\u5728\u7ebf\u4eba\u6570\uff0c\u5141\u8bb8\u67e5\u8be2\u6700\u8fd17\u5929\u7684\u6570\u636e\uff0c\u6bcf\u6b21\u67e5\u8be2\u6700\u591a8\u5c0f\u65f6\n* \u573a\u666f\uff1a\u5206\u6790\u5728\u7ebf\u4eba\u6570\u6ce2\u52a8\u60c5\u51b5\n* \u793a\u4f8b\uff1a[query_online_connect](docs/query_online_connect.md)\n\n## query_im_msg_latest/query_im_msg\n\n* \u529f\u80fd\uff1a\u67e5\u8be2\u4e0a\u4e0b\u884c\u6d88\u606f\u91cf\uff0c1\u5206\u949f\u4e00\u4e2a\u70b9\n* \u8bf4\u660e\uff1a\u652f\u6301\u67e5\u8be2\u6700\u8fd1n\u5206\u949f\u7684\u4e0a\u4e0b\u884c\u6d88\u606f\u91cf\uff0c\u4e5f\u652f\u6301\u6839\u636e\u65f6\u95f4\u8303\u56f4\u67e5\u8be2\u4e0a\u4e0b\u884c\u6d88\u606f\u91cf\uff0c\u5141\u8bb8\u67e5\u8be2\u6700\u8fd17\u5929\u7684\u6570\u636e\uff0c\u6bcf\u6b21\u67e5\u8be2\u6700\u591a8\u5c0f\u65f6\n* \u573a\u666f\uff1a\u5206\u6790\u4e0a\u4e0b\u884c\u6d88\u606f\u7684\u6ce2\u52a8\u60c5\u51b5\n* \u793a\u4f8b\uff1a[query_im_msg](docs/query_im_msg.md)\n\n## query_im_api_stats/query_im_api_stats_last\n\n* \u529f\u80fd\uff1a\u67e5\u8be2api\u8c03\u7528\u60c5\u51b5\uff0c\u5305\u62ec\u8c03\u7528\u6570\u91cf\u3001\u5e73\u5747\u54cd\u5e94\u65f6\u95f4\u3001\u9519\u8bef\u7801\u60c5\u51b5\uff0c1\u5206\u949f\u4e00\u4e2a\u70b9\n* \u8bf4\u660e\uff1a\u652f\u6301\u67e5\u8be2\u6700\u8fd1n\u5206\u949f\u7684api\u8c03\u7528\u60c5\u51b5\uff0c\u4e5f\u652f\u6301\u6839\u636e\u65f6\u95f4\u8303\u56f4\u67e5\u8be2\uff0c\u5141\u8bb8\u67e5\u8be2\u6700\u8fd17\u5929\u7684\u6570\u636e\uff0c\u6bcf\u6b21\u67e5\u8be2\u6700\u591a8\u5c0f\u65f6\uff1b\u652f\u6301\u67e5\u8be2api\u7684\u6574\u4f53\u60c5\u51b5\uff0c\u4e5f\u652f\u6301\u67e5\u8be2\u5355\u4e2a\u63a5\u53e3\u7684\u60c5\u51b5\n* \u573a\u666f\uff1a\u5206\u6790api\u8c03\u7528\u7684\u60c5\u51b5\n* \u793a\u4f8b\uff1a[query_im_api_stats](docs/query_im_api_stats.md)\n\n## query_im_sdk_stats/query_im_sdk_stats_last\n\n* \u529f\u80fd\uff1a\u67e5\u8be2sdk\u8c03\u7528\u60c5\u51b5\uff0c\u5305\u62ec\u8c03\u7528\u6570\u91cf\u3001\u5e73\u5747\u54cd\u5e94\u65f6\u95f4\u3001\u9519\u8bef\u7801\u60c5\u51b5\uff0c1\u5206\u949f\u4e00\u4e2a\u70b9\n* \u8bf4\u660e\uff1a\u652f\u6301\u67e5\u8be2\u6700\u8fd1n\u5206\u949f\u7684sdk\u8c03\u7528\u60c5\u51b5\uff0c\u4e5f\u652f\u6301\u6839\u636e\u65f6\u95f4\u8303\u56f4\u67e5\u8be2\uff0c\u5141\u8bb8\u67e5\u8be2\u6700\u8fd17\u5929\u7684\u6570\u636e\uff0c\u6bcf\u6b21\u67e5\u8be2\u6700\u591a8\u5c0f\u65f6\uff1b\u652f\u6301\u67e5\u8be2api\u7684\u6574\u4f53\u60c5\u51b5\uff0c\u4e5f\u652f\u6301\u67e5\u8be2\u5355\u4e2a\u63a5\u53e3\u7684\u60c5\u51b5(\u76ee\u524d\u652f\u6301\u4ee5\u4e0b\u63a5\u53e3\u7ea7\u522b\u7684\u7edf\u8ba1\uff1a\u767b\u5f55\u3001\u5355\u804a\u6d88\u606f\u3001\u7fa4\u804a\u6d88\u606f\u3001\u7cfb\u7edf\u901a\u77e5\u3001\u804a\u5929\u5ba4\u6d88\u606f)\n* \u573a\u666f\uff1a\u5206\u6790sdk\u8c03\u7528\u7684\u60c5\u51b5\n* \u793a\u4f8b\uff1a[query_im_sdk_stats](docs/query_im_sdk_stats.md)",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "yunxin mcp server to request im/rtc api",
    "version": "0.1.6",
    "project_urls": {
        "Homepage": "https://github.com/netease-im/yunxin-mcp-server"
    },
    "split_keywords": [
        "im",
        " mcp",
        " rtc",
        " yunxin"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b7cc1dad58b8d612bfbe4792dc6404550ecc5367ef319f47f197602466893227",
                "md5": "890ef40672a7849f8489a1db47832ffc",
                "sha256": "0062e212a80b47614153af7e3034aa9d13562aafd945ab2dc4d8c9a5d97dc624"
            },
            "downloads": -1,
            "filename": "vbnmxcz_mcp_server-0.1.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "890ef40672a7849f8489a1db47832ffc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 9470,
            "upload_time": "2025-08-13T09:50:11",
            "upload_time_iso_8601": "2025-08-13T09:50:11.033556Z",
            "url": "https://files.pythonhosted.org/packages/b7/cc/1dad58b8d612bfbe4792dc6404550ecc5367ef319f47f197602466893227/vbnmxcz_mcp_server-0.1.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b5bb7f7c7791d64e59a82b86796323080c9ca7a63beb6792d9e0bdba9e70f00b",
                "md5": "6bfa788ada8090b86d8ad2d4bbdbaa51",
                "sha256": "71a3e179c4f6140d7736bc262a629d8e5752fdbf5095f09897031e1a5ef224a6"
            },
            "downloads": -1,
            "filename": "vbnmxcz_mcp_server-0.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "6bfa788ada8090b86d8ad2d4bbdbaa51",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 3691963,
            "upload_time": "2025-08-13T09:50:40",
            "upload_time_iso_8601": "2025-08-13T09:50:40.021529Z",
            "url": "https://files.pythonhosted.org/packages/b5/bb/7f7c7791d64e59a82b86796323080c9ca7a63beb6792d9e0bdba9e70f00b/vbnmxcz_mcp_server-0.1.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-13 09:50:40",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "netease-im",
    "github_project": "yunxin-mcp-server",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "vbnmxcz-mcp-server"
}
caojiajun
Elapsed time: 0.96789s