2025-10-28 08:10:23 -07:00
|
|
|
use anyhow::Result;
|
fix: separate `codex mcp` into `codex mcp-server` and `codex app-server` (#4471)
This is a very large PR with some non-backwards-compatible changes.
Historically, `codex mcp` (or `codex mcp serve`) started a JSON-RPC-ish
server that had two overlapping responsibilities:
- Running an MCP server, providing some basic tool calls.
- Running the app server used to power experiences such as the VS Code
extension.
This PR aims to separate these into distinct concepts:
- `codex mcp-server` for the MCP server
- `codex app-server` for the "application server"
Note `codex mcp` still exists because it already has its own subcommands
for MCP management (`list`, `add`, etc.)
The MCP logic continues to live in `codex-rs/mcp-server` whereas the
refactored app server logic is in the new `codex-rs/app-server` folder.
Note that most of the existing integration tests in
`codex-rs/mcp-server/tests/suite` were actually for the app server, so
all the tests have been moved with the exception of
`codex-rs/mcp-server/tests/suite/mod.rs`.
Because this is already a large diff, I tried not to change more than I
had to, so `codex-rs/app-server/tests/common/mcp_process.rs` still uses
the name `McpProcess` for now, but I will do some mechanical renamings
to things like `AppServer` in subsequent PRs.
While `mcp-server` and `app-server` share some overlapping functionality
(like reading streams of JSONL and dispatching based on message types)
and some differences (completely different message types), I ended up
doing a bit of copypasta between the two crates, as both have somewhat
similar `message_processor.rs` and `outgoing_message.rs` files for now,
though I expect them to diverge more in the near future.
One material change is that of the initialize handshake for `codex
app-server`, as we no longer use the MCP types for that handshake.
Instead, we update `codex-rs/protocol/src/mcp_protocol.rs` to add an
`Initialize` variant to `ClientRequest`, which takes the `ClientInfo`
object we need to update the `USER_AGENT_SUFFIX` in
`codex-rs/app-server/src/message_processor.rs`.
One other material change is in
`codex-rs/app-server/src/codex_message_processor.rs` where I eliminated
a use of the `send_event_as_notification()` method I am generally trying
to deprecate (because it blindly maps an `EventMsg` into a
`JSONNotification`) in favor of `send_server_notification()`, which
takes a `ServerNotification`, as that is intended to be a custom enum of
all notification types supported by the app server. So to make this
update, I had to introduce a new variant of `ServerNotification`,
`SessionConfigured`, which is a non-backwards compatible change with the
old `codex mcp`, and clients will have to be updated after the next
release that contains this PR. Note that
`codex-rs/app-server/tests/suite/list_resume.rs` also had to be update
to reflect this change.
I introduced `codex-rs/utils/json-to-toml/src/lib.rs` as a small utility
crate to avoid some of the copying between `mcp-server` and
`app-server`.
2025-09-30 00:06:18 -07:00
|
|
|
use app_test_support::McpProcess;
|
2025-11-05 12:28:43 -08:00
|
|
|
use app_test_support::create_fake_rollout;
|
fix: separate `codex mcp` into `codex mcp-server` and `codex app-server` (#4471)
This is a very large PR with some non-backwards-compatible changes.
Historically, `codex mcp` (or `codex mcp serve`) started a JSON-RPC-ish
server that had two overlapping responsibilities:
- Running an MCP server, providing some basic tool calls.
- Running the app server used to power experiences such as the VS Code
extension.
This PR aims to separate these into distinct concepts:
- `codex mcp-server` for the MCP server
- `codex app-server` for the "application server"
Note `codex mcp` still exists because it already has its own subcommands
for MCP management (`list`, `add`, etc.)
The MCP logic continues to live in `codex-rs/mcp-server` whereas the
refactored app server logic is in the new `codex-rs/app-server` folder.
Note that most of the existing integration tests in
`codex-rs/mcp-server/tests/suite` were actually for the app server, so
all the tests have been moved with the exception of
`codex-rs/mcp-server/tests/suite/mod.rs`.
Because this is already a large diff, I tried not to change more than I
had to, so `codex-rs/app-server/tests/common/mcp_process.rs` still uses
the name `McpProcess` for now, but I will do some mechanical renamings
to things like `AppServer` in subsequent PRs.
While `mcp-server` and `app-server` share some overlapping functionality
(like reading streams of JSONL and dispatching based on message types)
and some differences (completely different message types), I ended up
doing a bit of copypasta between the two crates, as both have somewhat
similar `message_processor.rs` and `outgoing_message.rs` files for now,
though I expect them to diverge more in the near future.
One material change is that of the initialize handshake for `codex
app-server`, as we no longer use the MCP types for that handshake.
Instead, we update `codex-rs/protocol/src/mcp_protocol.rs` to add an
`Initialize` variant to `ClientRequest`, which takes the `ClientInfo`
object we need to update the `USER_AGENT_SUFFIX` in
`codex-rs/app-server/src/message_processor.rs`.
One other material change is in
`codex-rs/app-server/src/codex_message_processor.rs` where I eliminated
a use of the `send_event_as_notification()` method I am generally trying
to deprecate (because it blindly maps an `EventMsg` into a
`JSONNotification`) in favor of `send_server_notification()`, which
takes a `ServerNotification`, as that is intended to be a custom enum of
all notification types supported by the app server. So to make this
update, I had to introduce a new variant of `ServerNotification`,
`SessionConfigured`, which is a non-backwards compatible change with the
old `codex mcp`, and clients will have to be updated after the next
release that contains this PR. Note that
`codex-rs/app-server/tests/suite/list_resume.rs` also had to be update
to reflect this change.
I introduced `codex-rs/utils/json-to-toml/src/lib.rs` as a small utility
crate to avoid some of the copying between `mcp-server` and
`app-server`.
2025-09-30 00:06:18 -07:00
|
|
|
use app_test_support::to_response;
|
fix: remove mcp-types from app server protocol (#4537)
We continue the separation between `codex app-server` and `codex
mcp-server`.
In particular, we introduce a new crate, `codex-app-server-protocol`,
and migrate `codex-rs/protocol/src/mcp_protocol.rs` into it, renaming it
`codex-rs/app-server-protocol/src/protocol.rs`.
Because `ConversationId` was defined in `mcp_protocol.rs`, we move it
into its own file, `codex-rs/protocol/src/conversation_id.rs`, and
because it is referenced in a ton of places, we have to touch a lot of
files as part of this PR.
We also decide to get away from proper JSON-RPC 2.0 semantics, so we
also introduce `codex-rs/app-server-protocol/src/jsonrpc_lite.rs`, which
is basically the same `JSONRPCMessage` type defined in `mcp-types`
except with all of the `"jsonrpc": "2.0"` removed.
Getting rid of `"jsonrpc": "2.0"` makes our serialization logic
considerably simpler, as we can lean heavier on serde to serialize
directly into the wire format that we use now.
2025-09-30 19:16:26 -07:00
|
|
|
use codex_app_server_protocol::JSONRPCNotification;
|
|
|
|
|
use codex_app_server_protocol::JSONRPCResponse;
|
|
|
|
|
use codex_app_server_protocol::ListConversationsParams;
|
|
|
|
|
use codex_app_server_protocol::ListConversationsResponse;
|
|
|
|
|
use codex_app_server_protocol::NewConversationParams; // reused for overrides shape
|
|
|
|
|
use codex_app_server_protocol::RequestId;
|
|
|
|
|
use codex_app_server_protocol::ResumeConversationParams;
|
|
|
|
|
use codex_app_server_protocol::ResumeConversationResponse;
|
|
|
|
|
use codex_app_server_protocol::ServerNotification;
|
|
|
|
|
use codex_app_server_protocol::SessionConfiguredNotification;
|
2025-10-28 18:18:03 -07:00
|
|
|
use codex_core::protocol::EventMsg;
|
|
|
|
|
use codex_protocol::models::ContentItem;
|
|
|
|
|
use codex_protocol::models::ResponseItem;
|
2025-09-04 16:44:18 -07:00
|
|
|
use pretty_assertions::assert_eq;
|
|
|
|
|
use tempfile::TempDir;
|
|
|
|
|
use tokio::time::timeout;
|
|
|
|
|
|
|
|
|
|
const DEFAULT_READ_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(10);
|
|
|
|
|
|
|
|
|
|
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
2025-10-28 08:10:23 -07:00
|
|
|
async fn test_list_and_resume_conversations() -> Result<()> {
|
2025-09-04 16:44:18 -07:00
|
|
|
// Prepare a temporary CODEX_HOME with a few fake rollout files.
|
2025-10-28 08:10:23 -07:00
|
|
|
let codex_home = TempDir::new()?;
|
2025-09-04 16:44:18 -07:00
|
|
|
create_fake_rollout(
|
|
|
|
|
codex_home.path(),
|
|
|
|
|
"2025-01-02T12-00-00",
|
|
|
|
|
"2025-01-02T12:00:00Z",
|
|
|
|
|
"Hello A",
|
2025-10-27 02:03:30 -07:00
|
|
|
Some("openai"),
|
2025-10-28 08:10:23 -07:00
|
|
|
)?;
|
2025-09-04 16:44:18 -07:00
|
|
|
create_fake_rollout(
|
|
|
|
|
codex_home.path(),
|
|
|
|
|
"2025-01-01T13-00-00",
|
|
|
|
|
"2025-01-01T13:00:00Z",
|
|
|
|
|
"Hello B",
|
2025-10-27 02:03:30 -07:00
|
|
|
Some("openai"),
|
2025-10-28 08:10:23 -07:00
|
|
|
)?;
|
2025-09-04 16:44:18 -07:00
|
|
|
create_fake_rollout(
|
|
|
|
|
codex_home.path(),
|
|
|
|
|
"2025-01-01T12-00-00",
|
|
|
|
|
"2025-01-01T12:00:00Z",
|
|
|
|
|
"Hello C",
|
2025-10-27 02:03:30 -07:00
|
|
|
None,
|
2025-10-28 08:10:23 -07:00
|
|
|
)?;
|
2025-09-04 16:44:18 -07:00
|
|
|
|
2025-10-28 08:10:23 -07:00
|
|
|
let mut mcp = McpProcess::new(codex_home.path()).await?;
|
|
|
|
|
timeout(DEFAULT_READ_TIMEOUT, mcp.initialize()).await??;
|
2025-09-04 16:44:18 -07:00
|
|
|
|
|
|
|
|
// Request first page with size 2
|
|
|
|
|
let req_id = mcp
|
|
|
|
|
.send_list_conversations_request(ListConversationsParams {
|
|
|
|
|
page_size: Some(2),
|
|
|
|
|
cursor: None,
|
2025-10-27 02:03:30 -07:00
|
|
|
model_providers: None,
|
2025-09-04 16:44:18 -07:00
|
|
|
})
|
2025-10-28 08:10:23 -07:00
|
|
|
.await?;
|
2025-09-04 16:44:18 -07:00
|
|
|
let resp: JSONRPCResponse = timeout(
|
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
|
|
|
|
mcp.read_stream_until_response_message(RequestId::Integer(req_id)),
|
|
|
|
|
)
|
2025-10-28 08:10:23 -07:00
|
|
|
.await??;
|
2025-09-04 16:44:18 -07:00
|
|
|
let ListConversationsResponse { items, next_cursor } =
|
2025-10-28 08:10:23 -07:00
|
|
|
to_response::<ListConversationsResponse>(resp)?;
|
2025-09-04 16:44:18 -07:00
|
|
|
|
|
|
|
|
assert_eq!(items.len(), 2);
|
|
|
|
|
// Newest first; preview text should match
|
|
|
|
|
assert_eq!(items[0].preview, "Hello A");
|
|
|
|
|
assert_eq!(items[1].preview, "Hello B");
|
2025-10-27 02:03:30 -07:00
|
|
|
assert_eq!(items[0].model_provider, "openai");
|
|
|
|
|
assert_eq!(items[1].model_provider, "openai");
|
2025-09-04 16:44:18 -07:00
|
|
|
assert!(items[0].path.is_absolute());
|
|
|
|
|
assert!(next_cursor.is_some());
|
|
|
|
|
|
|
|
|
|
// Request the next page using the cursor
|
|
|
|
|
let req_id2 = mcp
|
|
|
|
|
.send_list_conversations_request(ListConversationsParams {
|
|
|
|
|
page_size: Some(2),
|
|
|
|
|
cursor: next_cursor,
|
2025-10-27 02:03:30 -07:00
|
|
|
model_providers: None,
|
2025-09-04 16:44:18 -07:00
|
|
|
})
|
2025-10-28 08:10:23 -07:00
|
|
|
.await?;
|
2025-09-04 16:44:18 -07:00
|
|
|
let resp2: JSONRPCResponse = timeout(
|
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
|
|
|
|
mcp.read_stream_until_response_message(RequestId::Integer(req_id2)),
|
|
|
|
|
)
|
2025-10-28 08:10:23 -07:00
|
|
|
.await??;
|
2025-09-04 16:44:18 -07:00
|
|
|
let ListConversationsResponse {
|
|
|
|
|
items: items2,
|
|
|
|
|
next_cursor: next2,
|
|
|
|
|
..
|
2025-10-28 08:10:23 -07:00
|
|
|
} = to_response::<ListConversationsResponse>(resp2)?;
|
2025-09-04 16:44:18 -07:00
|
|
|
assert_eq!(items2.len(), 1);
|
|
|
|
|
assert_eq!(items2[0].preview, "Hello C");
|
2025-10-27 02:03:30 -07:00
|
|
|
assert_eq!(items2[0].model_provider, "openai");
|
|
|
|
|
assert_eq!(next2, None);
|
|
|
|
|
|
|
|
|
|
// Add a conversation with an explicit non-OpenAI provider for filter tests.
|
|
|
|
|
create_fake_rollout(
|
|
|
|
|
codex_home.path(),
|
|
|
|
|
"2025-01-01T11-30-00",
|
|
|
|
|
"2025-01-01T11:30:00Z",
|
|
|
|
|
"Hello TP",
|
|
|
|
|
Some("test-provider"),
|
2025-10-28 08:10:23 -07:00
|
|
|
)?;
|
2025-10-27 02:03:30 -07:00
|
|
|
|
|
|
|
|
// Filtering by model provider should return only matching sessions.
|
|
|
|
|
let filter_req_id = mcp
|
|
|
|
|
.send_list_conversations_request(ListConversationsParams {
|
|
|
|
|
page_size: Some(10),
|
|
|
|
|
cursor: None,
|
|
|
|
|
model_providers: Some(vec!["test-provider".to_string()]),
|
|
|
|
|
})
|
2025-10-28 08:10:23 -07:00
|
|
|
.await?;
|
2025-10-27 02:03:30 -07:00
|
|
|
let filter_resp: JSONRPCResponse = timeout(
|
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
|
|
|
|
mcp.read_stream_until_response_message(RequestId::Integer(filter_req_id)),
|
|
|
|
|
)
|
2025-10-28 08:10:23 -07:00
|
|
|
.await??;
|
2025-10-27 02:03:30 -07:00
|
|
|
let ListConversationsResponse {
|
|
|
|
|
items: filtered_items,
|
|
|
|
|
next_cursor: filtered_next,
|
2025-10-28 08:10:23 -07:00
|
|
|
} = to_response::<ListConversationsResponse>(filter_resp)?;
|
2025-10-27 02:03:30 -07:00
|
|
|
assert_eq!(filtered_items.len(), 1);
|
|
|
|
|
assert_eq!(filtered_next, None);
|
|
|
|
|
assert_eq!(filtered_items[0].preview, "Hello TP");
|
|
|
|
|
assert_eq!(filtered_items[0].model_provider, "test-provider");
|
|
|
|
|
|
|
|
|
|
// Empty filter should include every session regardless of provider metadata.
|
|
|
|
|
let unfiltered_req_id = mcp
|
|
|
|
|
.send_list_conversations_request(ListConversationsParams {
|
|
|
|
|
page_size: Some(10),
|
|
|
|
|
cursor: None,
|
|
|
|
|
model_providers: Some(Vec::new()),
|
|
|
|
|
})
|
2025-10-28 08:10:23 -07:00
|
|
|
.await?;
|
2025-10-27 02:03:30 -07:00
|
|
|
let unfiltered_resp: JSONRPCResponse = timeout(
|
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
|
|
|
|
mcp.read_stream_until_response_message(RequestId::Integer(unfiltered_req_id)),
|
|
|
|
|
)
|
2025-10-28 08:10:23 -07:00
|
|
|
.await??;
|
2025-10-27 02:03:30 -07:00
|
|
|
let ListConversationsResponse {
|
|
|
|
|
items: unfiltered_items,
|
|
|
|
|
next_cursor: unfiltered_next,
|
2025-10-28 08:10:23 -07:00
|
|
|
} = to_response::<ListConversationsResponse>(unfiltered_resp)?;
|
2025-10-27 02:03:30 -07:00
|
|
|
assert_eq!(unfiltered_items.len(), 4);
|
|
|
|
|
assert!(unfiltered_next.is_none());
|
|
|
|
|
|
|
|
|
|
let empty_req_id = mcp
|
|
|
|
|
.send_list_conversations_request(ListConversationsParams {
|
|
|
|
|
page_size: Some(10),
|
|
|
|
|
cursor: None,
|
|
|
|
|
model_providers: Some(vec!["other".to_string()]),
|
|
|
|
|
})
|
2025-10-28 08:10:23 -07:00
|
|
|
.await?;
|
2025-10-27 02:03:30 -07:00
|
|
|
let empty_resp: JSONRPCResponse = timeout(
|
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
|
|
|
|
mcp.read_stream_until_response_message(RequestId::Integer(empty_req_id)),
|
|
|
|
|
)
|
2025-10-28 08:10:23 -07:00
|
|
|
.await??;
|
2025-10-27 02:03:30 -07:00
|
|
|
let ListConversationsResponse {
|
|
|
|
|
items: empty_items,
|
|
|
|
|
next_cursor: empty_next,
|
2025-10-28 08:10:23 -07:00
|
|
|
} = to_response::<ListConversationsResponse>(empty_resp)?;
|
2025-10-27 02:03:30 -07:00
|
|
|
assert!(empty_items.is_empty());
|
|
|
|
|
assert!(empty_next.is_none());
|
2025-09-04 16:44:18 -07:00
|
|
|
|
2025-10-28 18:18:03 -07:00
|
|
|
let first_item = &items[0];
|
|
|
|
|
|
|
|
|
|
// Now resume one of the sessions from an explicit rollout path.
|
2025-09-04 16:44:18 -07:00
|
|
|
let resume_req_id = mcp
|
|
|
|
|
.send_resume_conversation_request(ResumeConversationParams {
|
2025-10-28 18:18:03 -07:00
|
|
|
path: Some(first_item.path.clone()),
|
2025-10-28 17:17:22 -07:00
|
|
|
conversation_id: None,
|
2025-10-28 18:18:03 -07:00
|
|
|
history: None,
|
2025-09-04 16:44:18 -07:00
|
|
|
overrides: Some(NewConversationParams {
|
|
|
|
|
model: Some("o3".to_string()),
|
|
|
|
|
..Default::default()
|
|
|
|
|
}),
|
|
|
|
|
})
|
2025-10-28 08:10:23 -07:00
|
|
|
.await?;
|
2025-09-04 16:44:18 -07:00
|
|
|
|
fix: separate `codex mcp` into `codex mcp-server` and `codex app-server` (#4471)
This is a very large PR with some non-backwards-compatible changes.
Historically, `codex mcp` (or `codex mcp serve`) started a JSON-RPC-ish
server that had two overlapping responsibilities:
- Running an MCP server, providing some basic tool calls.
- Running the app server used to power experiences such as the VS Code
extension.
This PR aims to separate these into distinct concepts:
- `codex mcp-server` for the MCP server
- `codex app-server` for the "application server"
Note `codex mcp` still exists because it already has its own subcommands
for MCP management (`list`, `add`, etc.)
The MCP logic continues to live in `codex-rs/mcp-server` whereas the
refactored app server logic is in the new `codex-rs/app-server` folder.
Note that most of the existing integration tests in
`codex-rs/mcp-server/tests/suite` were actually for the app server, so
all the tests have been moved with the exception of
`codex-rs/mcp-server/tests/suite/mod.rs`.
Because this is already a large diff, I tried not to change more than I
had to, so `codex-rs/app-server/tests/common/mcp_process.rs` still uses
the name `McpProcess` for now, but I will do some mechanical renamings
to things like `AppServer` in subsequent PRs.
While `mcp-server` and `app-server` share some overlapping functionality
(like reading streams of JSONL and dispatching based on message types)
and some differences (completely different message types), I ended up
doing a bit of copypasta between the two crates, as both have somewhat
similar `message_processor.rs` and `outgoing_message.rs` files for now,
though I expect them to diverge more in the near future.
One material change is that of the initialize handshake for `codex
app-server`, as we no longer use the MCP types for that handshake.
Instead, we update `codex-rs/protocol/src/mcp_protocol.rs` to add an
`Initialize` variant to `ClientRequest`, which takes the `ClientInfo`
object we need to update the `USER_AGENT_SUFFIX` in
`codex-rs/app-server/src/message_processor.rs`.
One other material change is in
`codex-rs/app-server/src/codex_message_processor.rs` where I eliminated
a use of the `send_event_as_notification()` method I am generally trying
to deprecate (because it blindly maps an `EventMsg` into a
`JSONNotification`) in favor of `send_server_notification()`, which
takes a `ServerNotification`, as that is intended to be a custom enum of
all notification types supported by the app server. So to make this
update, I had to introduce a new variant of `ServerNotification`,
`SessionConfigured`, which is a non-backwards compatible change with the
old `codex mcp`, and clients will have to be updated after the next
release that contains this PR. Note that
`codex-rs/app-server/tests/suite/list_resume.rs` also had to be update
to reflect this change.
I introduced `codex-rs/utils/json-to-toml/src/lib.rs` as a small utility
crate to avoid some of the copying between `mcp-server` and
`app-server`.
2025-09-30 00:06:18 -07:00
|
|
|
// Expect a codex/event notification with msg.type == sessionConfigured
|
2025-09-04 16:44:18 -07:00
|
|
|
let notification: JSONRPCNotification = timeout(
|
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
fix: separate `codex mcp` into `codex mcp-server` and `codex app-server` (#4471)
This is a very large PR with some non-backwards-compatible changes.
Historically, `codex mcp` (or `codex mcp serve`) started a JSON-RPC-ish
server that had two overlapping responsibilities:
- Running an MCP server, providing some basic tool calls.
- Running the app server used to power experiences such as the VS Code
extension.
This PR aims to separate these into distinct concepts:
- `codex mcp-server` for the MCP server
- `codex app-server` for the "application server"
Note `codex mcp` still exists because it already has its own subcommands
for MCP management (`list`, `add`, etc.)
The MCP logic continues to live in `codex-rs/mcp-server` whereas the
refactored app server logic is in the new `codex-rs/app-server` folder.
Note that most of the existing integration tests in
`codex-rs/mcp-server/tests/suite` were actually for the app server, so
all the tests have been moved with the exception of
`codex-rs/mcp-server/tests/suite/mod.rs`.
Because this is already a large diff, I tried not to change more than I
had to, so `codex-rs/app-server/tests/common/mcp_process.rs` still uses
the name `McpProcess` for now, but I will do some mechanical renamings
to things like `AppServer` in subsequent PRs.
While `mcp-server` and `app-server` share some overlapping functionality
(like reading streams of JSONL and dispatching based on message types)
and some differences (completely different message types), I ended up
doing a bit of copypasta between the two crates, as both have somewhat
similar `message_processor.rs` and `outgoing_message.rs` files for now,
though I expect them to diverge more in the near future.
One material change is that of the initialize handshake for `codex
app-server`, as we no longer use the MCP types for that handshake.
Instead, we update `codex-rs/protocol/src/mcp_protocol.rs` to add an
`Initialize` variant to `ClientRequest`, which takes the `ClientInfo`
object we need to update the `USER_AGENT_SUFFIX` in
`codex-rs/app-server/src/message_processor.rs`.
One other material change is in
`codex-rs/app-server/src/codex_message_processor.rs` where I eliminated
a use of the `send_event_as_notification()` method I am generally trying
to deprecate (because it blindly maps an `EventMsg` into a
`JSONNotification`) in favor of `send_server_notification()`, which
takes a `ServerNotification`, as that is intended to be a custom enum of
all notification types supported by the app server. So to make this
update, I had to introduce a new variant of `ServerNotification`,
`SessionConfigured`, which is a non-backwards compatible change with the
old `codex mcp`, and clients will have to be updated after the next
release that contains this PR. Note that
`codex-rs/app-server/tests/suite/list_resume.rs` also had to be update
to reflect this change.
I introduced `codex-rs/utils/json-to-toml/src/lib.rs` as a small utility
crate to avoid some of the copying between `mcp-server` and
`app-server`.
2025-09-30 00:06:18 -07:00
|
|
|
mcp.read_stream_until_notification_message("sessionConfigured"),
|
2025-09-04 16:44:18 -07:00
|
|
|
)
|
2025-10-28 08:10:23 -07:00
|
|
|
.await??;
|
|
|
|
|
let session_configured: ServerNotification = notification.try_into()?;
|
fix: separate `codex mcp` into `codex mcp-server` and `codex app-server` (#4471)
This is a very large PR with some non-backwards-compatible changes.
Historically, `codex mcp` (or `codex mcp serve`) started a JSON-RPC-ish
server that had two overlapping responsibilities:
- Running an MCP server, providing some basic tool calls.
- Running the app server used to power experiences such as the VS Code
extension.
This PR aims to separate these into distinct concepts:
- `codex mcp-server` for the MCP server
- `codex app-server` for the "application server"
Note `codex mcp` still exists because it already has its own subcommands
for MCP management (`list`, `add`, etc.)
The MCP logic continues to live in `codex-rs/mcp-server` whereas the
refactored app server logic is in the new `codex-rs/app-server` folder.
Note that most of the existing integration tests in
`codex-rs/mcp-server/tests/suite` were actually for the app server, so
all the tests have been moved with the exception of
`codex-rs/mcp-server/tests/suite/mod.rs`.
Because this is already a large diff, I tried not to change more than I
had to, so `codex-rs/app-server/tests/common/mcp_process.rs` still uses
the name `McpProcess` for now, but I will do some mechanical renamings
to things like `AppServer` in subsequent PRs.
While `mcp-server` and `app-server` share some overlapping functionality
(like reading streams of JSONL and dispatching based on message types)
and some differences (completely different message types), I ended up
doing a bit of copypasta between the two crates, as both have somewhat
similar `message_processor.rs` and `outgoing_message.rs` files for now,
though I expect them to diverge more in the near future.
One material change is that of the initialize handshake for `codex
app-server`, as we no longer use the MCP types for that handshake.
Instead, we update `codex-rs/protocol/src/mcp_protocol.rs` to add an
`Initialize` variant to `ClientRequest`, which takes the `ClientInfo`
object we need to update the `USER_AGENT_SUFFIX` in
`codex-rs/app-server/src/message_processor.rs`.
One other material change is in
`codex-rs/app-server/src/codex_message_processor.rs` where I eliminated
a use of the `send_event_as_notification()` method I am generally trying
to deprecate (because it blindly maps an `EventMsg` into a
`JSONNotification`) in favor of `send_server_notification()`, which
takes a `ServerNotification`, as that is intended to be a custom enum of
all notification types supported by the app server. So to make this
update, I had to introduce a new variant of `ServerNotification`,
`SessionConfigured`, which is a non-backwards compatible change with the
old `codex mcp`, and clients will have to be updated after the next
release that contains this PR. Note that
`codex-rs/app-server/tests/suite/list_resume.rs` also had to be update
to reflect this change.
I introduced `codex-rs/utils/json-to-toml/src/lib.rs` as a small utility
crate to avoid some of the copying between `mcp-server` and
`app-server`.
2025-09-30 00:06:18 -07:00
|
|
|
let ServerNotification::SessionConfigured(SessionConfiguredNotification {
|
|
|
|
|
model,
|
|
|
|
|
rollout_path,
|
2025-10-28 18:18:03 -07:00
|
|
|
initial_messages: session_initial_messages,
|
fix: separate `codex mcp` into `codex mcp-server` and `codex app-server` (#4471)
This is a very large PR with some non-backwards-compatible changes.
Historically, `codex mcp` (or `codex mcp serve`) started a JSON-RPC-ish
server that had two overlapping responsibilities:
- Running an MCP server, providing some basic tool calls.
- Running the app server used to power experiences such as the VS Code
extension.
This PR aims to separate these into distinct concepts:
- `codex mcp-server` for the MCP server
- `codex app-server` for the "application server"
Note `codex mcp` still exists because it already has its own subcommands
for MCP management (`list`, `add`, etc.)
The MCP logic continues to live in `codex-rs/mcp-server` whereas the
refactored app server logic is in the new `codex-rs/app-server` folder.
Note that most of the existing integration tests in
`codex-rs/mcp-server/tests/suite` were actually for the app server, so
all the tests have been moved with the exception of
`codex-rs/mcp-server/tests/suite/mod.rs`.
Because this is already a large diff, I tried not to change more than I
had to, so `codex-rs/app-server/tests/common/mcp_process.rs` still uses
the name `McpProcess` for now, but I will do some mechanical renamings
to things like `AppServer` in subsequent PRs.
While `mcp-server` and `app-server` share some overlapping functionality
(like reading streams of JSONL and dispatching based on message types)
and some differences (completely different message types), I ended up
doing a bit of copypasta between the two crates, as both have somewhat
similar `message_processor.rs` and `outgoing_message.rs` files for now,
though I expect them to diverge more in the near future.
One material change is that of the initialize handshake for `codex
app-server`, as we no longer use the MCP types for that handshake.
Instead, we update `codex-rs/protocol/src/mcp_protocol.rs` to add an
`Initialize` variant to `ClientRequest`, which takes the `ClientInfo`
object we need to update the `USER_AGENT_SUFFIX` in
`codex-rs/app-server/src/message_processor.rs`.
One other material change is in
`codex-rs/app-server/src/codex_message_processor.rs` where I eliminated
a use of the `send_event_as_notification()` method I am generally trying
to deprecate (because it blindly maps an `EventMsg` into a
`JSONNotification`) in favor of `send_server_notification()`, which
takes a `ServerNotification`, as that is intended to be a custom enum of
all notification types supported by the app server. So to make this
update, I had to introduce a new variant of `ServerNotification`,
`SessionConfigured`, which is a non-backwards compatible change with the
old `codex mcp`, and clients will have to be updated after the next
release that contains this PR. Note that
`codex-rs/app-server/tests/suite/list_resume.rs` also had to be update
to reflect this change.
I introduced `codex-rs/utils/json-to-toml/src/lib.rs` as a small utility
crate to avoid some of the copying between `mcp-server` and
`app-server`.
2025-09-30 00:06:18 -07:00
|
|
|
..
|
|
|
|
|
}) = session_configured
|
|
|
|
|
else {
|
|
|
|
|
unreachable!("expected sessionConfigured notification");
|
|
|
|
|
};
|
|
|
|
|
assert_eq!(model, "o3");
|
2025-10-28 18:18:03 -07:00
|
|
|
assert_eq!(rollout_path, first_item.path.clone());
|
|
|
|
|
let session_initial_messages = session_initial_messages
|
|
|
|
|
.expect("expected initial messages when resuming from rollout path");
|
|
|
|
|
match session_initial_messages.as_slice() {
|
|
|
|
|
[EventMsg::UserMessage(message)] => {
|
|
|
|
|
assert_eq!(message.message, first_item.preview.clone());
|
|
|
|
|
}
|
|
|
|
|
other => panic!("unexpected initial messages from rollout resume: {other:#?}"),
|
|
|
|
|
}
|
2025-09-04 16:44:18 -07:00
|
|
|
|
|
|
|
|
// Then the response for resumeConversation
|
|
|
|
|
let resume_resp: JSONRPCResponse = timeout(
|
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
|
|
|
|
mcp.read_stream_until_response_message(RequestId::Integer(resume_req_id)),
|
|
|
|
|
)
|
2025-10-28 08:10:23 -07:00
|
|
|
.await??;
|
2025-09-04 16:44:18 -07:00
|
|
|
let ResumeConversationResponse {
|
2025-10-28 18:18:03 -07:00
|
|
|
conversation_id,
|
|
|
|
|
model: resume_model,
|
|
|
|
|
initial_messages: response_initial_messages,
|
|
|
|
|
..
|
2025-10-28 08:10:23 -07:00
|
|
|
} = to_response::<ResumeConversationResponse>(resume_resp)?;
|
2025-09-04 16:44:18 -07:00
|
|
|
// conversation id should be a valid UUID
|
2025-09-18 07:37:03 -07:00
|
|
|
assert!(!conversation_id.to_string().is_empty());
|
2025-10-28 18:18:03 -07:00
|
|
|
assert_eq!(resume_model, "o3");
|
|
|
|
|
let response_initial_messages =
|
|
|
|
|
response_initial_messages.expect("expected initial messages in resume response");
|
|
|
|
|
match response_initial_messages.as_slice() {
|
|
|
|
|
[EventMsg::UserMessage(message)] => {
|
|
|
|
|
assert_eq!(message.message, first_item.preview.clone());
|
|
|
|
|
}
|
|
|
|
|
other => panic!("unexpected initial messages in resume response: {other:#?}"),
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Resuming with only a conversation id should locate the rollout automatically.
|
|
|
|
|
let resume_by_id_req_id = mcp
|
|
|
|
|
.send_resume_conversation_request(ResumeConversationParams {
|
|
|
|
|
path: None,
|
|
|
|
|
conversation_id: Some(first_item.conversation_id),
|
|
|
|
|
history: None,
|
|
|
|
|
overrides: Some(NewConversationParams {
|
|
|
|
|
model: Some("o3".to_string()),
|
|
|
|
|
..Default::default()
|
|
|
|
|
}),
|
|
|
|
|
})
|
|
|
|
|
.await?;
|
|
|
|
|
let notification: JSONRPCNotification = timeout(
|
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
|
|
|
|
mcp.read_stream_until_notification_message("sessionConfigured"),
|
|
|
|
|
)
|
|
|
|
|
.await??;
|
|
|
|
|
let session_configured: ServerNotification = notification.try_into()?;
|
|
|
|
|
let ServerNotification::SessionConfigured(SessionConfiguredNotification {
|
|
|
|
|
model,
|
|
|
|
|
rollout_path,
|
|
|
|
|
initial_messages: session_initial_messages,
|
|
|
|
|
..
|
|
|
|
|
}) = session_configured
|
|
|
|
|
else {
|
|
|
|
|
unreachable!("expected sessionConfigured notification");
|
|
|
|
|
};
|
|
|
|
|
assert_eq!(model, "o3");
|
|
|
|
|
assert_eq!(rollout_path, first_item.path.clone());
|
|
|
|
|
let session_initial_messages = session_initial_messages
|
|
|
|
|
.expect("expected initial messages when resuming from conversation id");
|
|
|
|
|
match session_initial_messages.as_slice() {
|
|
|
|
|
[EventMsg::UserMessage(message)] => {
|
|
|
|
|
assert_eq!(message.message, first_item.preview.clone());
|
|
|
|
|
}
|
|
|
|
|
other => panic!("unexpected initial messages from conversation id resume: {other:#?}"),
|
|
|
|
|
}
|
|
|
|
|
let resume_resp: JSONRPCResponse = timeout(
|
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
|
|
|
|
mcp.read_stream_until_response_message(RequestId::Integer(resume_by_id_req_id)),
|
|
|
|
|
)
|
|
|
|
|
.await??;
|
|
|
|
|
let ResumeConversationResponse {
|
|
|
|
|
conversation_id: by_id_conversation_id,
|
|
|
|
|
model: by_id_model,
|
|
|
|
|
initial_messages: by_id_initial_messages,
|
|
|
|
|
..
|
|
|
|
|
} = to_response::<ResumeConversationResponse>(resume_resp)?;
|
|
|
|
|
assert!(!by_id_conversation_id.to_string().is_empty());
|
|
|
|
|
assert_eq!(by_id_model, "o3");
|
|
|
|
|
let by_id_initial_messages = by_id_initial_messages
|
|
|
|
|
.expect("expected initial messages when resuming from conversation id response");
|
|
|
|
|
match by_id_initial_messages.as_slice() {
|
|
|
|
|
[EventMsg::UserMessage(message)] => {
|
|
|
|
|
assert_eq!(message.message, first_item.preview.clone());
|
|
|
|
|
}
|
|
|
|
|
other => {
|
|
|
|
|
panic!("unexpected initial messages in conversation id resume response: {other:#?}")
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Resuming with explicit history should succeed even without a stored rollout.
|
|
|
|
|
let fork_history_text = "Hello from history";
|
|
|
|
|
let history = vec![ResponseItem::Message {
|
|
|
|
|
id: None,
|
|
|
|
|
role: "user".to_string(),
|
|
|
|
|
content: vec![ContentItem::InputText {
|
|
|
|
|
text: fork_history_text.to_string(),
|
|
|
|
|
}],
|
|
|
|
|
}];
|
|
|
|
|
let resume_with_history_req_id = mcp
|
|
|
|
|
.send_resume_conversation_request(ResumeConversationParams {
|
|
|
|
|
path: None,
|
|
|
|
|
conversation_id: None,
|
|
|
|
|
history: Some(history),
|
|
|
|
|
overrides: Some(NewConversationParams {
|
|
|
|
|
model: Some("o3".to_string()),
|
|
|
|
|
..Default::default()
|
|
|
|
|
}),
|
|
|
|
|
})
|
|
|
|
|
.await?;
|
|
|
|
|
let notification: JSONRPCNotification = timeout(
|
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
|
|
|
|
mcp.read_stream_until_notification_message("sessionConfigured"),
|
|
|
|
|
)
|
|
|
|
|
.await??;
|
|
|
|
|
let session_configured: ServerNotification = notification.try_into()?;
|
|
|
|
|
let ServerNotification::SessionConfigured(SessionConfiguredNotification {
|
|
|
|
|
model,
|
|
|
|
|
initial_messages: session_initial_messages,
|
|
|
|
|
..
|
|
|
|
|
}) = session_configured
|
|
|
|
|
else {
|
|
|
|
|
unreachable!("expected sessionConfigured notification");
|
|
|
|
|
};
|
|
|
|
|
assert_eq!(model, "o3");
|
|
|
|
|
assert!(
|
|
|
|
|
session_initial_messages.as_ref().is_none_or(Vec::is_empty),
|
|
|
|
|
"expected no initial messages when resuming from explicit history but got {session_initial_messages:#?}"
|
|
|
|
|
);
|
|
|
|
|
let resume_resp: JSONRPCResponse = timeout(
|
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
|
|
|
|
mcp.read_stream_until_response_message(RequestId::Integer(resume_with_history_req_id)),
|
|
|
|
|
)
|
|
|
|
|
.await??;
|
|
|
|
|
let ResumeConversationResponse {
|
|
|
|
|
conversation_id: history_conversation_id,
|
|
|
|
|
model: history_model,
|
|
|
|
|
initial_messages: history_initial_messages,
|
|
|
|
|
..
|
|
|
|
|
} = to_response::<ResumeConversationResponse>(resume_resp)?;
|
|
|
|
|
assert!(!history_conversation_id.to_string().is_empty());
|
|
|
|
|
assert_eq!(history_model, "o3");
|
|
|
|
|
assert!(
|
|
|
|
|
history_initial_messages.as_ref().is_none_or(Vec::is_empty),
|
|
|
|
|
"expected no initial messages in resume response when history is provided but got {history_initial_messages:#?}"
|
|
|
|
|
);
|
2025-10-28 08:10:23 -07:00
|
|
|
|
|
|
|
|
Ok(())
|
2025-09-04 16:44:18 -07:00
|
|
|
}
|