BREAKING CHANGE: The [mcp.servers] format was completely incorrect and not any official Codex format. The only correct format is [mcp_servers] at the top level of config.toml. Changes: - Remove incorrect [mcp.servers] nested table support - Always use [mcp_servers] top-level table (official Codex format) - Auto-migrate and cleanup erroneous [mcp.servers] entries on write - Preserve error-tolerant import for migrating old incorrect configs - Simplify sync logic by removing format selection branches (~60 lines) - Update all documentation and tests to reflect correct format - Add warning logs when detecting and cleaning incorrect format Backend (Rust): - mcp.rs: Simplify sync_enabled_to_codex by removing Target enum - mcp.rs: sync_single_server_to_codex now always uses [mcp_servers] - mcp.rs: remove_server_from_codex cleans both locations - mcp.rs: Update import_from_codex comments to clarify format status - tests: Rename test to sync_enabled_to_codex_migrates_erroneous_* - tests: Update assertions to verify migration behavior Frontend (TypeScript): - tomlUtils.ts: Prioritize [mcp_servers] format in parsing - tomlUtils.ts: Update error messages to guide correct format Documentation: - README.md: Correct MCP format reference to [mcp_servers] - CLAUDE.md: Add comprehensive format specification with examples All 79 tests pass. This ensures backward compatibility while enforcing the correct Codex official standard going forward. Refs: https://github.com/openai/codex/issues/3441
306 lines
9.0 KiB
Rust
306 lines
9.0 KiB
Rust
use serde::{Deserialize, Serialize};
|
||
use serde_json::{Map, Value};
|
||
use std::env;
|
||
use std::fs;
|
||
use std::path::{Path, PathBuf};
|
||
|
||
use crate::config::{atomic_write, get_claude_mcp_path, get_default_claude_mcp_path};
|
||
use crate::error::AppError;
|
||
|
||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||
#[serde(rename_all = "camelCase")]
|
||
pub struct McpStatus {
|
||
pub user_config_path: String,
|
||
pub user_config_exists: bool,
|
||
pub server_count: usize,
|
||
}
|
||
|
||
fn user_config_path() -> PathBuf {
|
||
ensure_mcp_override_migrated();
|
||
get_claude_mcp_path()
|
||
}
|
||
|
||
fn ensure_mcp_override_migrated() {
|
||
if crate::settings::get_claude_override_dir().is_none() {
|
||
return;
|
||
}
|
||
|
||
let new_path = get_claude_mcp_path();
|
||
if new_path.exists() {
|
||
return;
|
||
}
|
||
|
||
let legacy_path = get_default_claude_mcp_path();
|
||
if !legacy_path.exists() {
|
||
return;
|
||
}
|
||
|
||
if let Some(parent) = new_path.parent() {
|
||
if let Err(err) = fs::create_dir_all(parent) {
|
||
log::warn!("创建 MCP 目录失败: {err}");
|
||
return;
|
||
}
|
||
}
|
||
|
||
match fs::copy(&legacy_path, &new_path) {
|
||
Ok(_) => {
|
||
log::info!(
|
||
"已根据覆盖目录复制 MCP 配置: {} -> {}",
|
||
legacy_path.display(),
|
||
new_path.display()
|
||
);
|
||
}
|
||
Err(err) => {
|
||
log::warn!(
|
||
"复制 MCP 配置失败: {} -> {}: {}",
|
||
legacy_path.display(),
|
||
new_path.display(),
|
||
err
|
||
);
|
||
}
|
||
}
|
||
}
|
||
|
||
fn read_json_value(path: &Path) -> Result<Value, AppError> {
|
||
if !path.exists() {
|
||
return Ok(serde_json::json!({}));
|
||
}
|
||
let content = fs::read_to_string(path).map_err(|e| AppError::io(path, e))?;
|
||
let value: Value = serde_json::from_str(&content).map_err(|e| AppError::json(path, e))?;
|
||
Ok(value)
|
||
}
|
||
|
||
fn write_json_value(path: &Path, value: &Value) -> Result<(), AppError> {
|
||
if let Some(parent) = path.parent() {
|
||
fs::create_dir_all(parent).map_err(|e| AppError::io(parent, e))?;
|
||
}
|
||
let json =
|
||
serde_json::to_string_pretty(value).map_err(|e| AppError::JsonSerialize { source: e })?;
|
||
atomic_write(path, json.as_bytes())
|
||
}
|
||
|
||
pub fn get_mcp_status() -> Result<McpStatus, AppError> {
|
||
let path = user_config_path();
|
||
let (exists, count) = if path.exists() {
|
||
let v = read_json_value(&path)?;
|
||
let servers = v.get("mcpServers").and_then(|x| x.as_object());
|
||
(true, servers.map(|m| m.len()).unwrap_or(0))
|
||
} else {
|
||
(false, 0)
|
||
};
|
||
|
||
Ok(McpStatus {
|
||
user_config_path: path.to_string_lossy().to_string(),
|
||
user_config_exists: exists,
|
||
server_count: count,
|
||
})
|
||
}
|
||
|
||
pub fn read_mcp_json() -> Result<Option<String>, AppError> {
|
||
let path = user_config_path();
|
||
if !path.exists() {
|
||
return Ok(None);
|
||
}
|
||
let content = fs::read_to_string(&path).map_err(|e| AppError::io(&path, e))?;
|
||
Ok(Some(content))
|
||
}
|
||
|
||
pub fn upsert_mcp_server(id: &str, spec: Value) -> Result<bool, AppError> {
|
||
if id.trim().is_empty() {
|
||
return Err(AppError::InvalidInput("MCP 服务器 ID 不能为空".into()));
|
||
}
|
||
// 基础字段校验(尽量宽松)
|
||
if !spec.is_object() {
|
||
return Err(AppError::McpValidation(
|
||
"MCP 服务器定义必须为 JSON 对象".into(),
|
||
));
|
||
}
|
||
let t_opt = spec.get("type").and_then(|x| x.as_str());
|
||
let is_stdio = t_opt.map(|t| t == "stdio").unwrap_or(true); // 兼容缺省(按 stdio 处理)
|
||
let is_http = t_opt.map(|t| t == "http").unwrap_or(false);
|
||
let is_sse = t_opt.map(|t| t == "sse").unwrap_or(false);
|
||
if !(is_stdio || is_http || is_sse) {
|
||
return Err(AppError::McpValidation(
|
||
"MCP 服务器 type 必须是 'stdio'、'http' 或 'sse'(或省略表示 stdio)".into(),
|
||
));
|
||
}
|
||
|
||
// stdio 类型必须有 command
|
||
if is_stdio {
|
||
let cmd = spec.get("command").and_then(|x| x.as_str()).unwrap_or("");
|
||
if cmd.is_empty() {
|
||
return Err(AppError::McpValidation(
|
||
"stdio 类型的 MCP 服务器缺少 command 字段".into(),
|
||
));
|
||
}
|
||
}
|
||
|
||
// http/sse 类型必须有 url
|
||
if is_http || is_sse {
|
||
let url = spec.get("url").and_then(|x| x.as_str()).unwrap_or("");
|
||
if url.is_empty() {
|
||
return Err(AppError::McpValidation(if is_http {
|
||
"http 类型的 MCP 服务器缺少 url 字段".into()
|
||
} else {
|
||
"sse 类型的 MCP 服务器缺少 url 字段".into()
|
||
}));
|
||
}
|
||
}
|
||
|
||
let path = user_config_path();
|
||
let mut root = if path.exists() {
|
||
read_json_value(&path)?
|
||
} else {
|
||
serde_json::json!({})
|
||
};
|
||
|
||
// 确保 mcpServers 对象存在
|
||
{
|
||
let obj = root
|
||
.as_object_mut()
|
||
.ok_or_else(|| AppError::Config("mcp.json 根必须是对象".into()))?;
|
||
if !obj.contains_key("mcpServers") {
|
||
obj.insert("mcpServers".into(), serde_json::json!({}));
|
||
}
|
||
}
|
||
|
||
let before = root.clone();
|
||
if let Some(servers) = root.get_mut("mcpServers").and_then(|v| v.as_object_mut()) {
|
||
servers.insert(id.to_string(), spec);
|
||
}
|
||
|
||
if before == root && path.exists() {
|
||
return Ok(false);
|
||
}
|
||
|
||
write_json_value(&path, &root)?;
|
||
Ok(true)
|
||
}
|
||
|
||
pub fn delete_mcp_server(id: &str) -> Result<bool, AppError> {
|
||
if id.trim().is_empty() {
|
||
return Err(AppError::InvalidInput("MCP 服务器 ID 不能为空".into()));
|
||
}
|
||
let path = user_config_path();
|
||
if !path.exists() {
|
||
return Ok(false);
|
||
}
|
||
let mut root = read_json_value(&path)?;
|
||
let Some(servers) = root.get_mut("mcpServers").and_then(|v| v.as_object_mut()) else {
|
||
return Ok(false);
|
||
};
|
||
let existed = servers.remove(id).is_some();
|
||
if !existed {
|
||
return Ok(false);
|
||
}
|
||
write_json_value(&path, &root)?;
|
||
Ok(true)
|
||
}
|
||
|
||
pub fn validate_command_in_path(cmd: &str) -> Result<bool, AppError> {
|
||
if cmd.trim().is_empty() {
|
||
return Ok(false);
|
||
}
|
||
// 如果包含路径分隔符,直接判断是否存在可执行文件
|
||
if cmd.contains('/') || cmd.contains('\\') {
|
||
return Ok(Path::new(cmd).exists());
|
||
}
|
||
|
||
let path_var = env::var_os("PATH").unwrap_or_default();
|
||
let paths = env::split_paths(&path_var);
|
||
|
||
#[cfg(windows)]
|
||
let exts: Vec<String> = env::var("PATHEXT")
|
||
.unwrap_or(".COM;.EXE;.BAT;.CMD".into())
|
||
.split(';')
|
||
.map(|s| s.trim().to_uppercase())
|
||
.collect();
|
||
|
||
for p in paths {
|
||
let candidate = p.join(cmd);
|
||
if candidate.is_file() {
|
||
return Ok(true);
|
||
}
|
||
#[cfg(windows)]
|
||
{
|
||
for ext in &exts {
|
||
let cand = p.join(format!("{}{}", cmd, ext));
|
||
if cand.is_file() {
|
||
return Ok(true);
|
||
}
|
||
}
|
||
}
|
||
}
|
||
Ok(false)
|
||
}
|
||
|
||
/// 读取 ~/.claude.json 中的 mcpServers 映射
|
||
pub fn read_mcp_servers_map() -> Result<std::collections::HashMap<String, Value>, AppError> {
|
||
let path = user_config_path();
|
||
if !path.exists() {
|
||
return Ok(std::collections::HashMap::new());
|
||
}
|
||
|
||
let root = read_json_value(&path)?;
|
||
let servers = root
|
||
.get("mcpServers")
|
||
.and_then(|v| v.as_object())
|
||
.map(|obj| obj.iter().map(|(k, v)| (k.clone(), v.clone())).collect())
|
||
.unwrap_or_default();
|
||
|
||
Ok(servers)
|
||
}
|
||
|
||
/// 将给定的启用 MCP 服务器映射写入到用户级 ~/.claude.json 的 mcpServers 字段
|
||
/// 仅覆盖 mcpServers,其他字段保持不变
|
||
pub fn set_mcp_servers_map(
|
||
servers: &std::collections::HashMap<String, Value>,
|
||
) -> Result<(), AppError> {
|
||
let path = user_config_path();
|
||
let mut root = if path.exists() {
|
||
read_json_value(&path)?
|
||
} else {
|
||
serde_json::json!({})
|
||
};
|
||
|
||
// 构建 mcpServers 对象:移除 UI 辅助字段(enabled/source),仅保留实际 MCP 规范
|
||
let mut out: Map<String, Value> = Map::new();
|
||
for (id, spec) in servers.iter() {
|
||
let mut obj = if let Some(map) = spec.as_object() {
|
||
map.clone()
|
||
} else {
|
||
return Err(AppError::McpValidation(format!(
|
||
"MCP 服务器 '{id}' 不是对象"
|
||
)));
|
||
};
|
||
|
||
if let Some(server_val) = obj.remove("server") {
|
||
let server_obj = server_val.as_object().cloned().ok_or_else(|| {
|
||
AppError::McpValidation(format!("MCP 服务器 '{id}' server 字段不是对象"))
|
||
})?;
|
||
obj = server_obj;
|
||
}
|
||
|
||
obj.remove("enabled");
|
||
obj.remove("source");
|
||
obj.remove("id");
|
||
obj.remove("name");
|
||
obj.remove("description");
|
||
obj.remove("tags");
|
||
obj.remove("homepage");
|
||
obj.remove("docs");
|
||
|
||
out.insert(id.clone(), Value::Object(obj));
|
||
}
|
||
|
||
{
|
||
let obj = root
|
||
.as_object_mut()
|
||
.ok_or_else(|| AppError::Config("~/.claude.json 根必须是对象".into()))?;
|
||
obj.insert("mcpServers".into(), Value::Object(out));
|
||
}
|
||
|
||
write_json_value(&path, &root)?;
|
||
Ok(())
|
||
}
|