zoom-mcp

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Zoom MCP

Zoom MCP

Guidance for the bundled Zoom MCP connector in this Claude plugin. Prefer
design-mcp-workflow
or setup-zoom-mcp first, then route here for tool-surface details, auth expectations, and MCP-specific constraints.
本Claude插件中捆绑的Zoom MCP连接器使用指南。请优先使用
design-mcp-workflow
setup-zoom-mcp,之后可跳转至此处查看工具层面详情、认证要求及MCP特定约束。

Zoom MCP Server

Zoom MCP Server

This plugin bundles Zoom's hosted MCP server at
mcp-us.zoom.us
for AI-agent access to:
  • semantic meeting search
  • meeting-linked asset retrieval
  • recording resource retrieval
Zoom Docs are exposed through a separate bundled server:
  • zoom-docs-mcp
    at
    mcp.zoom.us
  • purpose-built for Zoom Docs creation and retrieval
Current tool names from the main Zoom MCP server:
  • get_meeting_assets
  • search_meetings
  • get_recording_resource
  • recordings_list
Some MCP clients namespace server tools in the UI, for example
zoom-mcp:recordings_list
. Treat the raw tool names above as authoritative.
Zoom Docs-specific MCP work should use the dedicated
zoom-docs-mcp
server.
Whiteboard-specific MCP work is covered by the dedicated skill whiteboard/SKILL.md.
本插件捆绑了Zoom托管的MCP服务器
mcp-us.zoom.us
,可让AI Agent访问以下能力:
  • 语义会议搜索
  • 会议关联资产检索
  • 录制文件资源检索
Zoom Docs通过单独的捆绑服务器提供服务:
  • 部署在
    mcp.zoom.us
    zoom-docs-mcp
  • 专为Zoom Docs的创建和检索设计
主Zoom MCP服务器当前提供的工具名称:
  • get_meeting_assets
  • search_meetings
  • get_recording_resource
  • recordings_list
部分MCP客户端会在UI中对服务器工具添加命名空间,例如
zoom-mcp:recordings_list
。以上原始工具名称为权威定义。
Zoom Docs专属的MCP操作请使用专用的
zoom-docs-mcp
服务器。
白板专属的MCP操作由专用技能whiteboard/SKILL.md提供支持。

Quick Start

快速开始

1. Export the token expected by the bundled connector:
bash
export ZOOM_MCP_ACCESS_TOKEN="your_zoom_user_oauth_access_token"
2. Enable or restart the plugin so Claude restarts the bundled MCP server definition.
3. Verify discovery:
  • Confirm the client can see
    recordings_list
    ,
    search_meetings
    ,
    get_meeting_assets
    , and
    get_recording_resource
    .
  • If the client exposes raw protocol inspection,
    tools/list
    is the authoritative discovery source.
  • The current catalog is documented in references/tools.md.
4. Run the first useful call:
text
recordings_list
  userId: "me"
  from: "2026-03-01"
  to: "2026-03-06"
  page_size: 10
1. 导出捆绑连接器所需的令牌:
bash
export ZOOM_MCP_ACCESS_TOKEN="your_zoom_user_oauth_access_token"
2. 启用或重启插件,让Claude重新加载捆绑的MCP服务器定义。
3. 验证服务发现:
  • 确认客户端可以识别
    recordings_list
    search_meetings
    get_meeting_assets
    get_recording_resource
  • 如果客户端支持原始协议检查,
    tools/list
    是权威的服务发现来源。
  • 当前的工具目录记录在references/tools.md中。
4. 执行首次有效调用:
text
recordings_list
  userId: "me"
  from: "2026-03-01"
  to: "2026-03-06"
  page_size: 10

Critical Notes

重要注意事项

1. User OAuth is the documented execution path
Use a General app with user-level OAuth as the execution path for Zoom MCP tool use in this plugin. Do not rely on Server-to-Server OAuth as a supported MCP auth model here.
2. Zoom MCP uses MCP-specific granular scopes
The Zoom MCP scope set is not the same as the older broad REST scopes. The key scopes for the main Zoom MCP server are:
  • ai_companion:read:search
    — Search across Zoom Meeting, Zoom Chat, and Zoom Doc, returning the most relevant results based on the query
  • meeting:read:search
    — Search and view meetings
  • meeting:read:assets
    — View a meeting's assets
  • cloud_recording:read:list_user_recordings
    — Lists all cloud recordings for a user.
  • cloud_recording:read:content
    — read recording content scope
  • docs:write:import
    — Create a new file by import
  • docs:read:export
    — Read file content in Markdown format
For Zoom Docs MCP specifically, the official docs page shows these granular scopes for the documented tools:
  • docs:write:import
    — Create a new file by import
  • docs:read:export
    — Read file content in Markdown format
3. AI Companion features are feature prerequisites, not scope substitutes
Semantic meeting search, meeting assets, and recording-content retrieval depend on account features such as Smart Recording and Meeting Summary for useful results. These feature settings do not replace the required OAuth scopes.
4. Whiteboard is a separate MCP surface
The Zoom MCP endpoint and the Whiteboard MCP endpoint are separate. Route Whiteboard-specific requests to whiteboard/SKILL.md.
5. Use REST for deterministic meeting CRUD
The current Zoom MCP tool surface does not expose deterministic meeting create, update, or delete tools. If the user needs explicit meeting CRUD operations, route to ../rest-api/SKILL.md.
1. 用户OAuth是官方指定的执行路径
请使用带有用户级OAuth通用应用作为本插件中Zoom MCP工具调用的执行路径。不支持服务端到服务端OAuth作为MCP认证模型。
2. Zoom MCP使用MCP专属的细粒度权限范围
Zoom MCP的权限范围集与旧的广泛REST权限范围不同。主Zoom MCP服务器的核心权限范围包括:
  • ai_companion:read:search
    — 跨Zoom会议、Zoom聊天和Zoom Doc搜索,根据查询返回最相关的结果
  • meeting:read:search
    — 搜索和查看会议
  • meeting:read:assets
    — 查看会议资产
  • cloud_recording:read:list_user_recordings
    — 列出用户的所有云录制文件
  • cloud_recording:read:content
    — 读取录制内容的权限范围
  • docs:write:import
    — 通过导入创建新文件
  • docs:read:export
    — 读取Markdown格式的文件内容
针对Zoom Docs MCP,官方文档页面列出了其工具对应的细粒度权限范围:
  • docs:write:import
    — 通过导入创建新文件
  • docs:read:export
    — 读取Markdown格式的文件内容
3. AI Companion功能是前置要求,不能替代权限范围
语义会议搜索、会议资产和录制内容检索依赖于账户的智能录制会议摘要等功能才能返回有效结果。这些功能设置不能替代所需的OAuth权限范围。
4. 白板是独立的MCP服务面
Zoom MCP端点和白板MCP端点是相互独立的。请将白板专属请求路由到whiteboard/SKILL.md
5. 确定性的会议CRUD操作请使用REST
当前Zoom MCP的工具能力不提供确定性的会议创建、更新或删除工具。如果用户需要明确的会议CRUD操作,请路由到../rest-api/SKILL.md

Server Endpoints

服务器端点

TransportURL
Streamable HTTP (recommended)
https://mcp-us.zoom.us/mcp/zoom/streamable
SSE (fallback)
https://mcp-us.zoom.us/mcp/zoom/sse
Dedicated Docs MCP server:
TransportURL
Streamable HTTP (recommended)
https://mcp.zoom.us/mcp/docs/streamable
SSE (fallback)
https://mcp.zoom.us/mcp/docs/sse
Dedicated Whiteboard MCP skill:
  • whiteboard/SKILL.md
传输协议URL
可流式HTTP(推荐)
https://mcp-us.zoom.us/mcp/zoom/streamable
SSE(备选)
https://mcp-us.zoom.us/mcp/zoom/sse
专用Docs MCP服务器:
传输协议URL
可流式HTTP(推荐)
https://mcp.zoom.us/mcp/docs/streamable
SSE(备选)
https://mcp.zoom.us/mcp/docs/sse
专用白板MCP技能:
  • whiteboard/SKILL.md

Search and Retrieval Model

搜索与检索模型

search_meetings
uses AI Companion retrieval rather than a plain metadata filter. In this use the live MCP server as authoritative for response schema and scope behavior.
Two result families matter most:
  • Recap-oriented results: AI summary, meeting-linked documents, recordings, and related assets
  • Recording-oriented results: cloud recording references and transcript-capable resources
Use examples/transcript-retrieval.md for the main retrieval workflow.
search_meetings
使用AI Companion检索而非纯元数据过滤。在这种使用场景下,线上MCP服务器是响应 schema 和权限行为的权威来源。
最核心的两类结果:
  • 摘要类结果:AI总结、会议关联文档、录制文件及相关资产
  • 录制类结果:云录制引用和支持转录的资源
主检索工作流可参考examples/transcript-retrieval.md

Tool Catalog

工具目录

ToolKey ParametersRequired Scope
get_meeting_assets
meetingId
*
meeting:read:assets
search_meetings
q
,
from
,
to
,
page_size
,
next_page_token
meeting:read:search
get_recording_resource
meetingId
*,
types
,
clip_num
,
play_time
,
raw_passcode
,
encode_passcode
cloud_recording:read:content
recordings_list
userId
*,
from
,
to
,
meeting_id
,
trash
,
trash_type
,
page_size
,
next_page_token
cloud_recording:read:list_user_recordings
* Required parameter
Full parameter and output guidance: references/tools.md
工具核心参数所需权限范围
get_meeting_assets
meetingId
*
meeting:read:assets
search_meetings
q
,
from
,
to
,
page_size
,
next_page_token
meeting:read:search
get_recording_resource
meetingId
*,
types
,
clip_num
,
play_time
,
raw_passcode
,
encode_passcode
cloud_recording:read:content
recordings_list
userId
*,
from
,
to
,
meeting_id
,
trash
,
trash_type
,
page_size
,
next_page_token
cloud_recording:read:list_user_recordings
* 为必填参数
完整的参数和输出说明:references/tools.md

Key Workflows

核心工作流

Search meeting content, then retrieve assets:
text
search_meetings
  q: "Q4 planning discussion"
  from: "2026-03-01"
  to: "2026-03-06"
→ choose a returned meeting
→ get_meeting_assets  meetingId: "MEETING_ID_OR_UUID"
List recordings, then retrieve recording resources:
text
recordings_list
  userId: "me"
  from: "2026-03-01"
  to: "2026-03-06"
→ choose a recording target
→ get_recording_resource  meetingId: "MEETING_UUID_OR_RECORDING_ID"
Create or fetch a Zoom Doc:
  • use the dedicated
    zoom-docs-mcp
    server rather than the main
    zoom-mcp
    server
  • official documented tools on the Zoom Docs MCP page are:
    • create_file_with_content
    • get_file_content
搜索会议内容,然后检索资产:
text
search_meetings
  q: "Q4 planning discussion"
  from: "2026-03-01"
  to: "2026-03-06"
→ 选择返回的某个会议
→ get_meeting_assets  meetingId: "MEETING_ID_OR_UUID"
列出录制文件,然后检索录制资源:
text
recordings_list
  userId: "me"
  from: "2026-03-01"
  to: "2026-03-06"
→ 选择目标录制文件
→ get_recording_resource  meetingId: "MEETING_UUID_OR_RECORDING_ID"
创建或获取Zoom Doc:
  • 请使用专用的
    zoom-docs-mcp
    服务器而非主
    zoom-mcp
    服务器
  • Zoom Docs MCP页面官方记录的工具为:
    • create_file_with_content
    • get_file_content

Error Reference

错误参考

CodeMeaningFix
401 Unauthorized
Missing or rejected bearer token at the endpointSet
ZOOM_MCP_ACCESS_TOKEN
, then restart Claude or re-enable the plugin
-32001 Invalid access token
Token expired, malformed, or missing required scopesRefresh OAuth token and verify the MCP-specific scopes
-32602 Can not found tool
Requested tool name is not exposed by the active MCP serverRe-run
tools/list
and use the current tool names for that endpoint
404
Possible downstream resource-not-found responseRe-discover the target with
search_meetings
or
recordings_list
Full error reference: references/error-codes.md
错误码含义解决方案
401 Unauthorized
端点缺少Bearer令牌或令牌被拒绝设置
ZOOM_MCP_ACCESS_TOKEN
,然后重启Claude或重新启用插件
-32001 Invalid access token
令牌过期、格式错误或缺少所需权限范围刷新OAuth令牌并验证MCP专属权限范围是否正确配置
-32602 Can not found tool
请求的工具名称未被当前激活的MCP服务器暴露重新执行
tools/list
并使用对应端点当前的工具名称
404
可能是下游资源未找到的响应使用
search_meetings
recordings_list
重新发现目标资源
完整错误参考:references/error-codes.md

Documentation

文档

Concepts

概念

  • concepts/mcp-architecture.md — MCP protocol, hosted endpoints, discovery, and capability model
  • concepts/oauth-setup.md — OAuth app creation, MCP-specific scopes, AI Companion prerequisites, token lifecycle
  • concepts/mcp-architecture.md — MCP协议、托管端点、服务发现和能力模型
  • concepts/oauth-setup.md — OAuth应用创建、MCP专属权限范围、AI Companion前置要求、令牌生命周期

Examples

示例

  • examples/transcript-retrieval.md — Search/assets and recording-resource workflows
  • examples/create-zoom-doc.md — Verified Zoom Docs creation flow
  • examples/search-and-act.md — Search, inspect assets, and hand off CRUD work to REST when needed
  • examples/meeting-lifecycle.md — Why meeting CRUD belongs in REST, plus the MCP-to-REST handoff pattern
  • examples/transcript-retrieval.md — 搜索/资产和录制资源工作流
  • examples/create-zoom-doc.md — 经过验证的Zoom Docs创建流程
  • examples/search-and-act.md — 搜索、检查资产,必要时将CRUD工作移交到REST
  • examples/meeting-lifecycle.md — 为什么会议CRUD适合通过REST实现,以及MCP到REST的移交模式

References

参考

  • references/tools.md — Current Zoom MCP tool reference
  • references/error-codes.md — MCP and Zoom API errors with fixes
  • whiteboard/SKILL.md — Dedicated Whiteboard MCP skill
  • references/tools.md — 当前Zoom MCP工具参考
  • references/error-codes.md — MCP和Zoom API错误及解决方案
  • whiteboard/SKILL.md — 专用白板MCP技能

Troubleshooting

故障排查

  • troubleshooting/common-errors.md — Scope failures, endpoint mixups, search/recording issues
  • troubleshooting/common-errors.md — 权限失败、端点混淆、搜索/录制问题

Operations

运维

  • RUNBOOK.md — 5-minute preflight and debugging checklist
  • RUNBOOK.md — 5分钟预检查和调试清单

Related Skills

相关技能

  • zoom-rest-api — Deterministic REST API access, including meeting CRUD
  • zoom-oauth — OAuth implementation patterns
  • zoom-webhooks — Event-driven recording and meeting workflows
  • zoom-rtms — Live media and transcript streams during active meetings
  • zoom-rest-api — 确定性REST API访问,包括会议CRUD
  • zoom-oauth — OAuth实现模式
  • zoom-webhooks — 事件驱动的录制和会议工作流
  • zoom-rtms — 活跃会议期间的实时媒体和转录流