Skip to main content

Crate codex_mcp

Crate codex_mcp 

Source

Structs§

CodexAppsAuthElicitation
CodexAppsAuthElicitationPlan
CodexAppsConnectorAuthFailure
EffectiveMcpServer
MCP server after runtime additions have been applied.
ElicitationLifecycle
Holds an owner-provided registration while an MCP elicitation is waiting for a response.
ElicitationRequestRouter
Routes model-visible elicitation response tokens to their exact pending responders.
ElicitationReviewRequest
McpAuthStatusEntry
McpBinding
The exact tool catalog and execution handles for one model sampling request.
McpCatalogBuilder
Mutable inputs used to produce an immutable resolved catalog.
McpConfig
MCP runtime settings derived from codex_core::config::Config.
McpConnectionManager
A thin wrapper around a set of running [RmcpClient] instances.
McpOAuthLoginConfig
McpPermissionPromptAutoApproveContext
McpPluginAttribution
Plugin identity retained with an MCP registration for tool attribution.
McpResourceClient
Access to MCP resources through either the latest runtime or one exact step.
McpResourceClientCacheKey
Opaque identity for the connection set currently used by an MCP resource client.
McpResourcePage
One page of resources returned by an MCP server.
McpResourceReadResult
Contents returned after reading one MCP resource.
McpRuntime
Owns the currently published MCP connection set for one Codex thread.
McpRuntimeContext
Runtime context used when resolving per-server MCP environments.
McpServerConflict
A same-tier name collision and the final outcome after all precedence is applied.
McpServerRegistration
One named MCP server declaration before source resolution.
McpServerStatusSnapshot
McpToolCatalogCache
Process-scoped cache of recent reusable tool definitions for MCP servers.
PluginMcpConfigParseOutcome
Valid servers and per-server errors parsed from one plugin MCP file.
PluginMcpServerParseError
One plugin MCP server that could not be normalized into runtime configuration.
PreparedMcpCall
A call bound to the exact client, tool, timeout, and server metadata seen by one McpBinding.
ResolvedMcpCatalog
Immutable result of MCP registration resolution.
ResolvedMcpOAuthScopes
ResolvedMcpServer
A single winning MCP registration.
SandboxState
ToolInfo
ToolPluginProvenance

Enums§

McpOAuthLoginSupport
McpOAuthScopesSource
McpServerConflictAction
One side of an MCP server conflict, including whether it registers or removes the server.
McpServerSource
The component that declared an MCP server registration.
McpSnapshotDetail

Constants§

CODEX_APPS_MCP_SERVER_NAME
MCP_SANDBOX_STATE_META_CAPABILITY
MCP server capability indicating that Codex should include [SandboxState] in tool-call request _meta under this key.
MCP_TOOL_CODEX_APPS_META_KEY

Traits§

ElicitationReviewer

Functions§

auth_elicitation_completed_result
auth_elicitation_id
build_auth_elicitation
build_auth_elicitation_plan
codex_apps_mcp_server_config
codex_apps_tools_cache_key
Backward-compatible name for the Codex Apps runtime context key builder. Builds the connector runtime context key for the active Codex auth.
collect_mcp_server_status_snapshot_with_detail
compute_auth_statuses
configured_mcp_servers
connector_auth_failure_from_tool_result
declared_openai_file_input_param_names
discover_supported_scopes
discover_supported_scopes_with_http_client
effective_mcp_servers
effective_mcp_servers_from_configured
Converts a materialized server map to its auth-gated runtime view.
host_owned_codex_apps_enabled
hosted_plugin_runtime_mcp_server_config
Builds the ChatGPT-hosted plugin runtime served by plugin-service.
mcp_permission_prompt_is_auto_approved
Returns true when MCP permission prompts should resolve as approved instead of being shown to the user.
oauth_login_support
oauth_login_support_with_http_client
parse_executor_plugin_mcp_config
Parses executor-owned plugin MCP config without interpreting the plugin root as a path on the orchestrator host.
parse_plugin_mcp_config
Parses the two supported plugin MCP file shapes and normalizes each server.
qualified_mcp_tool_name_prefix
read_mcp_resource
resolve_oauth_scopes
should_retry_without_scopes
tool_is_model_visible
Returns whether a tool may be included in model-facing tool declarations.
tool_plugin_provenance

Type Aliases§

CodexAppsToolsCache
Backward-compatible name for the shared Codex Apps tools runtime.
CodexAppsToolsCacheKey
Backward-compatible name for the Codex Apps runtime context key.
ElicitationReviewerHandle