Probe Sdk
Run a five-minute Probe SDK preflight before deep debugging web audio, video, and network diagnostics integrations.
Overview
probe-sdk is an agent skill most often used in Ship (also Build integrations) that runs a 5-minute Zoom Probe SDK preflight for permissions, lifecycle, and cleanup before deep debugging.
Install
npx skills add https://github.com/anthropics/knowledge-work-plugins --skill probe-sdkWhat is this skill?
- 5-minute preflight runbook before deep Probe SDK debugging
- Five numbered sections: integration surface, inputs, lifecycle order, event/state, cleanup
- Documented lifecycle: permission → devices → diagnose AV → startToDiagnose → stop/cleanup
- Clarifies no Zoom Marketplace credentials for core diagnostics vs optional network URL overrides
- Explicit cleanup: stop diagnostics before unload, releaseMediaStream, lightweight stats callbacks
- 5-minute preflight runbook structure
- 5 numbered preflight sections in the skill doc
- 5-step diagnose lifecycle order from permission through cleanup
Adoption & trust: 845 installs on skills.sh; 19.6k GitHub stars; 2/3 security scanners passed (skills.sh audits).
What problem does it solve?
Probe SDK integrations fail in opaque ways because permissions, device IDs, diagnose order, and cleanup were never verified before diving into logs.
Who is it for?
Builders embedding Zoom Probe SDK device or network diagnostics in a web app before launch or after an SDK upgrade.
Skip if: Server-only backends with no browser media diagnostics, or meeting join runtime debugging without a Probe SDK surface.
When should I use this skill?
Before deep debugging Probe SDK web diagnostics; confirm integration surface, inputs, lifecycle, events, and cleanup.
What do I get? / Deliverables
You complete a structured preflight checklist, run diagnostics in the correct order, persist a report snapshot, and exit with stop/cleanup without leaking streams.
- Completed preflight checklist outcome and persisted diagnostics report snapshot before cleanup
Recommended Skills
Journey fit
Spans multiple journey phases - primary shelf plus alternate fits below.
Preflight runbooks shelf in Ship launch prep because they gate going live with working media/network diagnostics—not initial feature coding. Launch fits last-mile verification of client diagnostics before users hit production join or meeting flows.
Where it fits
First integration of diagnoseAudio/diagnoseVideo with explicit device IDs and renderer choice.
Pre-launch smoke pass confirming permission and cleanup paths on staging.
After SDK upgrade, re-run preflight to reconcile renamed renderer options and report fields.
How it compares
Operational runbook skill—not a generic WebRTC tutorial or a Zoom Marketplace OAuth integration pack.
Common Questions / FAQ
Who is probe-sdk for?
Solo builders shipping web apps that use Zoom Probe SDK for pre-call or in-app A/V and network diagnostics.
When should I use probe-sdk?
Use it in Ship before launch when diagnostics misbehave, and in Build integrations when first wiring permission → device → diagnose → startToDiagnose flows.
Is probe-sdk safe to install?
It describes browser diagnostics patterns; review Security Audits on this Prism page and your agent’s tool permissions before automating against production users.
SKILL.md
READMESKILL.md - Probe Sdk
# 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 - https://developers.zoom.us/docs/probe-sdk/ - https://marketplacefront.zoom.us/sdk/probe/index.html ### 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/` --- name: probe-sdk description: "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." user-invocable: false triggers: - "probe sdk" - "zoom probe" - "@zoom/probesdk" - "media diagnostics" - "network diagnostic" - "preflight check" - "diagnose audio video" - "browser compatibility diagnostics" - "diagnostic report" --- # Zoom Probe SDK Background reference for preflight diagnostics on user devices and networks before meeting or session workflows. Official docs: - https://developers.zoom.us/docs/probe-sdk/ - https://marketplacefront.zoom.us/sdk/probe/index.html Reference sample: - https://github.com/zoom/probesdk-web ## 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](../meeting-sdk/SKILL.md). - If user needs custom real-time session UX, route to [../video-sdk/SKILL.md](../video-sdk/SKILL.md). - If user needs backend orchestration of events/APIs, chain with [../rivet-sdk/SKILL.md](../rivet-sdk/SKILL.md), [../oauth/SKILL.md](../oauth/SKILL.md), and [../rest-api/SKILL.md](../rest-api/SKILL.md). ## Quick Links Start here: 1. [probe-sdk.md](probe-sdk.md) 2. [concepts/architecture-and-lifecycle.md](concepts/architecture-and-lifecycle.md) 3. [scenarios/high-level-scenarios.md](scenarios/high