openai/codex
1
0
Fork 0
mirror of https://github.com/openai/codex.git synced 2026-09-05 15:18:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove app-server v1 doc references

Browse Source
This commit is contained in:
Eric Traut
2026-05-26 09:07:12 -07:00
parent a591b76b46
commit 116ddfbb7a
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
AGENTS.md
View File

@@ -183,7 +183,7 @@ These guidelines apply to app-server protocol work in `codex-rs`, especially:
### Core Rules
- All active API development should happen in app-server v2. Do not add new API surface area to v1.
- All active API development should happen in app-server v2.
- Follow payload naming consistently:
`*Params` for request payloads, `*Response` for responses, and `*Notification` for notifications.
- Expose RPC methods as `<resource>/<method>` and keep `<resource>` singular (for example, `thread/read`, `app/list`).

10
codex-rs/docs/codex_mcp_interface.md
View File

@@ -8,7 +8,7 @@ This document describes Codex's experimental MCP server interface: a JSON-RPC AP
## Overview
Codex exposes MCP-compatible methods to manage threads, turns, accounts, config, and approvals. The shared and v1 types live in `app-server-protocol/src/protocol/common.rs` and `app-server-protocol/src/protocol/v1.rs`; v2 types live under `app-server-protocol/src/protocol/v2/`. The app server implementation in `app-server/` consumes those protocol definitions.
Codex exposes MCP-compatible methods to manage threads, turns, accounts, config, and approvals. Shared protocol definitions live in `app-server-protocol/src/protocol/common.rs`; v2 types live under `app-server-protocol/src/protocol/v2/`. The app server implementation in `app-server/` consumes those protocol definitions.
At a glance:
@@ -18,7 +18,7 @@ At a glance:
- `account/read`, `account/login/start`, `account/login/cancel`, `account/logout`, `account/rateLimits/read`
- `config/read`, `config/value/write`, `config/batchWrite`
- `model/list`, `app/list`, `collaborationMode/list`
- Remaining v1 compatibility RPCs
- Deprecated compatibility RPCs
- `getConversationSummary`
- `getAuthStatus`
- `gitDiffToRemote`
@@ -30,7 +30,7 @@ At a glance:
- Approvals (server -> client requests)
- `applyPatchApproval`, `execCommandApproval`
See code for full type definitions and exact shapes: `app-server-protocol/src/protocol/common.rs`, `app-server-protocol/src/protocol/v1.rs`, and `app-server-protocol/src/protocol/v2/`.
See code for full type definitions and exact shapes: `app-server-protocol/src/protocol/common.rs` and `app-server-protocol/src/protocol/v2/`.
## Starting the server
@@ -132,7 +132,7 @@ For the complete request/response shapes and flow examples, see the [Auth endpoi
## Legacy compatibility methods
The server still accepts a narrow v1 compatibility surface for existing app clients:
The server still accepts a narrow deprecated compatibility surface for existing app clients:
- `getConversationSummary`
- `getAuthStatus`
@@ -141,4 +141,4 @@ The server still accepts a narrow v1 compatibility surface for existing app clie
## Compatibility and stability
This interface is experimental. Method names, fields, and event shapes may evolve. For the authoritative schema, consult `app-server-protocol/src/protocol/common.rs`, `app-server-protocol/src/protocol/v1.rs`, `app-server-protocol/src/protocol/v2/`, and the corresponding server wiring in `app-server/`.
This interface is experimental. Method names, fields, and event shapes may evolve. For the authoritative schema, consult `app-server-protocol/src/protocol/common.rs`, `app-server-protocol/src/protocol/v2/`, and the corresponding server wiring in `app-server/`.