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;
|
|
|
|
|
|
use app_test_support::create_final_assistant_message_sse_response;
|
|
|
|
|
|
use app_test_support::create_mock_chat_completions_server;
|
|
|
|
|
|
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::AddConversationListenerParams;
|
|
|
|
|
|
use codex_app_server_protocol::AddConversationSubscriptionResponse;
|
|
|
|
|
|
use codex_app_server_protocol::InputItem;
|
|
|
|
|
|
use codex_app_server_protocol::JSONRPCResponse;
|
|
|
|
|
|
use codex_app_server_protocol::NewConversationParams;
|
|
|
|
|
|
use codex_app_server_protocol::NewConversationResponse;
|
|
|
|
|
|
use codex_app_server_protocol::RequestId;
|
|
|
|
|
|
use codex_app_server_protocol::SendUserMessageParams;
|
|
|
|
|
|
use codex_app_server_protocol::SendUserMessageResponse;
|
2025-08-01 15:18:36 -07:00
|
|
|
|
use pretty_assertions::assert_eq;
|
|
|
|
|
|
use serde_json::json;
|
2025-10-28 08:10:23 -07:00
|
|
|
|
use std::path::Path;
|
2025-08-01 15:18:36 -07:00
|
|
|
|
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_conversation_create_and_send_message_ok() -> Result<()> {
|
2025-08-01 15:18:36 -07:00
|
|
|
|
// Mock server – we won't strictly rely on it, but provide one to satisfy any model wiring.
|
2025-10-28 08:10:23 -07:00
|
|
|
|
let responses = vec![create_final_assistant_message_sse_response("Done")?];
|
2025-08-01 15:18:36 -07:00
|
|
|
|
let server = create_mock_chat_completions_server(responses).await;
|
|
|
|
|
|
|
|
|
|
|
|
// Temporary Codex home with config pointing at the mock server.
|
2025-10-28 08:10:23 -07:00
|
|
|
|
let codex_home = TempDir::new()?;
|
|
|
|
|
|
create_config_toml(codex_home.path(), &server.uri())?;
|
2025-08-01 15:18:36 -07:00
|
|
|
|
|
|
|
|
|
|
// Start MCP server process and initialize.
|
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-08-01 15:18:36 -07:00
|
|
|
|
|
2025-08-18 00:29:18 -07:00
|
|
|
|
// Create a conversation via the new JSON-RPC API.
|
|
|
|
|
|
let new_conv_id = mcp
|
|
|
|
|
|
.send_new_conversation_request(NewConversationParams {
|
|
|
|
|
|
model: Some("o3".to_string()),
|
|
|
|
|
|
..Default::default()
|
|
|
|
|
|
})
|
2025-10-28 08:10:23 -07:00
|
|
|
|
.await?;
|
2025-08-18 00:29:18 -07:00
|
|
|
|
let new_conv_resp: JSONRPCResponse = timeout(
|
2025-08-01 15:18:36 -07:00
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
2025-08-18 00:29:18 -07:00
|
|
|
|
mcp.read_stream_until_response_message(RequestId::Integer(new_conv_id)),
|
2025-08-01 15:18:36 -07:00
|
|
|
|
)
|
2025-10-28 08:10:23 -07:00
|
|
|
|
.await??;
|
2025-08-18 00:29:18 -07:00
|
|
|
|
let NewConversationResponse {
|
|
|
|
|
|
conversation_id,
|
|
|
|
|
|
model,
|
2025-09-11 21:04:40 -07:00
|
|
|
|
reasoning_effort: _,
|
2025-09-09 00:11:48 -07:00
|
|
|
|
rollout_path: _,
|
2025-10-28 08:10:23 -07:00
|
|
|
|
} = to_response::<NewConversationResponse>(new_conv_resp)?;
|
2025-08-18 00:29:18 -07:00
|
|
|
|
assert_eq!(model, "o3");
|
2025-08-01 15:18:36 -07:00
|
|
|
|
|
2025-08-18 00:29:18 -07:00
|
|
|
|
// Add a listener so we receive notifications for this conversation (not strictly required for this test).
|
|
|
|
|
|
let add_listener_id = mcp
|
2025-10-24 15:41:52 -07:00
|
|
|
|
.send_add_conversation_listener_request(AddConversationListenerParams {
|
|
|
|
|
|
conversation_id,
|
|
|
|
|
|
experimental_raw_events: false,
|
|
|
|
|
|
})
|
2025-10-28 08:10:23 -07:00
|
|
|
|
.await?;
|
2025-08-18 00:29:18 -07:00
|
|
|
|
let _sub: AddConversationSubscriptionResponse =
|
|
|
|
|
|
to_response::<AddConversationSubscriptionResponse>(
|
|
|
|
|
|
timeout(
|
|
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
|
|
|
|
|
mcp.read_stream_until_response_message(RequestId::Integer(add_listener_id)),
|
|
|
|
|
|
)
|
2025-10-28 08:10:23 -07:00
|
|
|
|
.await??,
|
|
|
|
|
|
)?;
|
2025-08-01 15:18:36 -07:00
|
|
|
|
|
2025-08-18 00:29:18 -07:00
|
|
|
|
// Now send a user message via the wire API and expect an OK (empty object) result.
|
2025-08-01 15:18:36 -07:00
|
|
|
|
let send_id = mcp
|
2025-08-18 00:29:18 -07:00
|
|
|
|
.send_send_user_message_request(SendUserMessageParams {
|
|
|
|
|
|
conversation_id,
|
|
|
|
|
|
items: vec![InputItem::Text {
|
|
|
|
|
|
text: "Hello".to_string(),
|
|
|
|
|
|
}],
|
|
|
|
|
|
})
|
2025-10-28 08:10:23 -07:00
|
|
|
|
.await?;
|
2025-08-01 15:18:36 -07:00
|
|
|
|
let send_resp: JSONRPCResponse = timeout(
|
|
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
|
|
|
|
|
mcp.read_stream_until_response_message(RequestId::Integer(send_id)),
|
|
|
|
|
|
)
|
2025-10-28 08:10:23 -07:00
|
|
|
|
.await??;
|
|
|
|
|
|
let _ok: SendUserMessageResponse = to_response::<SendUserMessageResponse>(send_resp)?;
|
2025-08-01 15:18:36 -07:00
|
|
|
|
|
|
|
|
|
|
// avoid race condition by waiting for the mock server to receive the chat.completions request
|
|
|
|
|
|
let deadline = std::time::Instant::now() + DEFAULT_READ_TIMEOUT;
|
2025-10-28 08:10:23 -07:00
|
|
|
|
let requests = loop {
|
2025-08-01 15:18:36 -07:00
|
|
|
|
let requests = server.received_requests().await.unwrap_or_default();
|
|
|
|
|
|
if !requests.is_empty() {
|
2025-10-28 08:10:23 -07:00
|
|
|
|
break requests;
|
2025-08-01 15:18:36 -07:00
|
|
|
|
}
|
|
|
|
|
|
if std::time::Instant::now() >= deadline {
|
|
|
|
|
|
panic!("mock server did not receive the chat.completions request in time");
|
|
|
|
|
|
}
|
|
|
|
|
|
tokio::time::sleep(std::time::Duration::from_millis(10)).await;
|
2025-10-28 08:10:23 -07:00
|
|
|
|
};
|
2025-08-01 15:18:36 -07:00
|
|
|
|
|
|
|
|
|
|
// Verify the outbound request body matches expectations for Chat Completions.
|
2025-10-28 08:10:23 -07:00
|
|
|
|
let request = requests
|
|
|
|
|
|
.first()
|
|
|
|
|
|
.expect("mock server should have received at least one request");
|
|
|
|
|
|
let body = request.body_json::<serde_json::Value>()?;
|
2025-08-01 15:18:36 -07:00
|
|
|
|
assert_eq!(body["model"], json!("o3"));
|
|
|
|
|
|
assert!(body["stream"].as_bool().unwrap_or(false));
|
|
|
|
|
|
let messages = body["messages"]
|
|
|
|
|
|
.as_array()
|
|
|
|
|
|
.expect("messages should be array");
|
|
|
|
|
|
let last = messages.last().expect("at least one message");
|
|
|
|
|
|
assert_eq!(last["role"], json!("user"));
|
|
|
|
|
|
assert_eq!(last["content"], json!("Hello"));
|
|
|
|
|
|
|
|
|
|
|
|
drop(server);
|
2025-10-28 08:10:23 -07:00
|
|
|
|
Ok(())
|
2025-08-01 15:18:36 -07:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
// Helper to create a config.toml pointing at the mock model server.
|
|
|
|
|
|
fn create_config_toml(codex_home: &Path, server_uri: &str) -> std::io::Result<()> {
|
|
|
|
|
|
let config_toml = codex_home.join("config.toml");
|
|
|
|
|
|
std::fs::write(
|
|
|
|
|
|
config_toml,
|
|
|
|
|
|
format!(
|
|
|
|
|
|
r#"
|
|
|
|
|
|
model = "mock-model"
|
|
|
|
|
|
approval_policy = "never"
|
|
|
|
|
|
sandbox_mode = "danger-full-access"
|
|
|
|
|
|
|
|
|
|
|
|
model_provider = "mock_provider"
|
|
|
|
|
|
|
|
|
|
|
|
[model_providers.mock_provider]
|
|
|
|
|
|
name = "Mock provider for test"
|
|
|
|
|
|
base_url = "{server_uri}/v1"
|
|
|
|
|
|
wire_api = "chat"
|
|
|
|
|
|
request_max_retries = 0
|
|
|
|
|
|
stream_max_retries = 0
|
|
|
|
|
|
"#
|
|
|
|
|
|
),
|
|
|
|
|
|
)
|
|
|
|
|
|
}
|