Skip to content

Latest commit

 

History

History
190 lines (161 loc) · 7.46 KB

File metadata and controls

190 lines (161 loc) · 7.46 KB

Skills Repository Architecture

This document describes the structure and routing model of the Zoom skills repository.

Overview

The repository has two layers:

  • a packaging layer at repo root for plugin manifests, MCP server definitions, and editor rules
  • an installable skill tree under skills/

Within the skill tree, the repository uses a hub-and-spoke model:

  • general is the hub for routing and cross-product guidance.
  • Product folders are spokes with product-specific SKILL.md files and deeper references/examples.
  • SKILL.md is the canonical entry file per skill directory.

See also: skills/SKILL.md

Packaging Layer

repo root
  -> .claude-plugin/       Claude plugin metadata
  -> .cursor-plugin/       Cursor marketplace-style metadata
  -> .cursor/rules/        Cursor behavioral rules for this repo
  -> .mcp.json             bundled Zoom MCP server endpoints
  -> skills/               canonical skill content

Consumer model:

  • Claude Code: plugin install via .claude-plugin/ and skills/
  • Cline / BLACKBOX AI: copy skill directories from skills/ into their native skill folders
  • Roo Code / Kilo Code: adapt skills/ content into modes/rules; add Zoom MCP servers separately
  • Cursor-style consumers: use .cursor/rules/, editor instructions, and .mcp.json

Hub-and-Spoke Routing

User request
  -> general/SKILL.md (intent routing)
  -> product SKILL.md (implementation path)
  -> references/examples/troubleshooting (deep detail)

Common route outcomes:

  • API management flows -> rest-api
  • General AI-driven Zoom search, meeting assets, recording resources, Docs, and Hub content -> zoom-mcp
  • Whiteboard-specific MCP workflows -> zoom-mcp/whiteboard
  • Team Chat MCP workflows -> zoom-mcp/team-chat
  • Meeting search/assets/recordings through dedicated MCP -> zoom-mcp/meetings
  • Zoom Docs creation/retrieval through dedicated MCP -> zoom-mcp/docs
  • Task management through MCP -> zoom-mcp/tasks
  • Revenue Accelerator intelligence through MCP -> zoom-mcp/revenue-accelerator
  • Enterprise AI systems requiring stable API core + AI tool layer -> rest-api + zoom-mcp
  • Event notifications -> webhooks or websockets
  • Embedded meetings -> meeting-sdk
  • Custom video sessions -> video-sdk
  • Native desktop control of installed Zoom Workplace -> plugin-sdk
  • In-client apps -> zoom-apps-sdk
  • Uploaded/stored media transcription -> scribe
  • Transcript summarization and action items -> summarizer
  • Plain-text and batch file translation -> translator
  • Live media streams -> rtms
  • Contact Center -> contact-center
  • Virtual Agent web/mobile chat and KB sync -> virtual-agent
  • Phone integrations -> phone
  • Rivet server integrations -> rivet-sdk
  • Pre-join diagnostics/readiness -> probe-sdk

Directory Structure

repo/
├── .claude-plugin/
├── .cursor/
│   └── rules/
├── .cursor-plugin/
├── .mcp.json
├── README.md
├── ARCHITECTURE.md
├── CONTRIBUTING.md
├── RUNBOOK.md
├── skills/
│   ├── SKILL.md
│   ├── general/
│   ├── rest-api/
│   ├── webhooks/
│   ├── websockets/
│   ├── meeting-sdk/
│   ├── video-sdk/
│   ├── plugin-sdk/
│   │   ├── macos/
│   │   └── windows/
│   ├── zoom-apps-sdk/
│   ├── scribe/
│   ├── summarizer/
│   ├── translator/
│   ├── rtms/
│   ├── team-chat/
│   ├── contact-center/
│   ├── virtual-agent/
│   ├── phone/
│   ├── rivet-sdk/
│   ├── probe-sdk/
│   ├── ui-toolkit/
│   ├── cobrowse-sdk/
│   ├── oauth/
│   ├── zoom-mcp/
│   │   ├── whiteboard/
│   │   ├── team-chat/
│   │   ├── meetings/
│   │   ├── docs/
│   │   ├── tasks/
│   │   └── revenue-accelerator/
│   └── ...
└── tools/

Platform-heavy spokes (examples):

  • meeting-sdk: web, android, ios, macos, unreal, electron, react-native, linux, windows
  • video-sdk: web, android, ios, macos, unity, react-native, flutter, linux, windows
  • plugin-sdk: macos, windows
  • contact-center: common + android + ios + web
  • virtual-agent: common + android + ios + web (campaign/chat + WebView bridges)

Design Principles

  1. One entry file per skill directory
  • Use SKILL.md as the canonical entrypoint.
  • Keep SKILL.md focused on routing, lifecycle, and key links.
  1. Progressive disclosure
  • Keep high-level guidance in SKILL.md.
  • Put depth in references/, examples/, concepts/, and troubleshooting/.
  1. Link integrity
  • Every .md should be reachable from a parent SKILL.md or index-like parent doc.
  • Prefer relative repository links; avoid machine-local absolute paths.
  1. Cross-skill chaining
  • Put multi-product workflows in general/use-cases/.
  • Link chained skills explicitly from those use cases.
  1. Packaging separation
  • Keep repo-root packaging metadata separate from the installable skill tree.
  • Treat skills/ as the canonical source for portable skill content.
  • Keep editor-specific adapters thin; they should point back to skills/, not fork the content.

Product Skill Summary

Skill Purpose
general Hub routing and cross-product patterns
rest-api Zoom REST API operations
webhooks HTTP event ingestion
websockets Persistent event streams
meeting-sdk Embed Zoom meetings in apps
video-sdk Build custom video session experiences
plugin-sdk Control installed Zoom Workplace from native macOS/Windows companion apps over IPC
zoom-apps-sdk Build apps inside Zoom client surfaces
scribe Zoom AI Services Scribe for synchronous and batch transcription of uploaded or stored media
summarizer Zoom AI Services Summarizer for transcript recaps, summaries, and action items
translator Zoom AI Services Translator for plain-text and batch file translation
rtms Real-time media streams
team-chat Team Chat integrations
contact-center Contact Center app/web/mobile integrations
virtual-agent Virtual Agent web/mobile chat embeds and knowledge-base sync patterns
phone Phone APIs, Smart Embed, URI/webhook flows
rivet-sdk Rivet JavaScript server framework for auth, events, and API wrappers
probe-sdk Browser/device/network readiness diagnostics before meeting/video join
ui-toolkit Prebuilt Video SDK UI components
cobrowse-sdk Collaborative browsing support flows
oauth Auth flows and token models
zoom-mcp Parent routing and the default 9-tool Zoom MCP server
zoom-mcp/whiteboard Whiteboard MCP endpoints, scopes, auth findings, ID mapping, and live Whiteboard tool workflows
zoom-mcp/team-chat Team Chat read/search/write tools for messages, files, contacts, sessions, and channels
zoom-mcp/meetings Meeting search, assets, recordings, and recording resources
zoom-mcp/docs Zoom Docs Markdown creation and retrieval
zoom-mcp/tasks Tasks, comments, assignees, collaborators, and task steps
zoom-mcp/revenue-accelerator ZRA conversations, transcripts, analyses, deals, customers, and coaching data

Maintenance Notes

  • Use tools/md-audit/md_audit.py to validate links/orphans after large doc changes.
  • Keep naming/folder conventions aligned with skills/SKILL.md.
  • Update architecture references when adding/removing product folders.