Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 1.67 KB

File metadata and controls

61 lines (43 loc) · 1.67 KB

Development

This repository is a multi-plugin collection for Codex API mode.

Rules for adding future plugins

Every new plugin must follow this contract:

  1. Create plugins/<plugin-name>/
  2. Include plugins/<plugin-name>/.codex-plugin/plugin.json
  3. Register the plugin in .agents/plugins/marketplace.json
  4. Add install and usage docs
  5. Add troubleshooting notes if the plugin has external dependencies or known failure modes

Required metadata

Every plugin manifest should provide:

  • stable plugin id
  • version
  • description
  • author
  • repository URL
  • license
  • UI-facing interface metadata

Repository update checklist

When you add a plugin:

  • update .agents/plugins/marketplace.json
  • update the plugin table in README.md
  • add usage docs under docs/usage/
  • update troubleshooting docs if needed
  • remove stale marketplace entries, install steps, and usage docs if you replaced an older plugin
  • run scripts/validate-repo.ps1

Compatibility expectations

Plugins in this repository should be designed for:

  • Codex API mode first
  • local plugin installation
  • reproducible marketplace registration

Avoid designs that require:

  • ChatGPT app-only auth flows
  • hidden connector dependencies
  • undocumented machine-local configuration
  • committed secrets, placeholder personal tokens, or hardcoded user-specific absolute paths

Validation standard

Before publishing a plugin update:

  • JSON manifests parse successfully
  • Python helper scripts compile successfully
  • install docs match the actual config shape
  • the plugin can be discovered from the registered marketplace
  • .mcp.json uses redistributable commands and env settings rather than machine-local paths