Harness Notes

JSON

OpenAI YAML

1 record ยท Updated 2026-10-08

agents/openai.yaml sits next to a skill's SKILL.md and tells Codex how to show the skill, when it may be used, and what it depends on. Only Codex documents this file. Quote all string values. Keep mapping keys unquoted.

FieldRequiredTypeWhat it doesLimits
How the skill appears
interface.display_nameOptionalstring

Human-facing title shown in UI skill lists and chips.

interface.short_descriptionOptionalstring

Human-facing short UI blurb for quick scanning.

Length is 25 through 64 characters, inclusive.

interface.icon_smallOptionalstring

Path to a small icon asset relative to the skill directory.

Default location is the skill's ./assets/ directory.

interface.icon_largeOptionalstring

Path to a larger logo asset relative to the skill directory.

Default location is the skill's ./assets/ directory.

interface.brand_colorOptionalstring

Hex color used for UI accents such as badges.

Value is a hexadecimal color string.

interface.default_promptOptionalstring

Default prompt snippet inserted when invoking the skill.

Use a helpful, short example, typically one sentence.

The prompt must explicitly mention the skill using $skill-name syntax.

What it needs
dependencies.toolsOptionalarray<object>

Tool dependencies advertised by the skill.

Dependencies are declarations, not permission boundaries.

dependencies.tools[].typeRequiredstring

Dependency category.

Only mcp is currently documented as supported.

The loader drops a dependency item when this field is absent, empty, or longer than 64 characters.

dependencies.tools[].valueRequiredstring

Identifier of the tool or dependency.

from source

The loader drops a dependency item when this field is absent, empty, or longer than 1024 characters.

dependencies.tools[].descriptionNot establishedstring

Human-readable explanation of the dependency.

dependencies.tools[].transportSometimes requiredstring

Connection type for an MCP dependency.

Applies when dependencies.tools[].type is mcp.

dependencies.tools[].urlSometimes requiredstring

MCP server URL for an MCP dependency.

Applies when dependencies.tools[].type is mcp.

dependencies.tools[].commandOptionalstring

Command used to launch a tool dependency such as a stdio MCP server.

from source

The loader normalizes whitespace and ignores an empty value or one longer than 1024 characters.

dependencies.tools[].oauth.callbackPortOptionalinteger

OAuth callback port for the dependency.

from source

The value is parsed as an unsigned 16-bit integer.

callback_port is accepted as an alias for callbackPort.

When it can be used
policy.allow_implicit_invocationOptionalboolean

Whether the model may select the skill without the user naming it explicitly.

False excludes the skill from the model-visible implicit skill catalog while explicit $skill invocation remains available.

The field defaults to true when the policy or value is absent.

policy.productsOptionalarray<string>

Restricts the skill metadata to matching OpenAI products.

from source

An empty list means no product restriction.

The loader parses values through the Codex Product vocabulary.

Notes and sources

Codex CLI