Skip to main content
Glama

yunxin-console-mcp

CI npm license

网易云信控制台 MCP Server。官方 yunxin-mcp-server 覆盖的是服务端 IM/RTC API;本项目补全应用后台管理能力:应用管理、AppKey/AppSecret、 回调、证书、推送配置、IM 功能开关、测试账号、敏感词、数字人和统计。

非官方项目:本项目调用云信控制台内部 frontApi,与网易云信无官方关联。 控制台升级后接口可能变化;请仅用于管理你拥有权限的账号,并遵守云信服务条款。

功能

  • 应用管理:应用列表、应用详情、创建/修改应用、AppKey/AppSecret

  • 应用配置:标识管理、推送证书、第三方回调、消息抄送(只读)、IP 白名单、自定义推送、第三方推送分类、功能变更记录

  • IM 管理:完整 IM 配置读取、按字段更新、测试账号、敏感词、安全通/反垃圾、机器人、数字人、存储清理

  • 数据统计:用户增长、地域分布、IM 消息数、群组/聊天室/推送/安全通、功能使用统计

  • 通用兜底:yunxin_api_call 可调用任意 /frontApi 接口,覆盖尚未封装的能力

Related MCP server: Mattermost MCP Server

环境要求

  • Node.js 20+

  • 本机安装 Google Chrome 或 Microsoft Edge(仅首次登录使用)

安装

从 npm 安装:

npx -y @devdengchao/yunxin-console-mcp --version
npm install -g @devdengchao/yunxin-console-mcp

直接从 GitHub 安装(会自动构建):

npx -y github:DevDengChao/yunxin-console-mcp

从源码运行:

git clone https://github.com/DevDengChao/yunxin-console-mcp.git
cd yunxin-console-mcp
npm install
npm run build

首次登录

控制台使用 Cookie 会话。运行一次:

npx -y @devdengchao/yunxin-console-mcp login

会打开一个专用 Chrome 配置窗口。登录成功后会保存 Cookie 到用户配置目录并自动关闭浏览器。 之后 MCP Server 直接使用该会话,不再需要浏览器常驻。

如果不想打开浏览器,也可以从 DevTools 的 Network 面板复制请求头里的 Cookie:

npx -y @devdengchao/yunxin-console-mcp auth import --cookie "cookie1=value1; cookie2=value2"

或者直接在 Network 面板右键请求 → Copy → Copy as cURL,然后粘贴:

npx -y @devdengchao/yunxin-console-mcp auth import --curl "curl 'https://app.yunxin.163.com/frontApi/...' -H 'cookie: ...'"
# 或把内容保存到文件
npx -y @devdengchao/yunxin-console-mcp auth import --curl-file curl.txt

Cookie 很长、Cookie 值里带引号,或者浏览器把 Cookie 拆成多个 cookie: 头时,建议用文件或管道,避免命令行长度和引号问题:

npx -y @devdengchao/yunxin-console-mcp auth import --file cookie.txt
pbpaste | npx -y @devdengchao/yunxin-console-mcp auth import --stdin

--file 会自动识别 raw Cookie 头和 cURL 文本;--curl-file 强制按 cURL 解析。 导入结果会显示“解析 N 个 / 去重后 N 个 / 可发送 N 个”以及首末 Cookie 名称; 如果预期存在的 Cookie(例如 urs_t、urs_u)没有出现在列表里,说明输入可能不完整, 请改用文件或管道重新导入。多个 cookie: 头会自动合并,不会只保留第一个。

检查登录态:

npx -y @devdengchao/yunxin-console-mcp auth status

退出登录:

npx -y @devdengchao/yunxin-console-mcp auth logout

MCP 客户端配置

Claude Desktop / Cursor / OpenCode 等支持 stdio 的客户端:

{
  "mcpServers": {
    "yunxin-console": {
      "command": "npx",
      "args": ["-y", "@devdengchao/yunxin-console-mcp"],
      "env": {
        "YUNXIN_CONSOLE_DEFAULT_APP": "your-app"
      }
    }
  }
}

如果从源码运行,把 command 改为 node,args 改为 ["E:/path/to/yunxin-console-mcp/dist/cli.js"]。

工具列表

工具

作用

yunxin_auth_status

检查登录态、当前账号、企业信息

yunxin_apps_list

应用列表,支持关键字和分页

yunxin_app_get

应用信息 + 产品配置(可选 IM 配置)

yunxin_app_admin

创建/修改应用、应用设置、消息抄送、变更记录、功能矩阵

yunxin_app_keys

查询 AppKey/AppSecret、重置密钥

yunxin_app_identity

iOS/Android/HarmonyOS 标识管理

yunxin_app_cert

APNs/FCM/华为/小米/OPPO/vivo 证书增删改查

yunxin_app_callback

第三方回调地址、超时、默认策略、事件开关

yunxin_app_ip_whitelist

服务端 IP 白名单

yunxin_app_custom_push

自定义推送文案

yunxin_app_third_push

第三方推送消息分类

yunxin_im_config_get

读取完整 IM 配置

yunxin_im_config_update

按字段更新 IM 配置

yunxin_im_user

测试账号列表/创建/更新/封禁/解禁

yunxin_im_lexicon

敏感词/正则词条管理

yunxin_im_antispam

安全通/易盾状态、开关、配置、疑似处理

yunxin_im_robot

机器人管理

yunxin_im_digital_human

数字人和知识库文档

yunxin_im_storage_cleanup

IM 存储清理任务

yunxin_stats_users

用户增长、趋势、地域、实时在线

yunxin_stats_im

IM 消息与相关指标统计

yunxin_stats_app

功能使用和安全通状态统计

yunxin_api_call

调用任意 /frontApi 接口

多数工具使用 action 参数区分读写操作;app 参数支持应用名称或 appid。

安全模型

  • 写操作默认开启。如需只读模式,设置 YUNXIN_CONSOLE_ALLOW_WRITE=false。

  • 删除、重置密钥、封禁、发布、存储清理等破坏性操作必须传 confirm: true。

  • AppSecret 默认打码;需要完整值时显式传 includeSecret: true。

  • 所有非 GET 请求写入本地审计日志,Cookie、AppSecret、Token 等字段自动脱敏。

  • 会话文件 session.json、storage-state.json 在 POSIX 下以 0600 写入,配置目录为 0700; Windows 下依赖用户配置目录自身的 ACL。

  • 多个项目默认共享同一个配置目录。需要隔离登录态时,为每个项目设置不同的 YUNXIN_CONSOLE_HOME。

  • 导入/重新登录后,运行中的 MCP Server 会按会话文件变化自动重载,无需重启客户端。

  • 审计日志默认位于:

    • Windows:%APPDATA%\yunxin-console-mcp\audit.log

    • macOS/Linux:~/.config/yunxin-console-mcp/audit.log

环境变量

变量

默认值

说明

YUNXIN_CONSOLE_HOME

系统配置目录

会话、Chrome 配置和审计日志目录

YUNXIN_CONSOLE_COOKIE

-

直接提供 Cookie,优先于本地会话;支持 Cookie: 前缀和多行格式

YUNXIN_CONSOLE_DEFAULT_APP

-

默认应用名称或 appid

YUNXIN_CONSOLE_ALLOW_WRITE

true

设为 false 进入只读模式

YUNXIN_CONSOLE_TIMEOUT_MS

15000

HTTP 超时时间

YUNXIN_CONSOLE_USER_AGENT

Chrome UA

自定义请求 User-Agent

YUNXIN_CONSOLE_LOGIN_TIMEOUT_MS

1800000

登录等待时间,默认 30 分钟

验证情况

详细记录见 docs/verification.md。账号、应用和数据均已脱敏。

  • 78 个单元/集成测试通过,覆盖 Cookie 会话、cURL 多 header 合并、会话热加载、HTTP 错误映射、应用解析、IM 配置映射、统计日期和审计日志。

  • 已在真实控制台环境跑通只读工具:应用列表、应用详情、IM 配置、测试账号、用户统计、IM 消息统计、应用设置、证书、IP 白名单。

  • 已通过 MCP 工具执行 as-is 无副作用写测试:deletemsgtime、roaming、sendMsgCheckFriend、chatroomIONoNotify、publishoffline、updateInfo 全部返回 res:200,回读配置无变化。

复跑实时只读冒烟:

npm run smoke

已知限制

  • 控制台内部 API 可能随前端升级变化;接口集中在 src/api/,便于修复。

  • 登录态失效后需要重新执行 login,目前不会自动刷新。

  • 消息抄送写操作、IM 总开关映射、数字人新增等少量接口尚未做真实写测试,已标记为待验证。

  • 当前应用下敏感词列表接口返回「参数错误」,控制台页面同样报错;安全通未开通时配置接口会返回未开通提示。

  • 其他产品(RTC、短信、点播、直播、白板、大模型 API)暂未封装专用工具,可通过 yunxin_api_call 调用。

开发

npm install
npm run build
npm test
node dist/cli.js login
node dist/cli.js auth status

发布

发布使用 npm Trusted Publisher + GitHub OIDC,不需要长期 NPM_TOKEN。 首次配置见 docs/release.md。

发布新版本:

npm version patch
git push --follow-tags

License

MIT

Available Tools

23 tools
yunxin_api_callCall any Yunxin console frontApi endpointA
Destructive

直接调用云信控制台内部 /frontApi 接口,用于覆盖尚未封装成专用工具的能力。path 例如 /frontApi/app/queryAppInfo;query 会拼到 URL;body 会以 JSON 发送。写操作(非查询类 POST/PUT/DELETE)必须传 confirm: true。

Inputs: path (required), body, query, method, +1 more.

yunxin_app_adminYunxin app administrationB
Destructive

应用级管理:create 创建应用、update 修改应用名称/行业/简介、settings 查询应用设置、msg_copy 查询消息抄送、change_records 查询功能变更记录、function_matrix 查询功能矩阵。

Inputs: action (required), app, end, data, +5 more.

yunxin_app_callbackManage Yunxin app callbacksA
Destructive

查询或设置第三方回调地址、超时时间、失败默认策略,以及回调事件开关。修改回调会直接影响消息投递,必须 confirm: true。

Inputs: action (required), app, confirm, callbackUrl, +3 more.

yunxin_app_certManage push certificatesB
Destructive

推送证书管理:list 查询证书;add/edit/delete 新增、修改、删除证书。证书类型包括 ios、IOSP8、IOS_PUSHKIT、HARMONY 等。删除证书必须 confirm: true。

Inputs: action (required), app, limit, fields, +3 more.

yunxin_app_custom_pushManage custom push contentB
Destructive

自定义推送文案:list 列表、get 详情、add 新增、update 修改、delete 删除、set_default 设为默认。删除必须 confirm: true。

Inputs: action (required), app, data, params, +1 more.

yunxin_app_getGet Yunxin application detailsA
Read-only

查询单个应用的基本信息、产品配置,可选返回 IM 配置。app 参数支持应用名称(如 DemoApp)或 appid。

Inputs: app, includeConfig, includeImConfig.

yunxin_app_identityManage Yunxin app identifiersA
Destructive

查询或修改 iOS Bundle Identifier、Android Package Name、HarmonyOS Package Name,以及标识安全校验开关。修改标识会影响客户端登录,写入需 confirm: true。

Inputs: action (required), app, data, confirm, +1 more.

yunxin_app_ip_whitelistManage app server IP whitelistB
Destructive

服务端 API IP 白名单:list 列表、status 开关状态、set 覆盖设置、edit 修改单条、delete 删除。写入需 confirm: true。

Inputs: action (required), id, ip, app, +3 more.

yunxin_app_keysManage Yunxin app keysA
Destructive

查询 AppKey/AppSecret,或重置 AppSecret。action=get 查询;set_secret 设置指定密钥;random 随机生成新密钥。重置密钥会让使用旧密钥的客户端失效,必须传 confirm: true。

Inputs: app, action, confirm, appSecret, +1 more.

yunxin_apps_listList Yunxin applicationsA
Read-only

列出当前账号下的云信应用,返回应用名称、appid、已开通产品、套餐和创建时间。支持按名称关键字搜索和分页。

Inputs: limit, offset, keyword.

yunxin_app_third_pushManage third-party push categoriesA
Destructive

第三方推送消息分类配置:get 查询、set 新增/更新、delete 删除。写入需 confirm: true。

Inputs: action (required), app, data, confirm.

yunxin_auth_statusYunxin console login statusA
Read-only

检查云信控制台登录态,返回当前账号、企业信息、默认应用和写操作开关。登录态失效时会给出重新登录提示。

Inputs: no named parameters.

yunxin_im_antispamManage IM anti-spam / YidunA
Destructive

内容安全:status 查询易盾开通状态、open/close 开通/关闭、probation 免费试用、config 查询 IM 安全通配置、suspect 查询疑似处理配置。开关操作需 confirm: true。

Inputs: action (required), app, confirm, productType.

yunxin_im_config_getGet IM configurationA
Read-only

读取应用完整的 IM 配置,包括总开关、鉴权方式、多端登录、撤回时长、漫游、群聊、聊天室、圈组、回调、安全通、推送等字段。

Inputs: app.

yunxin_im_config_updateUpdate IM configurationA
Destructive

按字段更新 IM 配置。只传需要修改的字段,其余保持不变。每个字段会调用后台对应的写接口,并返回逐字段结果。修改服务级开关(如图中 imMainSwitch、callbackUrl)必须传 confirm: true。

Inputs: app, confirm, roaming, kickpolicy, +14 more.

yunxin_im_digital_humanManage IM digital humansB
Destructive

数字人管理:list 列表、get 详情、add 新增、update 修改、delete 删除、rag_list 查询知识库文档、rag_embed 训练文档、rag_delete 删除文档。删除/训练操作需 confirm: true。

Inputs: action (required), app, data, limit, +3 more.

yunxin_im_lexiconManage IM sensitive wordsA
Destructive

敏感词/正则词条管理:list 列表、create 新增、update 修改、delete 删除、fuzzy 模糊查询、publish 发布、thesaurus 查询词库。删除和发布必须 confirm: true。

Inputs: action (required), app, data, limit, +3 more.

yunxin_im_robotManage IM robotsB
Destructive

聊天机器人:list 列表、get 详情、create 新增、update 修改、status 启停。启停必须 confirm: true。channel=1 默认机器人,channel=2 自定义机器人。

Inputs: action (required), app, data, limit, +4 more.

yunxin_im_storage_cleanupManage IM storage cleanup tasksB
Destructive

IM 存储清理:list 任务列表、get 任务详情、create 创建任务、cancel 取消、confirm 确认删除、recover 恢复回收站文件、send_sms 发送验证码。除查询外均需 confirm: true。

Inputs: action (required), app, data, params, +1 more.

yunxin_im_userManage IM test accountsC
Destructive

测试账号管理:list 查询、create 创建、update 更新、block 封禁、unblock 解禁。封禁必须 confirm: true。

Inputs: action (required), app, uid, data, +4 more.

yunxin_stats_appQuery app function usage statisticsC
Read-only

查询应用功能使用情况,以及 IM 安全通检测状态统计。

Inputs: app, includeYidun.

yunxin_stats_imQuery IM message statisticsA
Read-only

IM 统计:按 tab/childTab 查询消息数、群组、聊天室、IM 存储、第三方回调、消息抄送、推送、安全通、圈组等数据。常用 tab=MESSAGE_COUNT,childTab=SINGLE_MESSAGE_COUNT/GROUP_MESSAGE_COUNT/CHATROOM_MESSAGE_COUNT。

Inputs: tab (required), app, end, start, +3 more.

yunxin_stats_usersQuery IM user statisticsA
Read-only

用户统计:day 昨日概览、count 按日/小时趋势、province 省份分布、city 城市分布、realtime 实时在线。日期支持 YYYY-MM-DD 或毫秒时间戳;province/city 的日期为所选自然日。

Inputs: action (required), os, app, end, +6 more.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.6/5.0

    Scored across 23 tools

    Disambiguation4/5

    Most tools target distinct console resources (apps, keys, certificates, callbacks, IM users, lexicon, robots, stats, etc.) and the action subcommands inside each description clarify their scope. A few boundaries are slightly fuzzy, especially yunxin_app_get vs. yunxin_app_admin settings, yunxin_im_config_update callback fields vs. yunxin_app_callback, and the generic yunxin_api_call fallback overlapping all areas.

    Naming Consistency4/5

    The set uses a predictable snake_case pattern with clear domain prefixes such as yunxin_app_, yunxin_im_, and yunxin_stats_. There are minor deviations like singular yunxin_app_get versus plural yunxin_apps_list, and many tools are resource containers with internal action parameters rather than pure verb_noun names.

    Tool Count4/5

    At 23 tools this is a fairly heavy surface, but the server covers a broad Yunxin console domain with many distinct resource areas. Most tools consolidate multiple operations, so the count is reasonable rather than inflated, though it sits near the upper end of comfortable scoping.

    Completeness5/5

    The surface covers app discovery and administration, keys, identity, certificates, callbacks, IP whitelists, push configuration, IM configuration, test users, lexicon, content security, robots, digital humans, storage cleanup, and statistics. The yunxin_api_call tool also provides an explicit escape hatch for operations not yet wrapped, making the set robust and complete for the stated console-management purpose.

    Maintenance

    ActivityNo data
    ResponsivenessOutdated data

    Related MCP Connectors

    Related MCP Servers