Skip to content

Migrate external MCP server config #16804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
starr-openai wants to merge 1 commit into from
+273 −11
Closed

Migrate external MCP server config #16804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions codex-rs/app-server/src/message_processor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1020,10 +1020,11 @@ impl MessageProcessor {
request_id: ConnectionRequestId,
params: ExternalAgentConfigImportParams,
) {
match self.external_agent_config_api.import(params).await {
Ok(response) => self.outgoing.send_response(request_id, response).await,
Err(error) => self.outgoing.send_error(request_id, error).await,
}
self.handle_config_mutation_result(
request_id,
self.external_agent_config_api.import(params).await,
)
.await;
}

async fn handle_fs_read_file(&self, request_id: ConnectionRequestId, params: FsReadFileParams) {
Expand Down
178 changes: 171 additions & 7 deletions codex-rs/core/src/external_agent_config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
use codex_config::types::McpServerConfig;
use serde_json::Value as JsonValue;
use std::collections::BTreeMap;
use std::collections::HashSet;
use std::ffi::OsString;
use std::fs;
Expand All @@ -9,6 +11,7 @@ use toml::Value as TomlValue;

const EXTERNAL_AGENT_CONFIG_DETECT_METRIC: &str = "codex.external_agent_config.detect";
const EXTERNAL_AGENT_CONFIG_IMPORT_METRIC: &str = "codex.external_agent_config.import";
const MCP_SERVERS_CONFIG_KEY: &str = "mcp_servers";

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ExternalAgentConfigDetectOptions {
Expand Down Expand Up @@ -100,7 +103,14 @@ impl ExternalAgentConfigService {
/*skills_count*/ None,
);
}
ExternalAgentConfigMigrationItemType::McpServerConfig => {}
ExternalAgentConfigMigrationItemType::McpServerConfig => {
self.import_mcp_server_config(migration_item.cwd.as_deref())?;
emit_migration_metric(
EXTERNAL_AGENT_CONFIG_IMPORT_METRIC,
ExternalAgentConfigMigrationItemType::McpServerConfig,
/*skills_count*/ None,
);
}
}
}

Expand All @@ -122,9 +132,7 @@ impl ExternalAgentConfigService {
|repo_root| repo_root.join(".codex").join("config.toml"),
);
if source_settings.is_file() {
let raw_settings = fs::read_to_string(&source_settings)?;
let settings: JsonValue = serde_json::from_str(&raw_settings)
.map_err(|err| invalid_data_error(err.to_string()))?;
let settings = read_external_settings(&source_settings)?;
let migrated = build_config_from_external(&settings)?;
if !is_empty_toml_table(&migrated) {
let mut should_include = true;
Expand Down Expand Up @@ -157,6 +165,39 @@ impl ExternalAgentConfigService {
);
}
}

let migrated_mcp = build_mcp_server_config_from_external(&settings)?;
if !is_empty_toml_table(&migrated_mcp) {
let mut should_include = true;
if target_config.exists() {
let existing_raw = fs::read_to_string(&target_config)?;
let mut existing = if existing_raw.trim().is_empty() {
TomlValue::Table(Default::default())
} else {
toml::from_str::<TomlValue>(&existing_raw).map_err(|err| {
invalid_data_error(format!("invalid existing config.toml: {err}"))
})?
};
should_include = merge_missing_toml_values(&mut existing, &migrated_mcp)?;
}

if should_include {
items.push(ExternalAgentConfigMigrationItem {
item_type: ExternalAgentConfigMigrationItemType::McpServerConfig,
description: format!(
"Migrate MCP servers from {} into {}",
source_settings.display(),
target_config.display()
),
cwd: cwd.clone(),
});
emit_migration_metric(
EXTERNAL_AGENT_CONFIG_DETECT_METRIC,
ExternalAgentConfigMigrationItemType::McpServerConfig,
/*skills_count*/ None,
);
}
}
}

let source_skills = repo_root.map_or_else(
Expand Down Expand Up @@ -242,9 +283,7 @@ impl ExternalAgentConfigService {
return Ok(());
}

let raw_settings = fs::read_to_string(&source_settings)?;
let settings: JsonValue = serde_json::from_str(&raw_settings)
.map_err(|err| invalid_data_error(err.to_string()))?;
let settings = read_external_settings(&source_settings)?;
let migrated = build_config_from_external(&settings)?;
if is_empty_toml_table(&migrated) {
return Ok(());
Expand Down Expand Up @@ -276,6 +315,56 @@ impl ExternalAgentConfigService {
Ok(())
}

fn import_mcp_server_config(&self, cwd: Option<&Path>) -> io::Result<()> {
let (source_settings, target_config) = if let Some(repo_root) = find_repo_root(cwd)? {
(
repo_root.join(".claude").join("settings.json"),
repo_root.join(".codex").join("config.toml"),
)
} else if cwd.is_some_and(|cwd| !cwd.as_os_str().is_empty()) {
return Ok(());
} else {
(
self.claude_home.join("settings.json"),
self.codex_home.join("config.toml"),
)
};
if !source_settings.is_file() {
return Ok(());
}

let settings = read_external_settings(&source_settings)?;
let migrated = build_mcp_server_config_from_external(&settings)?;
if is_empty_toml_table(&migrated) {
return Ok(());
}

let Some(target_parent) = target_config.parent() else {
return Err(invalid_data_error("config target path has no parent"));
};
fs::create_dir_all(target_parent)?;
if !target_config.exists() {
write_toml_file(&target_config, &migrated)?;
return Ok(());
}

let existing_raw = fs::read_to_string(&target_config)?;
let mut existing = if existing_raw.trim().is_empty() {
TomlValue::Table(Default::default())
} else {
toml::from_str::<TomlValue>(&existing_raw)
.map_err(|err| invalid_data_error(format!("invalid existing config.toml: {err}")))?
};

let changed = merge_missing_toml_values(&mut existing, &migrated)?;
if !changed {
return Ok(());
}

write_toml_file(&target_config, &existing)?;
Ok(())
}

fn import_skills(&self, cwd: Option<&Path>) -> io::Result<usize> {
let (source_skills, target_skills) = if let Some(repo_root) = find_repo_root(cwd)? {
(
Expand Down Expand Up @@ -353,6 +442,11 @@ fn default_claude_home() -> PathBuf {
PathBuf::from(".claude")
}

fn read_external_settings(source_settings: &Path) -> io::Result<JsonValue> {
let raw_settings = fs::read_to_string(source_settings)?;
serde_json::from_str(&raw_settings).map_err(|err| invalid_data_error(err.to_string()))
}

fn find_repo_root(cwd: Option<&Path>) -> io::Result<Option<PathBuf>> {
let Some(cwd) = cwd.filter(|cwd| !cwd.as_os_str().is_empty()) else {
return Ok(None);
Expand Down Expand Up @@ -581,6 +675,76 @@ fn build_config_from_external(settings: &JsonValue) -> io::Result<TomlValue> {
Ok(TomlValue::Table(root))
}

fn build_mcp_server_config_from_external(settings: &JsonValue) -> io::Result<TomlValue> {
let Some(settings_obj) = settings.as_object() else {
return Err(invalid_data_error(
"external agent settings root must be an object",
));
};
let Some(mcp_servers) = settings_obj.get("mcpServers") else {
return Ok(TomlValue::Table(Default::default()));
};
let Some(mcp_servers) = mcp_servers.as_object() else {
return Err(invalid_data_error("external mcpServers must be an object"));
};

let mut parsed_servers: BTreeMap<String, McpServerConfig> = BTreeMap::new();
for (server_name, raw_config) in mcp_servers {
let raw_config = normalize_external_mcp_server_config(raw_config).map_err(|err| {
invalid_data_error(format!("invalid external mcpServers.{server_name}: {err}"))
})?;
let server_config =
serde_json::from_value::<McpServerConfig>(raw_config).map_err(|err| {
invalid_data_error(format!("invalid external mcpServers.{server_name}: {err}"))
})?;
parsed_servers.insert(server_name.clone(), server_config);
}

if parsed_servers.is_empty() {
return Ok(TomlValue::Table(Default::default()));
}

let mcp_servers = TomlValue::try_from(parsed_servers)
.map_err(|err| invalid_data_error(format!("failed to serialize mcp_servers: {err}")))?;
Ok(TomlValue::Table(toml::map::Map::from_iter([(
MCP_SERVERS_CONFIG_KEY.to_string(),
mcp_servers,
)])))
}

fn normalize_external_mcp_server_config(raw_config: &JsonValue) -> io::Result<JsonValue> {
let Some(raw_object) = raw_config.as_object() else {
return Err(invalid_data_error("MCP server config must be an object"));
};

let mut normalized = serde_json::Map::new();
for (key, value) in raw_object {
if key == "type" {
continue;
}
normalized.insert(
normalize_external_mcp_server_key(key).to_string(),
value.clone(),
);
}
Ok(JsonValue::Object(normalized))
}

fn normalize_external_mcp_server_key(key: &str) -> &str {
match key {
"bearerTokenEnvVar" => "bearer_token_env_var",
"disabledTools" => "disabled_tools",
"enabledTools" => "enabled_tools",
"envHttpHeaders" => "env_http_headers",
"httpHeaders" => "http_headers",
"oauthResource" => "oauth_resource",
"startupTimeoutMs" => "startup_timeout_ms",
"startupTimeoutSec" => "startup_timeout_sec",
"toolTimeoutSec" => "tool_timeout_sec",
_ => key,
}
}

fn json_object_to_env_toml_table(
object: &serde_json::Map<String, JsonValue>,
) -> toml::map::Map<String, TomlValue> {
Expand Down
97 changes: 97 additions & 0 deletions codex-rs/core/src/external_agent_config_tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,37 @@ fn detect_home_lists_config_skills_and_agents_md() {
assert_eq!(items, expected);
}

#[test]
fn detect_home_lists_mcp_server_config() {
let (_root, claude_home, codex_home) = fixture_paths();
fs::create_dir_all(&claude_home).expect("create claude home");
fs::write(
claude_home.join("settings.json"),
r#"{"mcpServers":{"docs":{"command":"docs-server","args":["--stdio"]}}}"#,
)
.expect("write settings");

let items = service_for_paths(claude_home.clone(), codex_home.clone())
.detect(ExternalAgentConfigDetectOptions {
include_home: true,
cwds: None,
})
.expect("detect");

assert_eq!(
items,
vec![ExternalAgentConfigMigrationItem {
item_type: ExternalAgentConfigMigrationItemType::McpServerConfig,
description: format!(
"Migrate MCP servers from {} into {}",
claude_home.join("settings.json").display(),
codex_home.join("config.toml").display(),
),
cwd: None,
}]
);
}

#[test]
fn detect_repo_lists_agents_md_for_each_cwd() {
let root = TempDir::new().expect("create tempdir");
Expand Down Expand Up @@ -164,6 +195,72 @@ fn import_home_migrates_supported_config_fields_skills_and_agents_md() {
);
}

#[test]
fn import_home_migrates_mcp_server_config() {
let (_root, claude_home, codex_home) = fixture_paths();
fs::create_dir_all(&claude_home).expect("create claude home");
fs::write(
claude_home.join("settings.json"),
r#"{
"mcpServers": {
"docs": {
"command": "docs-server",
"args": ["--stdio"],
"env": { "DOCS_TOKEN": "abc" },
"startupTimeoutMs": 1500,
"toolTimeoutSec": 2.5,
"enabledTools": ["search"],
"required": true
},
"linear": {
"url": "https://linear.example/mcp",
"bearerTokenEnvVar": "LINEAR_TOKEN",
"httpHeaders": { "X-Client": "Codex" },
"envHttpHeaders": { "X-Auth": "LINEAR_HEADER_TOKEN" },
"disabledTools": ["mutate"],
"oauthResource": "linear-resource"
}
}
}"#,
)
.expect("write settings");

service_for_paths(claude_home, codex_home.clone())
.import(vec![ExternalAgentConfigMigrationItem {
item_type: ExternalAgentConfigMigrationItemType::McpServerConfig,
description: String::new(),
cwd: None,
}])
.expect("import");

assert_eq!(
fs::read_to_string(codex_home.join("config.toml")).expect("read config"),
r#"[mcp_servers.docs]
command = "docs-server"
args = ["--stdio"]
required = true
startup_timeout_sec = 1.5
tool_timeout_sec = 2.5
enabled_tools = ["search"]

[mcp_servers.docs.env]
DOCS_TOKEN = "abc"

[mcp_servers.linear]
url = "https://linear.example/mcp"
bearer_token_env_var = "LINEAR_TOKEN"
disabled_tools = ["mutate"]
oauth_resource = "linear-resource"

[mcp_servers.linear.http_headers]
X-Client = "Codex"

[mcp_servers.linear.env_http_headers]
X-Auth = "LINEAR_HEADER_TOKEN"
"#
);
}

#[test]
fn import_home_skips_empty_config_migration() {
let (_root, claude_home, codex_home) = fixture_paths();
Expand Down
Loading