关键词

Zoom API会议管理用户管理聊天通讯API集成

使用说明

项目简介

本项目 'Zoom API MCP Server' 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为大型语言模型 (LLM) 应用提供访问 Zoom API 的标准化接口。通过 MCP 协议，LLM 客户端可以安全、便捷地调用 Zoom 的各项功能，例如创建会议、管理用户、发送聊天消息等，从而扩展 LLM 应用在会议协作和通讯领域的应用场景。

主要功能点

  • 全面的 Zoom API 覆盖: 支持 Zoom API 的多个核心模块，包括会议、用户、网络研讨会、账户、聊天、电话、联系人、录制、报告、Webhook 和 Zoom Rooms 等，几乎涵盖了 Zoom API 的所有常用功能。
  • 工具化封装: 将 Zoom API 的各种功能封装成易于 LLM 调用的“工具 (Tools)”，每个工具都定义了清晰的参数 schema 和描述，方便 LLM 理解和使用。
  • 资源化文档: 以“资源 (Resources)”的形式提供 Zoom API 的文档，LLM 可以通过标准化的 URI 访问 API 文档，例如 'zoom-api://meetings' 可以获取会议 API 的文档。
  • OAuth 2.0 鉴权: 内置 OAuth 2.0 鉴权机制，自动处理与 Zoom API 的身份验证，确保访问安全。
  • 结构化响应: 所有 API 调用都返回结构化的 JSON 响应，并包含清晰的错误处理机制，方便 LLM 应用解析和处理。

安装步骤

  1. 克隆仓库： 
    git clone https://github.com/mattcoatsworth/zoom-mcp-server.git
cd zoom-mcp-server
  2. 安装依赖： 确保已安装 Node.js 16+ 和 npm，然后运行命令安装项目依赖： 
    npm install
  3. 配置环境变量： 在项目根目录下创建 '.env' 文件，并填入您的 Zoom API 凭证。您需要在 Zoom App Marketplace 创建一个 Server-to-Server OAuth 应用来获取这些凭证。 
    ZOOM_CLIENT_ID=您的_Client_ID
ZOOM_CLIENT_SECRET=您的_Client_Secret
ZOOM_ACCOUNT_ID=您的_Account_ID
    请将 '您的_Client_ID', '您的_Client_Secret', '您的_Account_ID' 替换为您在 Zoom App Marketplace 获取的实际凭证。

服务器配置

MCP 客户端需要以下配置信息才能连接到 'Zoom API MCP Server'。请将以下 JSON 配置添加到您的 MCP 客户端配置中。

{
  "serverName": "Zoom API",
  "command": "npm run dev",
  "args": [],
  "description": "连接到 Zoom API MCP 服务器，通过工具和资源访问 Zoom 功能。",
  "env": {
    "ZOOM_CLIENT_ID": "您的 Zoom Client ID",
    "ZOOM_CLIENT_SECRET": "您的 Zoom Client Secret",
    "ZOOM_ACCOUNT_ID": "您的 Zoom Account ID"
  },
  "transport": "stdio"
}

配置参数说明:

  • 'serverName': 服务器名称，这里设置为 "Zoom API"。
  • 'command': 启动服务器的命令，这里使用 'npm run dev' 运行开发服务器。
  • 'args': 启动命令的参数，本项目启动命令无需额外参数，所以为空数组 '[]'。
  • 'description': 对该服务器配置的描述，方便用户理解其用途。
  • 'env': 环境变量配置。请注意： 虽然这里可以配置环境变量，但更推荐在服务器端 '.env' 文件中配置 'ZOOM_CLIENT_ID', 'ZOOM_CLIENT_SECRET', 和 'ZOOM_ACCOUNT_ID'，以提高安全性，避免凭证泄露在客户端配置中。这里仅作为示例展示，请务必移除或修改为占位符，并在服务器端正确配置 '.env' 文件。
  • 'transport': 传输协议，本项目使用 'stdio'，即标准输入输出流进行通信。

注意: 请确保 MCP 客户端能够执行 'npm run dev' 命令，或者根据您的实际部署环境修改 'command' 和 'args' 配置。

基本使用方法

  1. 启动服务器： 在项目根目录下运行以下命令启动 MCP 服务器：

    npm run dev

    服务器成功启动后，会通过标准输出 (stdout) 打印 "Starting Zoom API MCP server..." 信息。

  2. 在 MCP 客户端中使用：

    • 配置您的 MCP 客户端，添加上述 “服务器配置” 中的 JSON 内容。
    • 客户端成功连接到服务器后，即可使用以下功能：
      • 访问 API 文档资源: 使用 'zoom-api://{category}' 格式的 URI 访问 Zoom API 各个模块的文档，例如 'zoom-api://meetings' 获取会议 API 文档。
      • 调用 Zoom API 工具: 通过 MCP 客户端调用预定义的工具 (Tools)，例如 'list_meetings' (列出会议), 'create_user' (创建用户) 等。每个工具的具体参数和使用方法请参考工具的 schema 和描述信息。

    例如，您可以使用 MCP 客户端发送 JSON-RPC 请求来调用 'list_users' 工具，以获取 Zoom 账户中的用户列表。具体的请求格式和参数请参考 MCP 协议和工具的 schema 定义。

请参考 Model Context Protocol (MCP) 官方文档 了解更多关于 MCP 协议和客户端使用的信息。

信息

分类

通信与社交

访问项目