2025-10-02 18:19:13 -07:00
|
|
|
use anyhow::Context;
|
|
|
|
|
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;
|
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::JSONRPCResponse;
|
|
|
|
|
use codex_app_server_protocol::RequestId;
|
2025-09-29 12:19:09 -07:00
|
|
|
use pretty_assertions::assert_eq;
|
|
|
|
|
use serde_json::json;
|
|
|
|
|
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-02 18:19:13 -07:00
|
|
|
async fn test_fuzzy_file_search_sorts_and_includes_indices() -> Result<()> {
|
2025-09-29 12:19:09 -07:00
|
|
|
// Prepare a temporary Codex home and a separate root with test files.
|
2025-10-02 18:19:13 -07:00
|
|
|
let codex_home = TempDir::new().context("create temp codex home")?;
|
|
|
|
|
let root = TempDir::new().context("create temp search root")?;
|
2025-09-29 12:19:09 -07:00
|
|
|
|
2025-10-02 18:19:13 -07:00
|
|
|
// Create files designed to have deterministic ordering for query "abe".
|
|
|
|
|
std::fs::write(root.path().join("abc"), "x").context("write file abc")?;
|
|
|
|
|
std::fs::write(root.path().join("abcde"), "x").context("write file abcde")?;
|
|
|
|
|
std::fs::write(root.path().join("abexy"), "x").context("write file abexy")?;
|
|
|
|
|
std::fs::write(root.path().join("zzz.txt"), "x").context("write file zzz")?;
|
|
|
|
|
let sub_dir = root.path().join("sub");
|
|
|
|
|
std::fs::create_dir_all(&sub_dir).context("create sub dir")?;
|
|
|
|
|
let sub_abce_path = sub_dir.join("abce");
|
|
|
|
|
std::fs::write(&sub_abce_path, "x").context("write file sub/abce")?;
|
|
|
|
|
let sub_abce_rel = sub_abce_path
|
|
|
|
|
.strip_prefix(root.path())
|
|
|
|
|
.context("strip root prefix from sub/abce")?
|
|
|
|
|
.to_string_lossy()
|
|
|
|
|
.to_string();
|
2025-09-29 12:19:09 -07:00
|
|
|
|
|
|
|
|
// Start MCP server and initialize.
|
2025-10-02 18:19:13 -07:00
|
|
|
let mut mcp = McpProcess::new(codex_home.path())
|
|
|
|
|
.await
|
|
|
|
|
.context("spawn mcp")?;
|
2025-09-29 12:19:09 -07:00
|
|
|
timeout(DEFAULT_READ_TIMEOUT, mcp.initialize())
|
|
|
|
|
.await
|
2025-10-02 18:19:13 -07:00
|
|
|
.context("init timeout")?
|
|
|
|
|
.context("init failed")?;
|
2025-09-29 12:19:09 -07:00
|
|
|
|
|
|
|
|
let root_path = root.path().to_string_lossy().to_string();
|
|
|
|
|
// Send fuzzyFileSearch request.
|
|
|
|
|
let request_id = mcp
|
|
|
|
|
.send_fuzzy_file_search_request("abe", vec![root_path.clone()], None)
|
|
|
|
|
.await
|
2025-10-02 18:19:13 -07:00
|
|
|
.context("send fuzzyFileSearch")?;
|
2025-09-29 12:19:09 -07:00
|
|
|
|
|
|
|
|
// Read response and verify shape and ordering.
|
|
|
|
|
let resp: JSONRPCResponse = timeout(
|
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
|
|
|
|
mcp.read_stream_until_response_message(RequestId::Integer(request_id)),
|
|
|
|
|
)
|
|
|
|
|
.await
|
2025-10-02 18:19:13 -07:00
|
|
|
.context("fuzzyFileSearch timeout")?
|
|
|
|
|
.context("fuzzyFileSearch resp")?;
|
2025-09-29 12:19:09 -07:00
|
|
|
|
|
|
|
|
let value = resp.result;
|
2025-10-02 18:19:13 -07:00
|
|
|
// The path separator on Windows affects the score.
|
|
|
|
|
let expected_score = if cfg!(windows) { 69 } else { 72 };
|
|
|
|
|
|
2025-09-29 12:19:09 -07:00
|
|
|
assert_eq!(
|
|
|
|
|
value,
|
|
|
|
|
json!({
|
|
|
|
|
"files": [
|
2025-10-02 18:19:13 -07:00
|
|
|
{
|
|
|
|
|
"root": root_path.clone(),
|
|
|
|
|
"path": "abexy",
|
|
|
|
|
"file_name": "abexy",
|
|
|
|
|
"score": 88,
|
|
|
|
|
"indices": [0, 1, 2],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"root": root_path.clone(),
|
|
|
|
|
"path": "abcde",
|
|
|
|
|
"file_name": "abcde",
|
|
|
|
|
"score": 74,
|
|
|
|
|
"indices": [0, 1, 4],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"root": root_path.clone(),
|
|
|
|
|
"path": sub_abce_rel,
|
|
|
|
|
"file_name": "abce",
|
|
|
|
|
"score": expected_score,
|
|
|
|
|
"indices": [4, 5, 7],
|
|
|
|
|
},
|
2025-09-29 12:19:09 -07:00
|
|
|
]
|
|
|
|
|
})
|
|
|
|
|
);
|
2025-10-02 18:19:13 -07:00
|
|
|
|
|
|
|
|
Ok(())
|
2025-09-29 12:19:09 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
2025-10-02 18:19:13 -07:00
|
|
|
async fn test_fuzzy_file_search_accepts_cancellation_token() -> Result<()> {
|
|
|
|
|
let codex_home = TempDir::new().context("create temp codex home")?;
|
|
|
|
|
let root = TempDir::new().context("create temp search root")?;
|
2025-09-29 12:19:09 -07:00
|
|
|
|
2025-10-02 18:19:13 -07:00
|
|
|
std::fs::write(root.path().join("alpha.txt"), "contents").context("write alpha")?;
|
2025-09-29 12:19:09 -07:00
|
|
|
|
2025-10-02 18:19:13 -07:00
|
|
|
let mut mcp = McpProcess::new(codex_home.path())
|
|
|
|
|
.await
|
|
|
|
|
.context("spawn mcp")?;
|
2025-09-29 12:19:09 -07:00
|
|
|
timeout(DEFAULT_READ_TIMEOUT, mcp.initialize())
|
|
|
|
|
.await
|
2025-10-02 18:19:13 -07:00
|
|
|
.context("init timeout")?
|
|
|
|
|
.context("init failed")?;
|
2025-09-29 12:19:09 -07:00
|
|
|
|
|
|
|
|
let root_path = root.path().to_string_lossy().to_string();
|
|
|
|
|
let request_id = mcp
|
|
|
|
|
.send_fuzzy_file_search_request("alp", vec![root_path.clone()], None)
|
|
|
|
|
.await
|
2025-10-02 18:19:13 -07:00
|
|
|
.context("send fuzzyFileSearch")?;
|
2025-09-29 12:19:09 -07:00
|
|
|
|
|
|
|
|
let request_id_2 = mcp
|
|
|
|
|
.send_fuzzy_file_search_request(
|
|
|
|
|
"alp",
|
|
|
|
|
vec![root_path.clone()],
|
|
|
|
|
Some(request_id.to_string()),
|
|
|
|
|
)
|
|
|
|
|
.await
|
2025-10-02 18:19:13 -07:00
|
|
|
.context("send fuzzyFileSearch")?;
|
2025-09-29 12:19:09 -07:00
|
|
|
|
|
|
|
|
let resp: JSONRPCResponse = timeout(
|
|
|
|
|
DEFAULT_READ_TIMEOUT,
|
|
|
|
|
mcp.read_stream_until_response_message(RequestId::Integer(request_id_2)),
|
|
|
|
|
)
|
|
|
|
|
.await
|
2025-10-02 18:19:13 -07:00
|
|
|
.context("fuzzyFileSearch timeout")?
|
|
|
|
|
.context("fuzzyFileSearch resp")?;
|
2025-09-29 12:19:09 -07:00
|
|
|
|
|
|
|
|
let files = resp
|
|
|
|
|
.result
|
|
|
|
|
.get("files")
|
2025-10-02 18:19:13 -07:00
|
|
|
.context("files key missing")?
|
|
|
|
|
.as_array()
|
|
|
|
|
.context("files not array")?
|
|
|
|
|
.clone();
|
2025-09-29 12:19:09 -07:00
|
|
|
|
|
|
|
|
assert_eq!(files.len(), 1);
|
|
|
|
|
assert_eq!(files[0]["root"], root_path);
|
|
|
|
|
assert_eq!(files[0]["path"], "alpha.txt");
|
2025-10-02 18:19:13 -07:00
|
|
|
|
|
|
|
|
Ok(())
|
2025-09-29 12:19:09 -07:00
|
|
|
}
|