AutoGineer
Generated banner for Probe SDK
Generated logo for Probe SDK

Probe SDK

AnthropicOfficialCreated by ZoomDistributed by Anthropic

  • Skill
  • Tool integration
  • Software development
  • MIT
  • No issues found
Download ZIP

From the author

Reference skill for Zoom Probe SDK. Use after routing to a preflight workflow when testing browser compatibility, media permissions, audio or video diagnostics, and network readiness before users join.
— the description by Zoom

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

The Zoom Probe SDK skill provides a structured approach to implementing pre-join diagnostic checks. It enables developers to verify browser capabilities, media device permissions, and network readiness before initiating a meeting or video session. By utilizing the Prober and Reporter classes, developers can create custom diagnostic pages that capture structured reports, ensuring users have a stable environment before joining live sessions.

What it does

  • Initializes Prober and Reporter instances for diagnostic workflows.
  • Requests and validates user media permissions and device enumeration.
  • Executes targeted audio and video diagnostic tests.
  • Performs comprehensive network readiness diagnostics.
  • Generates structured diagnostic reports for troubleshooting.
  • Manages resource cleanup including media stream release.

When to use it

  • When building a pre-join diagnostic page for meeting or video applications.
  • When you need to verify browser compatibility for advanced media features.
  • When implementing device certification flows for kiosks or controlled environments.
  • When capturing structured diagnostic data to assist in customer troubleshooting.

Advantages

  • Lightweight implementation requiring no OAuth credentials for core diagnostics.
  • Provides clear readiness gating to improve user experience before joining sessions.
  • Supports structured reporting for easier technical support and debugging.
  • Integrates seamlessly with broader meeting and video SDK workflows.

Usage examples

“How do I start a network diagnostic check using the Probe SDK?”
Initialize the Prober instance and call the startToDiagnose method to begin the network test, then stream the results to your UI.
“What is the correct way to clean up after running diagnostics?”
Ensure you call stopToDiagnose, stopToDiagnoseVideo, releaseMediaStream, and finally the cleanup method to properly free resources.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/anthropics/probe-sdk/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip probe-sdk.zip -d .agents/skills

Documentation by Zoom

Zoom Probe SDK

Background reference for preflight diagnostics on user devices and networks before meeting or session workflows.

Official docs:

Reference sample:

Routing Guardrail

  • Use Probe SDK when the user needs client-side diagnostics and readiness scoring (device/network/browser capability), not meeting/session join.

  • If user needs embedded meeting flows, route to ../meeting-sdk/SKILL.md.

  • If user needs custom real-time session UX, route to ../video-sdk/SKILL.md.

  • If user needs backend orchestration of events/APIs, chain with ../rivet-sdk/SKILL.md, ../oauth/SKILL.md, and ../rest-api/SKILL.md.

Quick Links

Start here:

  1. probe-sdk.md

  2. concepts/architecture-and-lifecycle.md

  3. scenarios/high-level-scenarios.md

  4. examples/diagnostic-page-pattern.md

  5. examples/comprehensive-network-pattern.md

  6. references/probe-reference-map.md

  7. references/environment-variables.md

  8. references/versioning-and-compatibility.md

  9. references/samples-validation.md

  10. references/source-map.md

  11. troubleshooting/common-issues.md

  12. RUNBOOK.md

Common Lifecycle Pattern

  1. Initialize Prober / Reporter.

  2. Request media permissions and enumerate devices.

  3. Run targeted diagnostics (diagnoseAudio, diagnoseVideo).

  4. Run comprehensive network diagnostic (startToDiagnose) and stream stats to UI.

  5. Produce final report and apply readiness gates.

  6. Stop/cleanup (stopToDiagnose, stopToDiagnoseVideo, releaseMediaStream, cleanup).

High-Level Scenarios

  • Pre-join diagnostics page before Meeting SDK join action.

  • Support workflow that captures structured report for customer troubleshooting.

  • Device certification flow for kiosk or controlled endpoint environments.

  • Browser capability gating for advanced media features.

See scenarios/high-level-scenarios.md for details.

Chaining

  • Meeting pre-join gate: ../meeting-sdk/web/SKILL.md

  • Video session readiness gate: ../video-sdk/web/SKILL.md

  • Telemetry/report ingestion backend: ../rivet-sdk/SKILL.md + ../rest-api/SKILL.md

Environment Variables

Operations

  • RUNBOOK.md - 5-minute preflight and debugging checklist.

Files

RUNBOOK.md

Probe SDK 5-Minute Preflight Runbook

Use this before deep debugging.

Skill Doc Standard Note

  • Skill entrypoint is SKILL.md.

  • This runbook is an operational convention (recommended), not a required skill file.

  • API/option naming can drift by version; validate against current Probe SDK reference.

1) Confirm Integration Surface

  • Confirm this is a web diagnostics use case, not meeting/session join runtime.

  • Confirm whether you need only device checks, only network checks, or full diagnostics.

  • Confirm renderer target strategy (video-tag or canvas-based renderer).

2) Confirm Required Inputs

  • No Zoom Marketplace credentials are required for core Probe SDK diagnostics.

  • Device IDs are required for explicit audio input/output and camera diagnostics.

  • For comprehensive network diagnostics, verify optional JS/WASM URL override strategy.

3) Confirm Lifecycle Order

  1. requestMediaDevicePermission().

  2. requestMediaDevices().

  3. diagnoseAudio(...) / diagnoseVideo(...).

  4. startToDiagnose(jsUrl, wasmUrl, config, statsListener).

  5. stopToDiagnose* and cleanup() on exit.

4) Confirm Event/State Handling

  • Keep stream lifecycle explicit (releaseMediaStream).

  • Keep stats callback lightweight and avoid blocking UI thread.

  • Persist final report snapshot before cleanup.

5) Confirm Cleanup + Upgrade Posture

  • Always stop active diagnostics before page unload/navigation.

  • Re-check renderer option naming and report field names on upgrades.

  • Re-check browser compatibility assumptions against current docs.

6) Quick Probes

  • Permissions prompt appears and resolves expectedly.

  • Devices list includes expected microphone/speaker/camera.

  • Video diagnostic renders to selected target.

  • Network diagnostic emits stats and final report.

7) Fast Decision Tree

  • No media diagnostics -> permissions denied or insecure context.

  • Video diagnostics fail -> renderer/target mismatch or unsupported renderer type.

  • Network diagnostic incomplete -> timeout/domain/config mismatch.

  • Report schema mismatch -> version drift between docs and installed package.

8) Source Checkpoints

Official docs
Raw docs in repo

  • tools/zoom-crawler/raw-docs/developers.zoom.us/docs/probe-sdk/

  • tools/zoom-crawler/raw-docs/marketplacefront.zoom.us/sdk/probe/

Requirements and compatibility

Written for: Claude Code, Claude apps

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Claude Code frontmatter

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
Zoom
Publisher
Anthropic (Official)
Distributed by
Anthropic
Source
anthropics/knowledge-work-plugins · partner-built/zoom-plugin/skills/probe-sdk · commit e050c2e
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from partner-built/zoom-plugin/LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Zoom or Anthropic.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download probe-sdk.zip