Plugins
Plugins
.codex-plugin/plugin.json
Vendor docs
config
| name | type | required | meaning | concept | |
|---|---|---|---|---|---|
| apps | string |
App manifest path for plugin integrations.
|
docs ↗ | ||
| author | object |
Publisher identity.
|
docs ↗ | ||
| brandColor | string |
Theme color for the plugin card.
|
docs ↗ | ||
| capabilities | array |
Capability list from implementation.
|
docs ↗ | ||
| category | string |
Plugin category bucket.
|
docs ↗ | ||
| composerIcon | string |
Path to icon asset.
|
docs ↗ | ||
| defaultPrompt | array |
Starter prompts shown in composer/UX context.
|
docs ↗ | ||
| description | string |
Short purpose summary.
|
docs ↗ | ||
| developerName | string |
Human-readable publisher name.
|
docs ↗ | ||
| displayName | string |
User-facing title shown for the plugin.
|
docs ↗ | ||
| string |
Contact email.
|
docs ↗ | |||
| homepage | string |
Documentation URL for plugin usage.
|
docs ↗ | ||
| hooks | string |
Hook config path.
|
docs ↗ | ||
| interface | object |
Interface/UX metadata block for plugin presentation.
|
docs ↗ | ||
| keywords | array |
Search/discovery tags.
|
docs ↗ | ||
| license | string |
License identifier (for example `MIT`, `Apache-2.0`).
|
docs ↗ | ||
| logo | string |
Path to logo asset.
|
docs ↗ | ||
| logoDark | string |
Optional path to the logo asset used in dark mode.
|
docs ↗ | ||
| longDescription | string |
Longer description used on details screens.
|
docs ↗ | ||
| mcpServers | string |
MCP config path, or an object whose keys are MCP server names and whose values are MCP server config objects.
|
docs ↗ | ||
| name | string |
Plugin identifier (kebab-case, no spaces). Required if `plugin.json` is provided and used as manifest name and component namespace.
|
docs ↗ | ||
| privacyPolicyURL | string |
Privacy policy URL.
|
docs ↗ | ||
| repository | string |
Source code URL.
|
docs ↗ | ||
| screenshots | array |
List of screenshot asset paths.
|
docs ↗ | ||
| shortDescription | string |
Brief subtitle used in compact views.
|
docs ↗ | ||
| skills | string |
Relative path to skill directories/files.
|
docs ↗ | ||
| termsOfServiceURL | string |
Terms of service URL.
|
docs ↗ | ||
| url | string |
Author/team homepage or profile URL.
|
docs ↗ | ||
| version | string |
Plugin semantic version.
|
docs ↗ | ||
| websiteURL | string |
Public website for the plugin.
|
docs ↗ |