Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
12 changes: 12 additions & 0 deletions .agents/plugins/marketplace.json
Original file line number Diff line number Diff line change
Expand Up @@ -1429,6 +1429,18 @@
"authentication": "ON_INSTALL"
},
"category": "Coding"
},
{
"name": "zoom-developers",
"source": {
"source": "local",
"path": "./plugins/zoom-developers"
},
"policy": {
"installation": "AVAILABLE",
"authentication": "ON_INSTALL"
},
"category": "Coding"
}
]
}
45 changes: 45 additions & 0 deletions plugins/zoom-developers/.codex-plugin/plugin.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{
"name": "zoom-developers",
"version": "1.0.0",
"description": "Zoom Developers plugin for building Zoom integrations in Codex",
"author": {
"name": "Zoom",
"url": "https://github.com/zoom"
},
"homepage": "https://developers.zoom.us/",
"repository": "https://github.com/openai/plugins",
"license": "MIT",
"keywords": [
"zoom",
"developers",
"codex-plugin",
"rest-api",
"meeting-sdk",
"video-sdk",
"webhooks",
"oauth"
],
"skills": "./skills/",
"interface": {
"displayName": "Zoom Developers",
"shortDescription": "Build Zoom integrations in Codex.",
"longDescription": "Zoom Developers helps engineers choose the right Zoom product surface, design implementation plans, run deterministic setup and debugging workflows, review integrations with focused agents, and build across Zoom APIs and SDKs inside Codex.",
"developerName": "Zoom",
"category": "Coding",
"capabilities": [
"Interactive",
"Read",
"Write"
],
"websiteURL": "https://developers.zoom.us/",
"privacyPolicyURL": "https://www.zoom.com/en/trust/privacy/",
"termsOfServiceURL": "https://www.zoom.com/en/trust/terms/",
"defaultPrompt": [
"Plan and build a Zoom integration."
],
"brandColor": "#0B5CFF",
"composerIcon": "./assets/zoom-small.svg",
"logo": "./assets/app-icon.svg",
"screenshots": []
}
}
1 change: 1 addition & 0 deletions plugins/zoom-developers/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
publishing-guide.md
10 changes: 10 additions & 0 deletions plugins/zoom-developers/AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Zoom Developers

This repository contains the `Zoom Developers` plugin for Codex.

Its purpose is to help engineers:

- choose the right Zoom product surface
- plan Zoom integrations across APIs, SDKs, events, and auth
- debug broken Zoom integrations
- build Zoom integrations with deterministic command and skill workflows
9 changes: 9 additions & 0 deletions plugins/zoom-developers/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Changelog

All notable changes to this plugin are documented in this file.

## Unreleased

- split the former hybrid plugin into a dedicated developer plugin named `Zoom Developers`
- kept the Zoom build, setup, planning, and debugging workflows in this repo
- updated plugin metadata and slug alignment for `Zoom Developers`
186 changes: 186 additions & 0 deletions plugins/zoom-developers/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
# Contributing to Zoom Developers

Thank you for your interest in contributing. This document covers changes to the `Zoom Developers` Codex plugin.

## Ways to Contribute

You can contribute in any of these ways:

1. Submit a pull request with improvements.
2. Raise an issue on GitHub for bugs, gaps, or enhancement ideas.
3. Reach out on the [Zoom Developer Forum](https://devforum.zoom.us/) with feedback and improvement suggestions for these agent skills.

### 1. Report Issues
- Documentation errors or outdated information
- Missing use cases or scenarios
- Incorrect code examples

### 2. Improve Documentation
- Fix typos and clarify explanations
- Add missing code examples
- Update for new SDK versions

### 3. Add New Skills
- New use cases
- New platform coverage
- New integration patterns

## Contribution Process

### For Small Changes (typos, clarifications)

1. Fork the repository
2. Make your changes
3. Submit a pull request with a clear description

### For Larger Changes (new use cases, skills)

1. Open an issue first to discuss the proposed change
2. Fork the repository
3. Create a feature branch
4. Follow the skill format guidelines below
5. Submit a pull request

## Skill Format Guidelines

### SKILL.md Structure

```markdown
---
name: skill-name
description: |
Brief description (1-3 sentences).
Include when to use this skill.
---

# Skill Title

[Content following the template in PLAN.md]
```

### Guidelines

1. **Keep SKILL.md under 500 lines** - Move details to `references/`
2. **Max 3 directory levels** - `skill/references/file.md`
3. **Include code examples** - Real, working code developers can use
4. **Document gotchas** - Common mistakes and limitations
5. **Link to official sources** - Prefer Zoom documentation

### Maintenance Checklist

Use this checklist before merging documentation or skill changes:

1. Confirm you are editing the correct skill or product folder.
2. Keep `SKILL.md` as the entrypoint in every skill directory.
3. If examples include credentials, reference `.env` keys rather than hardcoded values.
4. Never commit machine-local absolute paths or machine-specific endpoints.
5. After moving or renaming docs, update cross-links from the relevant parent `SKILL.md` files.
6. Verify frontmatter stays accurate: `name`, `description`, and any optional fields such as `triggers`, `argument-hint`, or `user-invocable`.
7. Remove dead links and stale product claims after any refactor or version update.
8. Make sure every new markdown file is reachable from at least one parent navigation file.
9. Track deprecations and renames explicitly so future updates remain migration-safe.

### Repository Naming Conventions

- Keep canonical skill folder names aligned with [skills/start/SKILL.md](skills/start/SKILL.md).
- Current canonical folders include:
- `general`, `rest-api`, `webhooks`, `websockets`, `meeting-sdk`, `video-sdk`, `zoom-apps-sdk`
- `rtms`, `team-chat`, `ui-toolkit`, `cobrowse-sdk`, `oauth`
- `contact-center`, `virtual-agent`, `phone`, `rivet-sdk`, `probe-sdk`

### Markdown Linking Rules (Required)

- Use real markdown links for local docs (for example: `text -> docs/example.md`).
- Do not use backticks for local doc references if you want them counted in relationship graphs.
- Use repository-relative paths; do not commit machine-local absolute paths (for example `/home/your-user/...`).
- Every new `.md` file should be linked from at least one parent/index/`SKILL.md` file.

## Using AI Assistants for Contributions

You can use Codex or another AI assistant to help create or improve skills:

### Recommended Workflow

1. **Research Phase**
```
Research the official Zoom documentation for [topic].
Check the developer forum for common issues.
Find working code examples.
```

2. **Drafting Phase**
```
Create a skill following the SKILL.md template.
Include practical code examples.
Document known limitations and gotchas.
```

3. **Validation Phase**
```
Cross-check all information with official Zoom docs.
Verify code examples are syntactically correct.
Ensure links are valid.
```

### Assistant Usage Tips

- **Be specific**: "Create a use case for RTMS audio streaming to S3" not "write about RTMS"
- **Provide context**: Share relevant existing skills as examples
- **Iterate**: Review drafts and ask for improvements
- **Verify**: Always cross-check AI-generated content with official sources

### What AI Assistants Can Help With

| Task | How Assistants Help |
|------|------------------|
| Research | Search docs, forums, GitHub for information |
| Drafting | Create initial skill content following templates |
| Code examples | Generate working code snippets |
| Cross-referencing | Check consistency across skills |
| Formatting | Ensure markdown is correct |

### What Requires Human Review

| Task | Why Human Review |
|------|------------------|
| Technical accuracy | AI may hallucinate APIs or features |
| Real-world gotchas | Comes from actual development experience |
| Business logic | Zoom-specific requirements and policies |
| Security practices | Must be verified against official guidance |

## Quality Standards

### Do

- Verify all claims with official documentation
- Include working, tested code examples
- Document known limitations prominently
- Link to official resources
- Keep examples simple and practical
- Check that moved or renamed docs still have inbound links
- Remove outdated guidance that no longer matches the current plugin structure

### Don't

- Include unverified information
- Speculate about undocumented behavior
- Copy proprietary code without permission
- Include outdated or deprecated APIs without noting it
- Over-engineer examples

## Code of Conduct

- Be respectful and constructive
- Focus on improving the documentation
- Credit sources appropriately
- Follow Zoom's developer terms of service

## Questions?

- Open a GitHub issue for questions about contributing
- Check existing issues before creating new ones
- Join the [Zoom Developer Forum](https://devforum.zoom.us/) for Zoom-specific questions, feedback, and improvement requests for these agent skills

## License

By contributing, you agree that your contributions will be licensed under the MIT License.
21 changes: 21 additions & 0 deletions plugins/zoom-developers/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Zoom Video Communications, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading