History

pakrym-oai 2371d771cc Update user instruction message format (#6010 )		2025-10-30 18:44:02 -07:00
..
src	[Hygiene] Remove `include_view_image_tool` config (#5976 )	2025-10-30 13:23:24 -07:00
tests	Update user instruction message format (#6010 )	2025-10-30 18:44:02 -07:00
Cargo.toml	Add feedback upload request handling (#5682 )	2025-10-27 05:53:39 +00:00
README.md	docs: add barebones README for codex-app-server crate (#4671 )	2025-10-03 09:26:44 -07:00

README.md

codex-app-server

codex app-server is the harness Codex uses to power rich interfaces such as the Codex VS Code extension. The message schema is currently unstable, but those who wish to build experimental UIs on top of Codex may find it valuable.

Protocol

Similar to MCP, codex app-server supports bidirectional communication, streaming JSONL over stdio. The protocol is JSON-RPC 2.0, though the "jsonrpc":"2.0" header is omitted.

Message Schema

Currently, you can dump a TypeScript version of the schema using codex generate-ts. It is specific to the version of Codex you used to run generate-ts, so the two are guaranteed to be compatible.

codex generate-ts --out DIR