Skip to content

Commit 8a1cd50

Browse files
authored
docs: add barebones README for codex-app-server crate (openai#4671)
1 parent 637dbbe commit 8a1cd50

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

codex-rs/app-server/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# codex-app-server
2+
3+
`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.
4+
5+
## Protocol
6+
7+
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.
8+
9+
## Message Schema
10+
11+
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.
12+
13+
```
14+
codex generate-ts --out DIR
15+
```

0 commit comments

Comments
 (0)