From 53ba89fc4190f10f461b5d4e7cb6857c26485e47 Mon Sep 17 00:00:00 2001 From: Michael Bolin Date: Fri, 3 Oct 2025 09:25:11 -0700 Subject: [PATCH] docs: add barebones README for codex-app-server crate --- codex-rs/app-server/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 codex-rs/app-server/README.md diff --git a/codex-rs/app-server/README.md b/codex-rs/app-server/README.md new file mode 100644 index 0000000000..2eb8a1ad72 --- /dev/null +++ b/codex-rs/app-server/README.md @@ -0,0 +1,15 @@ +# codex-app-server + +`codex app-server` is the harness Codex uses to power rich interfaces such as the [Codex VS Code extension](https://marketplace.visualstudio.com/items?itemName=openai.chatgpt). 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](https://modelcontextprotocol.io/), `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 +```