Codex Skill Metadata
OpenAI Codex skill metadata file
**/agents/openai.yaml
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
**/agents/openai.yaml and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
$schema | string | JSON Schema reference for editor autocomplete and validation. https://developers.openai.com/codex/skills#optional-metadata |
dependencies | object | Tool dependencies used by the skill. https://developers.openai.com/codex/skills#optional-metadata |
dependencies.tools | array | External tools the skill depends on. https://developers.openai.com/codex/skills#optional-metadata |
interface | object | UI metadata shown by Codex clients. https://developers.openai.com/codex/skills#optional-metadata |
interface.brand_color | string | Hex color used for UI accents, such as badges. https://developers.openai.com/codex/skills#optional-metadata |
interface.default_prompt | string | Default prompt snippet inserted when invoking the skill. https://developers.openai.com/codex/skills#optional-metadata |
interface.display_name | string | Human-facing skill name shown in UI skill lists and chips. https://developers.openai.com/codex/skills#optional-metadata |
interface.icon_large | string | Path to a large icon asset, relative to the skill directory. https://developers.openai.com/codex/skills#optional-metadata |
interface.icon_small | string | Path to a small icon asset, relative to the skill directory. https://developers.openai.com/codex/skills#optional-metadata |
interface.short_description | string | Human-facing short description for quick scanning. https://developers.openai.com/codex/skills#optional-metadata |
policy | object | Skill invocation policy. https://developers.openai.com/codex/skills#optional-metadata |
policy.allow_implicit_invocation | boolean | When false, Codex will not implicitly invoke the skill based on the user prompt. Explicit $skill invocation still works. https://developers.openai.com/codex/skills#optional-metadata |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- 17 properties, 100% carrying a description, max nesting depth 6.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
format | JSON Schema Validation, draft 2020-12 | §7 — Vocabularies for Semantic Content With "format" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
minLength | JSON Schema Validation, draft 2020-12 | §6.3.2 — "minLength" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
required | JSON Schema Validation, draft 2020-12 | §6.5.3 — "required" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
format: "uri" | RFC 3986 (STD 66) | §3 — Syntax Components |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.