mirror of
https://github.com/openai/codex.git
synced 2026-11-08 20:40:33 +00:00
## Stack - Base: #27184 - This PR is the second vertical and should be reviewed against `jif/external-plugins-1`, not `main`. ## Why CCA is moving toward a split runtime where the orchestrator may have no filesystem or executor, but it still needs to activate remotely hosted plugin components. HTTP MCP servers are the simplest complete example: they need configuration and host authentication, but they do not need an executor process. The Apps MCP endpoint is currently synthesized by a special-purpose loader inside the MCP runtime. That works locally, but it leaves hosted MCP activation outside the extension model being established in #27184. It also makes the Apps path a poor foundation for plugins whose skills, MCP servers, connectors, and hooks may come from different sources or execute in different places. This PR moves that one behavior behind an extension-owned contribution while preserving the existing local fallback. It deliberately does not introduce a generic plugin activation framework. ## What changed ### MCP extension contribution `codex-extension-api` gains an ordered `McpServerContributor` contract. A contributor returns typed `Set` or `Remove` overlays for MCP server configuration; later contributors win for the names they own. The contract stays at the existing MCP configuration boundary. Extensions do not create a second connection manager or transport abstraction. ### Hosted Apps MCP extension A new `codex-mcp-extension` contributes the reserved `codex_apps` server from the existing Apps feature, ChatGPT base URL, path override, and product SKU configuration. When `apps_mcp_path_override` is enabled for `https://chatgpt.com`, the resulting streamable HTTP endpoint is `https://chatgpt.com/backend-api/ps/mcp`. The existing ChatGPT-auth gate remains authoritative, so this server can run in an orchestrator-only process without being exposed for API-key sessions. ### One resolved runtime view `McpManager` now distinguishes three views: - **configured:** config- and plugin-backed servers before extension overlays; - **runtime:** configured servers plus host-installed extension contributions; - **effective:** runtime servers after auth gating and compatibility built-ins. App-server installs the hosted MCP extension and uses the runtime view for thread startup, refresh, status, threadless resource reads, connector discovery, and MCP OAuth lookup. This keeps `mcpServer/oauth/login` consistent with the servers exposed by the other MCP APIs. The hosted Apps server itself continues to use existing ChatGPT host authentication rather than MCP OAuth. ## Compatibility Hosts that do not install the MCP extension retain the existing Apps MCP synthesis path. This preserves current local-only, CLI, and standalone-host behavior while app-server exercises the extension path. Disabling Apps removes the reserved `codex_apps` entry, and losing ChatGPT auth removes it from the effective runtime view. Executor availability is not consulted for this HTTP transport. ## Follow-ups The next vertical will resolve a manifest-declared stdio MCP server from an executor-selected plugin root and execute it in the environment that owns that root. Later verticals can add backend-owned skills, connector metadata, hooks, durable selection semantics, and incremental local convergence without changing the component-specific runtime boundaries introduced here. ## Verification Focused coverage was added for: - contributing the hosted Apps MCP at `/backend-api/ps/mcp` without an executor; - requiring ChatGPT auth in the effective runtime view; - removing a reserved configured Apps server when the Apps feature is disabled. `cargo check -p codex-app-server -p codex-mcp-extension -p codex-extension-api -p codex-mcp` passed. Tests and Clippy were not run locally under the current development instruction; CI provides the full validation pass.
388 lines
14 KiB
Rust
388 lines
14 KiB
Rust
use super::*;
|
|
use codex_config::Constrained;
|
|
use codex_config::types::AppToolApproval;
|
|
use codex_login::CodexAuth;
|
|
use codex_plugin::AppConnectorId;
|
|
use codex_plugin::PluginCapabilitySummary;
|
|
use codex_protocol::models::ManagedFileSystemPermissions;
|
|
use codex_protocol::models::PermissionProfile;
|
|
use codex_protocol::permissions::NetworkSandboxPolicy;
|
|
use codex_protocol::protocol::AskForApproval;
|
|
use codex_protocol::protocol::GranularApprovalConfig;
|
|
use pretty_assertions::assert_eq;
|
|
use std::collections::HashMap;
|
|
use std::path::PathBuf;
|
|
|
|
fn test_mcp_config(codex_home: PathBuf) -> McpConfig {
|
|
McpConfig {
|
|
chatgpt_base_url: "https://chatgpt.com".to_string(),
|
|
apps_mcp_path_override: None,
|
|
apps_mcp_product_sku: None,
|
|
codex_home,
|
|
mcp_oauth_credentials_store_mode: OAuthCredentialsStoreMode::default(),
|
|
mcp_oauth_callback_port: None,
|
|
mcp_oauth_callback_url: None,
|
|
skill_mcp_dependency_install_enabled: true,
|
|
approval_policy: Constrained::allow_any(AskForApproval::OnFailure),
|
|
codex_linux_sandbox_exe: None,
|
|
use_legacy_landlock: false,
|
|
apps_enabled: false,
|
|
legacy_apps_mcp_loader_enabled: true,
|
|
prefix_mcp_tool_names: true,
|
|
client_elicitation_capability: ElicitationCapability::default(),
|
|
configured_mcp_servers: HashMap::new(),
|
|
plugin_ids_by_mcp_server_name: HashMap::new(),
|
|
plugin_capability_summaries: Vec::new(),
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn qualified_mcp_tool_name_prefix_sanitizes_server_names_without_lowercasing() {
|
|
assert_eq!(
|
|
qualified_mcp_tool_name_prefix("Some-Server"),
|
|
"mcp__Some_Server__".to_string()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn mcp_prompt_auto_approval_honors_unrestricted_managed_profiles() {
|
|
assert!(mcp_permission_prompt_is_auto_approved(
|
|
AskForApproval::Never,
|
|
&PermissionProfile::Managed {
|
|
file_system: ManagedFileSystemPermissions::Unrestricted,
|
|
network: NetworkSandboxPolicy::Enabled,
|
|
},
|
|
McpPermissionPromptAutoApproveContext::default(),
|
|
));
|
|
assert!(mcp_permission_prompt_is_auto_approved(
|
|
AskForApproval::Never,
|
|
&PermissionProfile::Managed {
|
|
file_system: ManagedFileSystemPermissions::Unrestricted,
|
|
network: NetworkSandboxPolicy::Restricted,
|
|
},
|
|
McpPermissionPromptAutoApproveContext::default(),
|
|
));
|
|
assert!(!mcp_permission_prompt_is_auto_approved(
|
|
AskForApproval::Never,
|
|
&PermissionProfile::read_only(),
|
|
McpPermissionPromptAutoApproveContext::default(),
|
|
));
|
|
assert!(!mcp_permission_prompt_is_auto_approved(
|
|
AskForApproval::OnRequest,
|
|
&PermissionProfile::Managed {
|
|
file_system: ManagedFileSystemPermissions::Unrestricted,
|
|
network: NetworkSandboxPolicy::Enabled,
|
|
},
|
|
McpPermissionPromptAutoApproveContext::default(),
|
|
));
|
|
}
|
|
|
|
#[test]
|
|
fn mcp_prompt_auto_approval_honors_approved_tools_in_all_permission_modes() {
|
|
for approval_policy in [
|
|
AskForApproval::UnlessTrusted,
|
|
AskForApproval::OnFailure,
|
|
AskForApproval::OnRequest,
|
|
AskForApproval::Granular(GranularApprovalConfig {
|
|
sandbox_approval: true,
|
|
rules: true,
|
|
skill_approval: true,
|
|
request_permissions: true,
|
|
mcp_elicitations: true,
|
|
}),
|
|
AskForApproval::Never,
|
|
] {
|
|
assert!(mcp_permission_prompt_is_auto_approved(
|
|
approval_policy,
|
|
&PermissionProfile::read_only(),
|
|
McpPermissionPromptAutoApproveContext {
|
|
tool_approval_mode: Some(AppToolApproval::Approve),
|
|
},
|
|
));
|
|
}
|
|
|
|
assert!(!mcp_permission_prompt_is_auto_approved(
|
|
AskForApproval::OnRequest,
|
|
&PermissionProfile::read_only(),
|
|
McpPermissionPromptAutoApproveContext {
|
|
tool_approval_mode: Some(AppToolApproval::Auto),
|
|
},
|
|
));
|
|
}
|
|
|
|
#[test]
|
|
fn mcp_prompt_auto_approval_rejects_auto_mode_in_default_permission_mode() {
|
|
assert!(!mcp_permission_prompt_is_auto_approved(
|
|
AskForApproval::OnRequest,
|
|
&PermissionProfile::read_only(),
|
|
McpPermissionPromptAutoApproveContext {
|
|
tool_approval_mode: Some(AppToolApproval::Auto),
|
|
},
|
|
));
|
|
}
|
|
|
|
#[test]
|
|
fn tool_plugin_provenance_collects_app_and_mcp_sources() {
|
|
let mut config = test_mcp_config(PathBuf::new());
|
|
config.plugin_ids_by_mcp_server_name =
|
|
HashMap::from([("alpha".to_string(), "alpha@test".to_string())]);
|
|
config.plugin_capability_summaries = vec![
|
|
PluginCapabilitySummary {
|
|
display_name: "alpha-plugin".to_string(),
|
|
app_connector_ids: vec![AppConnectorId("connector_example".to_string())],
|
|
mcp_server_names: vec!["alpha".to_string()],
|
|
..PluginCapabilitySummary::default()
|
|
},
|
|
PluginCapabilitySummary {
|
|
display_name: "beta-plugin".to_string(),
|
|
app_connector_ids: vec![
|
|
AppConnectorId("connector_example".to_string()),
|
|
AppConnectorId("connector_gmail".to_string()),
|
|
],
|
|
mcp_server_names: vec!["beta".to_string()],
|
|
..PluginCapabilitySummary::default()
|
|
},
|
|
];
|
|
let provenance = tool_plugin_provenance(&config);
|
|
|
|
assert_eq!(
|
|
provenance,
|
|
ToolPluginProvenance {
|
|
plugin_display_names_by_connector_id: HashMap::from([
|
|
(
|
|
"connector_example".to_string(),
|
|
vec!["alpha-plugin".to_string(), "beta-plugin".to_string()],
|
|
),
|
|
(
|
|
"connector_gmail".to_string(),
|
|
vec!["beta-plugin".to_string()],
|
|
),
|
|
]),
|
|
plugin_display_names_by_mcp_server_name: HashMap::from([
|
|
("alpha".to_string(), vec!["alpha-plugin".to_string()]),
|
|
("beta".to_string(), vec!["beta-plugin".to_string()]),
|
|
]),
|
|
plugin_ids_by_mcp_server_name: HashMap::from([(
|
|
"alpha".to_string(),
|
|
"alpha@test".to_string(),
|
|
)]),
|
|
}
|
|
);
|
|
assert_eq!(
|
|
provenance.plugin_id_for_mcp_server_name("alpha"),
|
|
Some("alpha@test")
|
|
);
|
|
assert_eq!(provenance.plugin_id_for_mcp_server_name("beta"), None);
|
|
}
|
|
|
|
#[test]
|
|
fn codex_apps_mcp_url_for_base_url_keeps_existing_paths() {
|
|
assert_eq!(
|
|
codex_apps_mcp_url_for_base_url(
|
|
"https://chatgpt.com/backend-api",
|
|
/*apps_mcp_path_override*/ None,
|
|
),
|
|
"https://chatgpt.com/backend-api/wham/apps"
|
|
);
|
|
assert_eq!(
|
|
codex_apps_mcp_url_for_base_url(
|
|
"https://chat.openai.com",
|
|
/*apps_mcp_path_override*/ None,
|
|
),
|
|
"https://chat.openai.com/backend-api/wham/apps"
|
|
);
|
|
assert_eq!(
|
|
codex_apps_mcp_url_for_base_url(
|
|
"http://localhost:8080/api/codex",
|
|
/*apps_mcp_path_override*/ None,
|
|
),
|
|
"http://localhost:8080/api/codex/apps"
|
|
);
|
|
assert_eq!(
|
|
codex_apps_mcp_url_for_base_url(
|
|
"http://localhost:8080",
|
|
/*apps_mcp_path_override*/ None,
|
|
),
|
|
"http://localhost:8080/api/codex/apps"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn codex_apps_server_config_uses_legacy_codex_apps_path() {
|
|
let mut config = test_mcp_config(PathBuf::from("/tmp"));
|
|
let auth = CodexAuth::create_dummy_chatgpt_auth_for_testing();
|
|
|
|
let mut servers = with_codex_apps_mcp(HashMap::new(), /*auth*/ None, &config);
|
|
assert!(!servers.contains_key(CODEX_APPS_MCP_SERVER_NAME));
|
|
|
|
config.apps_enabled = true;
|
|
|
|
servers = with_codex_apps_mcp(servers, Some(&auth), &config);
|
|
let server = servers
|
|
.get(CODEX_APPS_MCP_SERVER_NAME)
|
|
.expect("codex apps should be present when apps is enabled");
|
|
let config = server
|
|
.configured_config()
|
|
.expect("codex apps should use configured transport");
|
|
let url = match &config.transport {
|
|
McpServerTransportConfig::StreamableHttp { url, .. } => url,
|
|
_ => panic!("expected streamable http transport for codex apps"),
|
|
};
|
|
|
|
assert_eq!(url, "https://chatgpt.com/backend-api/wham/apps");
|
|
}
|
|
|
|
#[test]
|
|
fn codex_apps_server_config_uses_configured_apps_mcp_path_override() {
|
|
let mut config = test_mcp_config(PathBuf::from("/tmp"));
|
|
config.apps_mcp_path_override = Some("/custom/mcp".to_string());
|
|
config.apps_enabled = true;
|
|
let auth = CodexAuth::create_dummy_chatgpt_auth_for_testing();
|
|
|
|
let servers = with_codex_apps_mcp(HashMap::new(), Some(&auth), &config);
|
|
let server = servers
|
|
.get(CODEX_APPS_MCP_SERVER_NAME)
|
|
.expect("codex apps should be present when apps is enabled");
|
|
let config = server
|
|
.configured_config()
|
|
.expect("codex apps should use configured transport");
|
|
let url = match &config.transport {
|
|
McpServerTransportConfig::StreamableHttp { url, .. } => url,
|
|
_ => panic!("expected streamable http transport for codex apps"),
|
|
};
|
|
|
|
assert_eq!(url, "https://chatgpt.com/backend-api/custom/mcp");
|
|
}
|
|
|
|
#[test]
|
|
fn codex_apps_server_config_forwards_configured_product_sku_header() {
|
|
let mut config = test_mcp_config(PathBuf::from("/tmp"));
|
|
config.apps_mcp_product_sku = Some("tpp".to_string());
|
|
config.apps_enabled = true;
|
|
let auth = CodexAuth::create_dummy_chatgpt_auth_for_testing();
|
|
|
|
let servers = with_codex_apps_mcp(HashMap::new(), Some(&auth), &config);
|
|
let server = servers
|
|
.get(CODEX_APPS_MCP_SERVER_NAME)
|
|
.expect("codex apps should be present when apps is enabled");
|
|
let config = server
|
|
.configured_config()
|
|
.expect("codex apps should use configured transport");
|
|
|
|
match &config.transport {
|
|
McpServerTransportConfig::StreamableHttp {
|
|
http_headers,
|
|
env_http_headers,
|
|
..
|
|
} => {
|
|
assert_eq!(
|
|
http_headers,
|
|
&Some(HashMap::from([(
|
|
"X-OpenAI-Product-Sku".to_string(),
|
|
"tpp".to_string(),
|
|
)]))
|
|
);
|
|
assert!(env_http_headers.is_none());
|
|
}
|
|
other => panic!("expected streamable http transport, got {other:?}"),
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn effective_mcp_servers_preserve_user_servers_and_add_codex_apps() {
|
|
let codex_home = tempfile::tempdir().expect("tempdir");
|
|
let mut config = test_mcp_config(codex_home.path().to_path_buf());
|
|
config.apps_enabled = true;
|
|
let auth = CodexAuth::create_dummy_chatgpt_auth_for_testing();
|
|
|
|
config.configured_mcp_servers.insert(
|
|
"sample".to_string(),
|
|
McpServerConfig {
|
|
transport: McpServerTransportConfig::StreamableHttp {
|
|
url: "https://user.example/mcp".to_string(),
|
|
bearer_token_env_var: None,
|
|
http_headers: None,
|
|
env_http_headers: None,
|
|
},
|
|
environment_id: codex_config::DEFAULT_MCP_SERVER_ENVIRONMENT_ID.to_string(),
|
|
enabled: true,
|
|
required: false,
|
|
supports_parallel_tool_calls: false,
|
|
disabled_reason: None,
|
|
startup_timeout_sec: None,
|
|
tool_timeout_sec: None,
|
|
default_tools_approval_mode: None,
|
|
enabled_tools: None,
|
|
disabled_tools: None,
|
|
scopes: None,
|
|
oauth: None,
|
|
oauth_resource: None,
|
|
tools: HashMap::new(),
|
|
},
|
|
);
|
|
config.configured_mcp_servers.insert(
|
|
"docs".to_string(),
|
|
McpServerConfig {
|
|
transport: McpServerTransportConfig::StreamableHttp {
|
|
url: "https://docs.example/mcp".to_string(),
|
|
bearer_token_env_var: None,
|
|
http_headers: None,
|
|
env_http_headers: None,
|
|
},
|
|
environment_id: codex_config::DEFAULT_MCP_SERVER_ENVIRONMENT_ID.to_string(),
|
|
enabled: true,
|
|
required: false,
|
|
supports_parallel_tool_calls: false,
|
|
disabled_reason: None,
|
|
startup_timeout_sec: None,
|
|
tool_timeout_sec: None,
|
|
default_tools_approval_mode: None,
|
|
enabled_tools: None,
|
|
disabled_tools: None,
|
|
scopes: None,
|
|
oauth: None,
|
|
oauth_resource: None,
|
|
tools: HashMap::new(),
|
|
},
|
|
);
|
|
|
|
let effective = effective_mcp_servers(&config, Some(&auth));
|
|
|
|
let sample = effective.get("sample").expect("user server should exist");
|
|
let docs = effective
|
|
.get("docs")
|
|
.expect("configured server should exist");
|
|
let codex_apps = effective
|
|
.get(CODEX_APPS_MCP_SERVER_NAME)
|
|
.expect("codex apps server should exist");
|
|
|
|
let sample = sample
|
|
.configured_config()
|
|
.expect("configured server should retain transport");
|
|
let docs = docs
|
|
.configured_config()
|
|
.expect("configured server should retain transport");
|
|
let codex_apps = codex_apps
|
|
.configured_config()
|
|
.expect("codex apps should use configured transport");
|
|
|
|
match &sample.transport {
|
|
McpServerTransportConfig::StreamableHttp { url, .. } => {
|
|
assert_eq!(url, "https://user.example/mcp");
|
|
}
|
|
other => panic!("expected streamable http transport, got {other:?}"),
|
|
}
|
|
match &docs.transport {
|
|
McpServerTransportConfig::StreamableHttp { url, .. } => {
|
|
assert_eq!(url, "https://docs.example/mcp");
|
|
}
|
|
other => panic!("expected streamable http transport, got {other:?}"),
|
|
}
|
|
match &codex_apps.transport {
|
|
McpServerTransportConfig::StreamableHttp { url, .. } => {
|
|
assert_eq!(url, "https://chatgpt.com/backend-api/wham/apps");
|
|
}
|
|
other => panic!("expected streamable http transport, got {other:?}"),
|
|
}
|
|
}
|