mirror of
https://github.com/openai/codex.git
synced 2026-11-12 21:20:34 +00:00
thomas
6baa076eb6
## Why Extension-owned HTTP MCP servers previously inherited the default protocol mode. Extensions need to select a mode for their own server independently of other HTTP servers. ## What changed - Add `McpServerContribution::SetWithProtocolMode` and re-export `McpProtocolMode` through the extension API. - Carry the winning registration's protocol override through catalog resolution and materialization, and apply it to Streamable HTTP connections. - Preserve existing defaults when no override is present. Selecting a protocol mode does not grant host-owned Apps cache access or environment authority. ## Testing Add coverage for registration precedence and materialization, and extend cache isolation tests to cover explicit protocol selection. Add an integration test verifying that extension servers can select either the legacy or newer protocol while other HTTP servers retain the default mode. GitOrigin-RevId: 606cecc03094a93258ffc433849f575020b81473
1034 lines
43 KiB
Rust
1034 lines
43 KiB
Rust
//! Aggregates MCP server connections for Codex.
|
|
//!
|
|
//! [`McpConnectionSet`] is the private connection set behind
|
|
//! [`crate::McpRuntime`] and [`crate::McpBinding`]. It coordinates startup status
|
|
//! events, keeps server metadata, and aggregates tools and resources across
|
|
//! running RMCP clients.
|
|
|
|
#[path = "connection_manager/required.rs"]
|
|
mod required;
|
|
#[path = "connection_manager/resources.rs"]
|
|
mod resources;
|
|
#[path = "connection_manager/startup.rs"]
|
|
mod startup;
|
|
#[path = "connection_manager/status.rs"]
|
|
mod status;
|
|
#[path = "connection_manager/tool_catalog.rs"]
|
|
mod tool_catalog;
|
|
|
|
use startup::chatgpt_auth_provider_for_server;
|
|
use startup::emit_update;
|
|
use startup::mcp_init_error_display;
|
|
use startup::mcp_startup_failure_reason;
|
|
use startup::should_share_codex_apps_tools_cache;
|
|
pub(crate) use tool_catalog::BindingCatalogRevision;
|
|
pub use tool_catalog::tool_is_model_visible;
|
|
|
|
use std::collections::HashMap;
|
|
use std::sync::Arc;
|
|
use std::sync::OnceLock;
|
|
use std::sync::atomic::Ordering;
|
|
use std::time::Duration;
|
|
|
|
use crate::binding::call_tool_result_from_rmcp;
|
|
use crate::catalog::McpServerSource;
|
|
use crate::elicitation::ElicitationRequestManager;
|
|
use crate::elicitation::ElicitationRequestRouter;
|
|
use crate::event_stream::EventStreamConnectionSettings;
|
|
use crate::mcp::CODEX_APPS_MCP_SERVER_NAME;
|
|
use crate::mcp::ToolPluginProvenance;
|
|
use crate::pagination::MAX_CODEX_APPS_TOOL_CATALOG_ITEMS;
|
|
use crate::pagination::MAX_MCP_CATALOG_ITEMS;
|
|
use crate::rmcp_client::AsyncManagedClient;
|
|
use crate::rmcp_client::DEFAULT_STARTUP_TIMEOUT;
|
|
use crate::rmcp_client::DEFAULT_TOOL_TIMEOUT;
|
|
use crate::rmcp_client::ManagedClient;
|
|
use crate::rmcp_client::StartupOutcomeError;
|
|
use crate::rmcp_client::prepare_codex_apps_tools_for_model;
|
|
use crate::rmcp_client::prepare_regular_mcp_tools_for_model;
|
|
use crate::runtime::McpPublicationGate;
|
|
use crate::runtime::McpRuntimeInput;
|
|
use crate::runtime::McpStartupPolicy;
|
|
use crate::server::McpServerConnectionIdentity;
|
|
use crate::server::McpServerMetadata;
|
|
use crate::tool_catalog_cache::McpToolCatalogCacheContext;
|
|
use crate::tools::ToolFilter;
|
|
use crate::tools::ToolInfo;
|
|
use crate::tools::filter_tools;
|
|
use crate::trusted_access::ENTITLEMENT_CONTEXT_KEY;
|
|
use crate::trusted_access::TrustedAccessContext;
|
|
use anyhow::Context;
|
|
use anyhow::Result;
|
|
use anyhow::anyhow;
|
|
use anyhow::bail;
|
|
use codex_config::McpServerTransportConfig;
|
|
use codex_diagnostics::Gauge;
|
|
use codex_diagnostics::GaugeGuard;
|
|
use codex_protocol::mcp::CallToolResult;
|
|
use codex_protocol::mcp::McpServerInfo;
|
|
use codex_protocol::protocol::Event;
|
|
use codex_protocol::protocol::EventMsg;
|
|
use codex_protocol::protocol::McpStartupCompleteEvent;
|
|
use codex_protocol::protocol::McpStartupFailure;
|
|
use codex_protocol::protocol::McpStartupFailureReason;
|
|
use codex_protocol::protocol::McpStartupStatus;
|
|
use codex_protocol::protocol::McpStartupUpdateEvent;
|
|
use codex_rmcp_client::determine_streamable_http_auth_status_from_credentials;
|
|
use tokio::sync::watch;
|
|
use tokio::task::JoinSet;
|
|
use tracing::warn;
|
|
|
|
static LIVE_CONNECTIONS: Gauge = Gauge::new("mcp.connections.live");
|
|
|
|
pub(crate) struct McpServerConnection {
|
|
identity: Option<McpServerConnectionIdentity>,
|
|
client: AsyncManagedClient,
|
|
// Startup-only budget; changing it must not replace a ready connection.
|
|
startup_timeout: Duration,
|
|
startup_trigger: Option<watch::Sender<bool>>,
|
|
_diagnostics_guard: GaugeGuard,
|
|
}
|
|
|
|
impl McpServerConnection {
|
|
async fn reusable_client(
|
|
&self,
|
|
desired: &McpServerConnectionIdentity,
|
|
) -> Option<ManagedClient> {
|
|
let current = self.identity.as_ref()?;
|
|
if !current.has_same_connection_config(desired) {
|
|
return None;
|
|
}
|
|
if !self.client.startup_complete.load(Ordering::Acquire) {
|
|
return None;
|
|
}
|
|
let client = self.client.client().await.ok()?;
|
|
if client.client.is_closed().await {
|
|
return None;
|
|
}
|
|
if current == desired {
|
|
if matches!(desired.oauth_credentials(), Ok(None))
|
|
&& tokio::time::timeout(Duration::ZERO, client.client.managed_oauth_credentials())
|
|
.await
|
|
.is_ok_and(|credentials| matches!(credentials, Some(Some(_))))
|
|
{
|
|
return None;
|
|
}
|
|
return Some(client);
|
|
}
|
|
let Ok(desired_credentials) = desired.oauth_credentials() else {
|
|
return Some(client);
|
|
};
|
|
let reusable = match client.client.managed_oauth_credentials().await {
|
|
Some(live_credentials) => live_credentials.as_ref() == desired_credentials,
|
|
None => current
|
|
.oauth_credentials()
|
|
.is_ok_and(|startup_credentials| startup_credentials == desired_credentials),
|
|
};
|
|
if reusable { Some(client) } else { None }
|
|
}
|
|
|
|
pub(crate) async fn client(&self) -> Result<ManagedClient, StartupOutcomeError> {
|
|
if let Some(startup_trigger) = &self.startup_trigger {
|
|
startup_trigger.send_replace(true);
|
|
}
|
|
self.client.client().await
|
|
}
|
|
|
|
async fn shutdown(&self) {
|
|
self.client.shutdown().await;
|
|
}
|
|
|
|
fn cancel_startup(&self) {
|
|
if !self.startup_is_dormant() && !self.client.startup_complete.load(Ordering::Acquire) {
|
|
self.client.cancel_token.cancel();
|
|
}
|
|
}
|
|
|
|
fn startup_is_dormant(&self) -> bool {
|
|
self.startup_trigger
|
|
.as_ref()
|
|
.is_some_and(|startup_trigger| !*startup_trigger.borrow())
|
|
}
|
|
}
|
|
|
|
impl Drop for McpServerConnection {
|
|
fn drop(&mut self) {
|
|
self.client.cancel_token.cancel();
|
|
}
|
|
}
|
|
|
|
#[derive(Clone)]
|
|
struct McpServerView {
|
|
connection: Arc<McpServerConnection>,
|
|
protocol_mode: crate::McpProtocolMode,
|
|
metadata: McpServerMetadata,
|
|
tool_filter: ToolFilter,
|
|
tool_timeout: Option<Duration>,
|
|
catalog_item_limit: usize,
|
|
}
|
|
|
|
impl McpServerView {
|
|
async fn listed_tools(
|
|
&self,
|
|
tool_plugin_provenance: &ToolPluginProvenance,
|
|
) -> Result<Vec<ToolInfo>, StartupOutcomeError> {
|
|
let tools = self.connection.client.listed_tools().await?;
|
|
let tools = filter_tools(tools, &self.tool_filter);
|
|
Ok(if self.connection.client.is_codex_apps_mcp_server {
|
|
prepare_codex_apps_tools_for_model(tools, tool_plugin_provenance)
|
|
} else {
|
|
prepare_regular_mcp_tools_for_model(tools, tool_plugin_provenance)
|
|
})
|
|
}
|
|
}
|
|
|
|
/// A published view over a set of running MCP server connections.
|
|
pub(crate) struct McpConnectionSet {
|
|
servers: HashMap<String, McpServerView>,
|
|
pub(crate) event_stream_connection: Option<Arc<EventStreamConnectionSettings>>,
|
|
disabled_servers: Vec<String>,
|
|
required_servers: Vec<String>,
|
|
optional_startup_deadline: OnceLock<tokio::time::Instant>,
|
|
tool_plugin_provenance: Arc<ToolPluginProvenance>,
|
|
prefix_mcp_tool_names: bool,
|
|
non_prefixed_mcp_tool_servers: Vec<String>,
|
|
elicitation_requests: ElicitationRequestManager,
|
|
pub(crate) trusted_access: Option<TrustedAccessContext>,
|
|
}
|
|
|
|
impl McpConnectionSet {
|
|
/// Creates an MCP connection manager. Threadless callers can pass no `tx_event`; startup
|
|
/// notifications are then skipped and interactive elicitations are declined.
|
|
pub async fn new(
|
|
previous: Option<&Self>,
|
|
publication_gate: McpPublicationGate,
|
|
input: McpRuntimeInput,
|
|
elicitation_router: ElicitationRequestRouter,
|
|
) -> Self {
|
|
let trusted_access = TrustedAccessContext::from_runtime(&input);
|
|
let McpRuntimeInput {
|
|
startup_policy,
|
|
config,
|
|
plugins_available: _,
|
|
ready_selected_capability_roots: _,
|
|
mcp_servers,
|
|
submit_id,
|
|
tx_event,
|
|
startup_cancellation_token,
|
|
runtime_context,
|
|
codex_apps_tools_cache,
|
|
tool_catalog_cache,
|
|
codex_apps_tools_cache_key,
|
|
client_mcp_extensions,
|
|
auth,
|
|
auth_manager,
|
|
elicitation_reviewer,
|
|
elicitation_lifecycle,
|
|
} = input;
|
|
let store_mode = config.mcp_oauth_credentials_store_mode;
|
|
let keyring_backend_kind = config.auth_keyring_backend_kind;
|
|
let oauth_refresh_mode = config.oauth_refresh_mode;
|
|
let codex_home = config.codex_home.clone();
|
|
let prefix_mcp_tool_names = config.prefix_mcp_tool_names;
|
|
let non_prefixed_mcp_tool_servers = config.non_prefixed_mcp_tool_servers.clone();
|
|
let default_protocol_mode = config.protocol_mode;
|
|
let host_owned_apps_protocol_mode = config.host_owned_apps_protocol_mode;
|
|
let client_elicitation_capability = config.client_elicitation_capability.clone();
|
|
let tool_plugin_provenance = crate::mcp::tool_plugin_provenance(&config);
|
|
let auth = auth.as_ref();
|
|
let mut servers = HashMap::new();
|
|
let mut event_stream_connection = None;
|
|
let disabled_servers = mcp_servers
|
|
.iter()
|
|
.filter(|(_, server)| !server.enabled())
|
|
.map(|(name, _)| name.clone())
|
|
.collect();
|
|
let mut required_servers = mcp_servers
|
|
.iter()
|
|
.filter(|(_, server)| server.enabled() && server.required())
|
|
.map(|(server_name, _)| server_name.clone())
|
|
.collect::<Vec<_>>();
|
|
required_servers.sort();
|
|
let mut reused_ready = Vec::new();
|
|
let mut join_set = JoinSet::new();
|
|
// Explicit reconnects have no previous set and must replace their clients eagerly.
|
|
let allow_deferred_startup =
|
|
startup_policy == McpStartupPolicy::LazyWhenCached && previous.is_some();
|
|
let reusable_previous = previous.filter(|previous| {
|
|
!previous.servers.is_empty()
|
|
&& previous.elicitation_requests.update(
|
|
Arc::clone(&config),
|
|
elicitation_reviewer.clone(),
|
|
elicitation_lifecycle.clone(),
|
|
)
|
|
});
|
|
let elicitation_requests = if let Some(previous) = reusable_previous {
|
|
previous.elicitation_requests.clone()
|
|
} else {
|
|
ElicitationRequestManager::new(
|
|
Arc::clone(&config),
|
|
elicitation_reviewer,
|
|
elicitation_lifecycle,
|
|
elicitation_router,
|
|
)
|
|
};
|
|
let tool_plugin_provenance = Arc::new(tool_plugin_provenance);
|
|
let startup_submit_id = submit_id;
|
|
let static_chatgpt_auth_provider = auth
|
|
.filter(|auth| auth.uses_codex_backend())
|
|
.map(codex_model_provider::auth_provider_from_auth);
|
|
let codex_apps_auth_provider = auth_manager.as_ref().and_then(|auth_manager| {
|
|
auth.filter(|auth| auth.uses_codex_backend()).map(|auth| {
|
|
codex_model_provider::auth_provider_from_auth_manager(
|
|
Arc::clone(auth_manager),
|
|
auth,
|
|
)
|
|
})
|
|
});
|
|
for (server_name, server) in mcp_servers
|
|
.into_iter()
|
|
.filter(|(_, server)| server.enabled())
|
|
{
|
|
let registration = config.mcp_server_catalog.server(&server_name);
|
|
let client_mcp_extensions = crate::client_capabilities::server_mcp_extensions(
|
|
&client_mcp_extensions,
|
|
&server_name,
|
|
registration,
|
|
);
|
|
let is_host_owned_codex_apps = registration.is_some_and(|server| {
|
|
server
|
|
.source()
|
|
.is_host_owned_apps(&server_name, server.config())
|
|
});
|
|
let host_plugin_root = registration.and_then(|server| match server.source() {
|
|
McpServerSource::Plugin(plugin) => plugin.host_root(),
|
|
McpServerSource::SelectedPlugin(_)
|
|
| McpServerSource::Config
|
|
| McpServerSource::Compatibility { .. }
|
|
| McpServerSource::Extension { .. } => None,
|
|
});
|
|
let catalog_item_limit = if is_host_owned_codex_apps {
|
|
MAX_CODEX_APPS_TOOL_CATALOG_ITEMS
|
|
} else {
|
|
MAX_MCP_CATALOG_ITEMS
|
|
};
|
|
let metadata = McpServerMetadata::from(&server);
|
|
let configured_config = server.config().clone();
|
|
let protocol_mode = if matches!(
|
|
&configured_config.transport,
|
|
McpServerTransportConfig::StreamableHttp { .. }
|
|
) {
|
|
registration
|
|
.and_then(crate::ResolvedMcpServer::protocol_mode)
|
|
.unwrap_or(if is_host_owned_codex_apps {
|
|
host_owned_apps_protocol_mode
|
|
} else {
|
|
default_protocol_mode
|
|
})
|
|
} else {
|
|
default_protocol_mode
|
|
};
|
|
let configured_tool_filter = ToolFilter::from_config(&configured_config);
|
|
let startup_timeout = configured_config
|
|
.startup_timeout_sec
|
|
.unwrap_or(DEFAULT_STARTUP_TIMEOUT);
|
|
let configured_tool_timeout = Some(
|
|
configured_config
|
|
.tool_timeout_sec
|
|
.unwrap_or(DEFAULT_TOOL_TIMEOUT),
|
|
);
|
|
let resolved_environment =
|
|
runtime_context.resolve_server_environment(&server_name, &configured_config);
|
|
// For built-in Codex Apps, `CODEX_CONNECTORS_TOKEN` is a debug
|
|
// override: it supplies runtime auth but bypasses the shared tools
|
|
// cache.
|
|
let uses_env_bearer_token = match &configured_config.transport {
|
|
McpServerTransportConfig::StreamableHttp {
|
|
bearer_token_env_var,
|
|
..
|
|
} => bearer_token_env_var.is_some(),
|
|
McpServerTransportConfig::Stdio { .. } => false,
|
|
};
|
|
let shares_codex_apps_tools_cache = is_host_owned_codex_apps
|
|
&& should_share_codex_apps_tools_cache(&server_name, uses_env_bearer_token);
|
|
let codex_apps_tools_cache_context = shares_codex_apps_tools_cache.then(|| {
|
|
// Tools/list has no thread selection or UI capabilities. Only equivalent
|
|
// transport/auth and listing settings may share executable Apps tools.
|
|
let mut transport = configured_config.transport.clone();
|
|
if let McpServerTransportConfig::StreamableHttp {
|
|
http_headers: Some(headers),
|
|
..
|
|
} = &mut transport
|
|
{
|
|
// mcp_server_config_for_url in codex-rs/codex-mcp/src/mcp/mod.rs
|
|
// adds thread attribution that threadless discovery does not carry.
|
|
headers.retain(|name, _| !name.eq_ignore_ascii_case("originator"));
|
|
}
|
|
let mut scope = serde_json::json!([
|
|
transport,
|
|
&configured_config.auth,
|
|
protocol_mode.preferred_protocol_version().as_str(),
|
|
catalog_item_limit,
|
|
]);
|
|
scope.sort_all_objects();
|
|
codex_apps_tools_cache
|
|
.context(codex_home.clone(), codex_apps_tools_cache_key.clone())
|
|
.with_live_scope(scope.to_string())
|
|
});
|
|
// The reserved Codex Apps registration follows the shared
|
|
// AuthManager across refreshes. In the hosted-plugin path, this
|
|
// is the ChatGPT /ps/mcp connection. User-configured MCP
|
|
// registrations keep their existing configured auth path.
|
|
let chatgpt_auth_provider = if server_name == CODEX_APPS_MCP_SERVER_NAME {
|
|
codex_apps_auth_provider
|
|
.clone()
|
|
.or_else(|| static_chatgpt_auth_provider.clone())
|
|
} else {
|
|
static_chatgpt_auth_provider.clone()
|
|
};
|
|
// If Codex Apps has an env bearer token, that is its auth path. Do
|
|
// not also attach the ambient CodexAuth provider.
|
|
let runtime_auth_provider =
|
|
if server_name == CODEX_APPS_MCP_SERVER_NAME && uses_env_bearer_token {
|
|
None
|
|
} else {
|
|
chatgpt_auth_provider_for_server(&server, chatgpt_auth_provider)
|
|
};
|
|
if is_host_owned_codex_apps {
|
|
event_stream_connection = Some(Arc::new(EventStreamConnectionSettings {
|
|
server: server.clone(),
|
|
store_mode,
|
|
keyring_backend_kind,
|
|
oauth_refresh_mode,
|
|
runtime_context: runtime_context.clone(),
|
|
resolved_environment: resolved_environment.clone(),
|
|
auth_provider: runtime_auth_provider.clone(),
|
|
auth_manager: auth_manager.clone(),
|
|
auth: auth.cloned(),
|
|
protocol_mode,
|
|
client_mcp_extensions: client_mcp_extensions.clone(),
|
|
}));
|
|
}
|
|
let connection_identity = McpServerConnectionIdentity::new(
|
|
&server_name,
|
|
&server,
|
|
host_plugin_root,
|
|
store_mode,
|
|
keyring_backend_kind,
|
|
oauth_refresh_mode,
|
|
&resolved_environment,
|
|
&runtime_context,
|
|
runtime_auth_provider.as_ref(),
|
|
auth,
|
|
shares_codex_apps_tools_cache
|
|
.then(|| (codex_home.clone(), codex_apps_tools_cache_key.clone())),
|
|
client_elicitation_capability.clone(),
|
|
client_mcp_extensions.clone(),
|
|
previous
|
|
.and_then(|previous| previous.servers.get(&server_name))
|
|
.and_then(|view| view.connection.identity.as_ref()),
|
|
);
|
|
let expected_protocol_mode = match &configured_config.transport {
|
|
McpServerTransportConfig::StreamableHttp { .. } => Some(protocol_mode),
|
|
McpServerTransportConfig::Stdio { .. }
|
|
if protocol_mode == crate::McpProtocolMode::Legacy =>
|
|
{
|
|
Some(crate::McpProtocolMode::Legacy)
|
|
}
|
|
McpServerTransportConfig::Stdio { env, .. } => match env
|
|
.as_ref()
|
|
.and_then(|variables| variables.get("CODEX_MCP_PROTOCOL_VERSION"))
|
|
{
|
|
None => Some(crate::McpProtocolMode::Legacy),
|
|
Some(version)
|
|
if version == rmcp::model::ProtocolVersion::V_2026_07_28.as_str() =>
|
|
{
|
|
Some(protocol_mode)
|
|
}
|
|
Some(_) => None,
|
|
},
|
|
};
|
|
if let Some(previous_view) =
|
|
reusable_previous.and_then(|previous| previous.servers.get(&server_name))
|
|
{
|
|
let connection = Arc::clone(&previous_view.connection);
|
|
let reusable_pending_startup = connection.identity.as_ref()
|
|
== Some(&connection_identity)
|
|
&& !connection.client.startup_complete.load(Ordering::Acquire)
|
|
&& connection.startup_timeout == startup_timeout
|
|
&& !connection.startup_is_dormant()
|
|
&& !connection.client.cancel_token.is_cancelled()
|
|
&& previous_view.catalog_item_limit == catalog_item_limit
|
|
&& expected_protocol_mode.is_some()
|
|
&& previous_view.protocol_mode == protocol_mode;
|
|
let unchanged_auth_failure = if connection.identity.as_ref()
|
|
== Some(&connection_identity)
|
|
&& connection_identity.oauth_store_was_contended
|
|
&& previous_view.protocol_mode == protocol_mode
|
|
&& connection.client.startup_complete.load(Ordering::Acquire)
|
|
{
|
|
connection
|
|
.client()
|
|
.await
|
|
.err()
|
|
.filter(StartupOutcomeError::is_authentication_required)
|
|
} else {
|
|
None
|
|
};
|
|
if reusable_pending_startup
|
|
|| unchanged_auth_failure.is_some()
|
|
|| connection
|
|
.reusable_client(&connection_identity)
|
|
.await
|
|
.is_some_and(|client| {
|
|
previous_view.catalog_item_limit == catalog_item_limit
|
|
&& expected_protocol_mode.is_some_and(|expected| {
|
|
client.client.protocol_mode() == expected
|
|
})
|
|
})
|
|
{
|
|
let pending_client =
|
|
reusable_pending_startup.then(|| connection.client.clone());
|
|
servers.insert(
|
|
server_name.clone(),
|
|
McpServerView {
|
|
connection,
|
|
protocol_mode,
|
|
metadata,
|
|
tool_filter: configured_tool_filter,
|
|
tool_timeout: configured_tool_timeout,
|
|
catalog_item_limit,
|
|
},
|
|
);
|
|
if let Some(error) = unchanged_auth_failure {
|
|
let reason = connection_identity
|
|
.oauth_credentials()
|
|
.ok()
|
|
.flatten()
|
|
.map(|_| McpStartupFailureReason::ReauthenticationRequired);
|
|
let status = McpStartupStatus::Failed {
|
|
error: mcp_init_error_display(
|
|
&server_name,
|
|
Some(&configured_config),
|
|
&error,
|
|
reason,
|
|
),
|
|
reason,
|
|
};
|
|
let tx_event = tx_event.clone();
|
|
let submit_id = startup_submit_id.clone();
|
|
let publication_gate = publication_gate.clone();
|
|
join_set.spawn(async move {
|
|
if !publication_gate.wait().await {
|
|
return (server_name, Err(StartupOutcomeError::Cancelled));
|
|
}
|
|
if let Some(tx_event) = tx_event.as_ref() {
|
|
for status in [McpStartupStatus::Starting, status] {
|
|
let _ = emit_update(
|
|
submit_id.as_str(),
|
|
tx_event,
|
|
McpStartupUpdateEvent {
|
|
server: server_name.clone(),
|
|
status,
|
|
},
|
|
)
|
|
.await;
|
|
}
|
|
}
|
|
(server_name, Err(error))
|
|
});
|
|
} else if let Some(client) = pending_client {
|
|
let publication_gate = publication_gate.clone();
|
|
join_set.spawn(async move {
|
|
if !publication_gate.wait().await {
|
|
return (server_name, Err(StartupOutcomeError::Cancelled));
|
|
}
|
|
(server_name, client.client().await)
|
|
});
|
|
} else {
|
|
reused_ready.push(server_name);
|
|
}
|
|
continue;
|
|
}
|
|
}
|
|
let cancel_token = startup_cancellation_token.child_token();
|
|
let tool_catalog_cache_context = if server_name == CODEX_APPS_MCP_SERVER_NAME {
|
|
None
|
|
} else if let Ok(environment) = resolved_environment.as_ref() {
|
|
tool_catalog_cache.context(
|
|
&server_name,
|
|
&configured_config,
|
|
&runtime_context,
|
|
environment.as_ref(),
|
|
(&client_elicitation_capability, &client_mcp_extensions),
|
|
Some((
|
|
&connection_identity,
|
|
protocol_mode,
|
|
server.is_agent_plugin(),
|
|
)),
|
|
)
|
|
} else {
|
|
None
|
|
};
|
|
let has_runtime_auth = runtime_auth_provider.is_some();
|
|
let async_managed_client = AsyncManagedClient::new(
|
|
server_name.clone(),
|
|
startup_submit_id.clone(),
|
|
server,
|
|
store_mode,
|
|
keyring_backend_kind,
|
|
oauth_refresh_mode,
|
|
cancel_token.clone(),
|
|
tx_event.clone(),
|
|
elicitation_requests.clone(),
|
|
codex_apps_tools_cache_context,
|
|
tool_catalog_cache_context,
|
|
runtime_context.clone(),
|
|
resolved_environment,
|
|
runtime_auth_provider,
|
|
client_elicitation_capability.clone(),
|
|
client_mcp_extensions.clone(),
|
|
auth_manager
|
|
.as_ref()
|
|
.filter(|_| {
|
|
matches!(
|
|
&configured_config.transport,
|
|
McpServerTransportConfig::Stdio { .. }
|
|
)
|
|
})
|
|
.map(|manager| manager.auth_change_state_receiver()),
|
|
protocol_mode,
|
|
catalog_item_limit,
|
|
);
|
|
let defer_startup = allow_deferred_startup
|
|
&& !tool_plugin_provenance.is_selected_plugin_mcp_server(&server_name)
|
|
&& async_managed_client
|
|
.tool_catalog_cache_context
|
|
.as_ref()
|
|
.and_then(McpToolCatalogCacheContext::current_tools)
|
|
.is_some_and(|tools| {
|
|
tools.into_iter().any(|tool| {
|
|
configured_tool_filter.allows(&tool.tool.name)
|
|
&& tool_is_model_visible(&tool)
|
|
})
|
|
});
|
|
let (startup_trigger, startup_receiver) = if defer_startup {
|
|
let (trigger, receiver) = watch::channel(false);
|
|
(Some(trigger), Some(receiver))
|
|
} else {
|
|
(None, None)
|
|
};
|
|
servers.insert(
|
|
server_name.clone(),
|
|
McpServerView {
|
|
connection: Arc::new(McpServerConnection {
|
|
identity: Some(connection_identity),
|
|
client: async_managed_client.clone(),
|
|
startup_timeout,
|
|
startup_trigger,
|
|
_diagnostics_guard: LIVE_CONNECTIONS.track(),
|
|
}),
|
|
protocol_mode,
|
|
metadata,
|
|
tool_filter: configured_tool_filter,
|
|
tool_timeout: configured_tool_timeout,
|
|
catalog_item_limit,
|
|
},
|
|
);
|
|
let tx_event = tx_event.clone();
|
|
let submit_id = startup_submit_id.clone();
|
|
let publication_gate = publication_gate.clone();
|
|
let startup = async move {
|
|
if let Some(mut startup_receiver) = startup_receiver
|
|
&& tokio::select! {
|
|
started = startup_receiver.wait_for(|started| *started) => started.is_err(),
|
|
() = cancel_token.cancelled() => true,
|
|
}
|
|
{
|
|
return (server_name, Err(StartupOutcomeError::Cancelled));
|
|
}
|
|
if !publication_gate.wait().await {
|
|
return (server_name, Err(StartupOutcomeError::Cancelled));
|
|
}
|
|
if let Some(tx_event) = tx_event.as_ref() {
|
|
let _ = emit_update(
|
|
submit_id.as_str(),
|
|
tx_event,
|
|
McpStartupUpdateEvent {
|
|
server: server_name.clone(),
|
|
status: McpStartupStatus::Starting,
|
|
},
|
|
)
|
|
.await;
|
|
}
|
|
let mut outcome = async_managed_client.client().await;
|
|
if cancel_token.is_cancelled() {
|
|
outcome = Err(StartupOutcomeError::Cancelled);
|
|
}
|
|
if let Some(tx_event) = tx_event.as_ref() {
|
|
let auth_state = match &outcome {
|
|
Err(error) if error.is_authentication_required() && !has_runtime_auth => {
|
|
match &configured_config.transport {
|
|
McpServerTransportConfig::StreamableHttp {
|
|
url,
|
|
bearer_token_env_var,
|
|
http_headers,
|
|
env_http_headers,
|
|
..
|
|
} => {
|
|
match determine_streamable_http_auth_status_from_credentials(
|
|
configured_config
|
|
.oauth_credential_name(&server_name)
|
|
.as_ref(),
|
|
url,
|
|
bearer_token_env_var.as_deref(),
|
|
http_headers.clone(),
|
|
env_http_headers.clone(),
|
|
store_mode,
|
|
keyring_backend_kind,
|
|
) {
|
|
Ok(auth_state) => auth_state,
|
|
Err(error) => {
|
|
warn!(
|
|
"failed to read stored auth status for MCP server `{server_name}`: {error:?}"
|
|
);
|
|
None
|
|
}
|
|
}
|
|
}
|
|
McpServerTransportConfig::Stdio { .. } => None,
|
|
}
|
|
}
|
|
Ok(_) | Err(_) => None,
|
|
};
|
|
if cancel_token.is_cancelled() {
|
|
outcome = Err(StartupOutcomeError::Cancelled);
|
|
}
|
|
let status = match &outcome {
|
|
Ok(_) => McpStartupStatus::Ready,
|
|
Err(StartupOutcomeError::Cancelled) => McpStartupStatus::Cancelled,
|
|
Err(error) => {
|
|
let reason = mcp_startup_failure_reason(auth_state, error);
|
|
let error_str = mcp_init_error_display(
|
|
server_name.as_str(),
|
|
Some(&configured_config),
|
|
error,
|
|
reason,
|
|
);
|
|
McpStartupStatus::Failed {
|
|
error: error_str,
|
|
reason,
|
|
}
|
|
}
|
|
};
|
|
|
|
let _ = emit_update(
|
|
submit_id.as_str(),
|
|
tx_event,
|
|
McpStartupUpdateEvent {
|
|
server: server_name.clone(),
|
|
status,
|
|
},
|
|
)
|
|
.await;
|
|
}
|
|
if cancel_token.is_cancelled() {
|
|
outcome = Err(StartupOutcomeError::Cancelled);
|
|
}
|
|
|
|
if matches!(&outcome, Err(StartupOutcomeError::Failed { .. })) {
|
|
async_managed_client.reconnect_failed_startup().await;
|
|
}
|
|
|
|
(server_name, outcome)
|
|
};
|
|
if defer_startup {
|
|
// Dormant servers must not hold the initial startup summary open.
|
|
tokio::spawn(startup);
|
|
} else {
|
|
join_set.spawn(startup);
|
|
}
|
|
}
|
|
let manager = Self {
|
|
servers,
|
|
event_stream_connection,
|
|
disabled_servers,
|
|
required_servers,
|
|
optional_startup_deadline: OnceLock::new(),
|
|
tool_plugin_provenance,
|
|
prefix_mcp_tool_names,
|
|
non_prefixed_mcp_tool_servers,
|
|
elicitation_requests: elicitation_requests.clone(),
|
|
trusted_access,
|
|
};
|
|
let summary_publication_gate = publication_gate;
|
|
tokio::spawn(async move {
|
|
let outcomes = join_set.join_all().await;
|
|
if let Some(tx_event) = tx_event {
|
|
if !summary_publication_gate.wait().await {
|
|
return;
|
|
}
|
|
let mut summary = McpStartupCompleteEvent {
|
|
ready: reused_ready,
|
|
..Default::default()
|
|
};
|
|
for server_name in &summary.ready {
|
|
let _ = emit_update(
|
|
startup_submit_id.as_str(),
|
|
&tx_event,
|
|
McpStartupUpdateEvent {
|
|
server: server_name.clone(),
|
|
status: McpStartupStatus::Ready,
|
|
},
|
|
)
|
|
.await;
|
|
}
|
|
for (server_name, outcome) in outcomes {
|
|
match outcome {
|
|
Ok(_) => summary.ready.push(server_name),
|
|
Err(StartupOutcomeError::Cancelled) => summary.cancelled.push(server_name),
|
|
Err(StartupOutcomeError::Failed { error, .. }) => {
|
|
summary.failed.push(McpStartupFailure {
|
|
server: server_name,
|
|
error,
|
|
})
|
|
}
|
|
}
|
|
}
|
|
let _ = tx_event
|
|
.send(Event {
|
|
id: startup_submit_id,
|
|
msg: EventMsg::McpStartupComplete(summary),
|
|
})
|
|
.await;
|
|
}
|
|
});
|
|
manager
|
|
}
|
|
|
|
pub fn empty(prefix_mcp_tool_names: bool) -> Self {
|
|
Self {
|
|
servers: HashMap::new(),
|
|
event_stream_connection: None,
|
|
disabled_servers: Vec::new(),
|
|
required_servers: Vec::new(),
|
|
optional_startup_deadline: OnceLock::new(),
|
|
tool_plugin_provenance: Arc::new(ToolPluginProvenance::default()),
|
|
prefix_mcp_tool_names,
|
|
non_prefixed_mcp_tool_servers: Vec::new(),
|
|
elicitation_requests: ElicitationRequestManager::default(),
|
|
trusted_access: None,
|
|
}
|
|
}
|
|
|
|
pub fn has_servers(&self) -> bool {
|
|
!self.servers.is_empty()
|
|
}
|
|
|
|
pub(crate) fn contains_server(&self, server_name: &str) -> bool {
|
|
self.servers.contains_key(server_name)
|
|
}
|
|
|
|
pub(crate) async fn authentication_failed_servers(&self) -> Vec<String> {
|
|
let mut failed_servers = Vec::new();
|
|
for (server_name, view) in &self.servers {
|
|
if view
|
|
.connection
|
|
.client
|
|
.startup_complete
|
|
.load(Ordering::Acquire)
|
|
&& let Err(error) = view.connection.client().await
|
|
&& error.is_authentication_required()
|
|
{
|
|
failed_servers.push(server_name.clone());
|
|
}
|
|
}
|
|
failed_servers
|
|
}
|
|
|
|
pub(crate) async fn updated_oauth_credentials_after_auth_failure(
|
|
&self,
|
|
config: &crate::McpConfig,
|
|
) -> Vec<String> {
|
|
let mut candidates = Vec::new();
|
|
for server_name in self.authentication_failed_servers().await {
|
|
if let Some(view) = self.servers.get(&server_name)
|
|
&& let Some(identity) = view.connection.identity.as_ref()
|
|
&& let Some(server) = config.mcp_server_catalog.server(&server_name)
|
|
{
|
|
candidates.push((server_name, identity.clone(), server.config().clone()));
|
|
}
|
|
}
|
|
if candidates.is_empty() {
|
|
return Vec::new();
|
|
}
|
|
|
|
match tokio::task::spawn_blocking(move || {
|
|
candidates
|
|
.into_iter()
|
|
.filter_map(|(server_name, identity, config)| {
|
|
identity
|
|
.oauth_credentials_changed(&server_name, &config)
|
|
.then_some(server_name)
|
|
})
|
|
.collect()
|
|
})
|
|
.await
|
|
{
|
|
Ok(recovered_servers) => recovered_servers,
|
|
Err(error) => {
|
|
warn!(%error, "failed to inspect stored MCP OAuth credentials");
|
|
Vec::new()
|
|
}
|
|
}
|
|
}
|
|
|
|
pub(crate) async fn wait_for_server_startup(&self, server_name: &str) -> bool {
|
|
let Some(view) = self.servers.get(server_name) else {
|
|
return false;
|
|
};
|
|
view.connection.client.ready_transport().is_some() || view.connection.client().await.is_ok()
|
|
}
|
|
|
|
/// Stop all MCP clients owned by this manager and terminate stdio server processes.
|
|
pub async fn shutdown(&self) {
|
|
let connections = self
|
|
.servers
|
|
.values()
|
|
.map(|view| Arc::clone(&view.connection))
|
|
.collect::<Vec<_>>();
|
|
// Keep cleanup alive if an interrupt cancels the refresh that requested it.
|
|
let shutdown_task = tokio::spawn(async move {
|
|
for connection in connections {
|
|
connection.shutdown().await;
|
|
}
|
|
});
|
|
if let Err(error) = shutdown_task.await {
|
|
warn!("MCP client shutdown task failed: {error}");
|
|
}
|
|
}
|
|
|
|
pub(crate) fn cancel_startup(&self) {
|
|
for view in self.servers.values() {
|
|
view.connection.cancel_startup();
|
|
}
|
|
}
|
|
|
|
pub fn plugin_id_for_mcp_server_name(&self, server_name: &str) -> Option<&str> {
|
|
self.tool_plugin_provenance
|
|
.plugin_id_for_mcp_server_name(server_name)
|
|
}
|
|
|
|
pub fn is_selected_plugin_mcp_server(&self, server_name: &str) -> bool {
|
|
self.tool_plugin_provenance
|
|
.is_selected_plugin_mcp_server(server_name)
|
|
}
|
|
|
|
pub async fn wait_for_server_ready(&self, server_name: &str, timeout: Duration) -> bool {
|
|
let Some(view) = self.servers.get(server_name) else {
|
|
return false;
|
|
};
|
|
|
|
match tokio::time::timeout(timeout, view.connection.client()).await {
|
|
Ok(Ok(_)) => true,
|
|
Ok(Err(_)) | Err(_) => false,
|
|
}
|
|
}
|
|
|
|
/// Invoke the tool indicated by the (server, tool) pair.
|
|
#[allow(clippy::too_many_arguments)]
|
|
pub async fn call_tool(
|
|
&self,
|
|
server: &str,
|
|
tool: &str,
|
|
environment_id: Option<&str>,
|
|
arguments: Option<serde_json::Value>,
|
|
mut meta: Option<serde_json::Value>,
|
|
requested_timeout: Option<Duration>,
|
|
wait_for_server: bool,
|
|
) -> Result<CallToolResult> {
|
|
let view = self
|
|
.servers
|
|
.get(server)
|
|
.ok_or_else(|| anyhow!("unknown MCP server '{server}'"))?;
|
|
if let Some(environment_id) = environment_id
|
|
&& view.metadata.environment_id != environment_id
|
|
{
|
|
bail!(
|
|
"MCP server `{server}` is running in environment `{}`, expected `{environment_id}`",
|
|
view.metadata.environment_id
|
|
);
|
|
}
|
|
if !view.tool_filter.allows(tool) {
|
|
return Err(anyhow!(
|
|
"tool '{tool}' is disabled for MCP server '{server}'"
|
|
));
|
|
}
|
|
let client = if wait_for_server {
|
|
view.connection
|
|
.client()
|
|
.await
|
|
.context("failed to get client")?
|
|
} else {
|
|
let client = view
|
|
.connection
|
|
.client
|
|
.ready_client()
|
|
.ok_or_else(|| anyhow!("MCP server '{server}' is not connected"))?;
|
|
if client.client.is_closed().await {
|
|
bail!("MCP server '{server}' is not connected");
|
|
}
|
|
client
|
|
};
|
|
|
|
let effective_timeout = match (view.tool_timeout, requested_timeout) {
|
|
(Some(server_timeout), Some(requested_timeout)) => {
|
|
Some(server_timeout.min(requested_timeout))
|
|
}
|
|
(server_timeout, requested_timeout) => server_timeout.or(requested_timeout),
|
|
};
|
|
// Direct callers cannot supply host-owned entitlement metadata, even for unlisted tools.
|
|
if let Some(serde_json::Value::Object(meta)) = meta.as_mut() {
|
|
meta.remove(ENTITLEMENT_CONTEXT_KEY);
|
|
}
|
|
let result: rmcp::model::CallToolResult = client
|
|
.client
|
|
.call_tool(tool.to_string(), arguments, meta, effective_timeout)
|
|
.await
|
|
.with_context(|| format!("tool call failed for `{server}/{tool}`"))?;
|
|
|
|
Ok(call_tool_result_from_rmcp(result))
|
|
}
|
|
|
|
/// Returns presentation metadata from the current connection.
|
|
/// Codex Apps metadata may come from its existing cache; regular MCP server information is
|
|
/// connection-specific, so pending regular clients are awaited.
|
|
pub(crate) async fn list_available_server_infos(&self) -> HashMap<String, McpServerInfo> {
|
|
let mut server_infos = HashMap::new();
|
|
for (server_name, view) in &self.servers {
|
|
let client = &view.connection.client;
|
|
if !client.startup_complete.load(Ordering::Acquire)
|
|
&& let Some(server_info) = client.cached_server_info.clone()
|
|
{
|
|
server_infos.insert(server_name.clone(), server_info);
|
|
continue;
|
|
}
|
|
match view.connection.client().await {
|
|
Ok(managed_client) => {
|
|
server_infos.insert(server_name.clone(), managed_client.server_info);
|
|
}
|
|
Err(_) => {
|
|
if let Some(server_info) = client.cached_server_info.clone() {
|
|
server_infos.insert(server_name.clone(), server_info);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
server_infos
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
#[path = "connection_manager_tests.rs"]
|
|
pub(crate) mod tests;
|