Skills
Skills
.agents/skills/*/SKILL.md
Vendor docs
frontmatter
| name | type | required | meaning | concept | |
|---|---|---|---|---|---|
| allowed-tools | string |
Space-separated string of pre-approved tools the skill may use. (Experimental)
|
docs ↗ | ||
| compatibility | string |
Max 500 characters. Indicates environment requirements (intended product, system packages, network access, etc.).
|
docs ↗ | ||
| description | string | yes |
Max 1024 characters. Non-empty. Describes what the skill does and when to use it.
|
docs ↗ | |
| license | string |
License name or reference to a bundled license file.
|
docs ↗ | ||
| metadata | string |
Arbitrary key-value mapping for additional metadata.
|
docs ↗ | ||
| name | string | yes |
Max 64 characters. Lowercase letters, numbers, and hyphens only. Must not start or end with a hyphen.
|
docs ↗ |
config
Keys from an optional openai.yaml file that ships next to SKILL.md, separate from the frontmatter. They control how the skill is presented in the Codex app UI (display name, description, icons, brand color), whether Codex may invoke it implicitly, and which tools it depends on.
| name | type | required | meaning | concept | |
|---|---|---|---|---|---|
| allow_implicit_invocation | string | docs ↗ | |||
| brand_color | string | docs ↗ | |||
| default_prompt | string | docs ↗ | |||
| dependencies | string | docs ↗ | |||
| description | string | docs ↗ | |||
| display_name | string | docs ↗ | |||
| icon_large | string | docs ↗ | |||
| icon_small | string | docs ↗ | |||
| interface | string | docs ↗ | |||
| policy | string | docs ↗ | |||
| short_description | string | docs ↗ | |||
| tools | string | docs ↗ | |||
| transport | string | docs ↗ | |||
| type | string | docs ↗ | |||
| url | string | docs ↗ | |||
| value | string | docs ↗ |