codex-protocol README appears stale about app-server protocol types

Open Beginner friendly
#25,520 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
rust
Domain
documentation

Research direction

Open codex-rs/protocol/README.md and compare its description with codex-rs/app-server-protocol/Cargo.toml, codex-rs/app-server-protocol/src/lib.rs, and the app-server documentation. Update the README to distinguish protocol types remaining in codex-protocol from app-server JSON-RPC/API types in codex-app-server-protocol. Done means the crate split and relevant reader entry point are unambiguous.

Written by the indexing model from the issue text.

Description

app-server documentation
What happened?

codex-rs/protocol/README.md says codex-protocol defines both internal types for communication between codex-core and codex-tui and “external types” used with codex app-server.

The app-server JSON-RPC surface now appears to live in the separate codex-app-server-protocol crate:

  • codex-rs/app-server-protocol/Cargo.toml defines package codex-app-server-protocol.
  • codex-rs/app-server-protocol/src/lib.rs exports the app-server protocol modules and v1/v2 types.
  • The app-server docs point readers to app-server-protocol for request/response shapes.

codex-protocol is still used by other crates and is also a dependency of codex-app-server-protocol, but the README wording makes it sound like the app-server external protocol types live directly in codex-protocol.

Expected behavior

The codex-protocol README should clarify the current crate split: which protocol types remain in codex-protocol, and which app-server JSON-RPC/API types live in codex-app-server-protocol.

Additional context

I searched open issues and PRs for terms including codex-protocol README, app-server external types, and codex-app-server-protocol, and did not find an existing open item that appears to cover this specific README drift.

Dominant language
Rust
Stars
125k
Forks
19.5k
Avg merge
1m
Merged PRs (30d)
1k

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from openai/codex

All issues in openai/codex

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.