Struct Oxicode 

pub struct Oxicode { /* private fields */ }

Oxicode AI engine instance — holds isolated provider and model registries.

Created via OxicodeBuilder. Provides access to providers, models, provider creation, and agent building.

Implements ProviderResolver so it can be passed directly to oxicode_agent::Agent::new_with_resolver for fully isolated operation.

Implementations

impl Oxicode

pub fn agent(&self, config: AgentConfig) -> AgentBuilder<'_>

Create an agent builder with the given config.

pub fn providers(&self) -> &ProviderRegistry

Get the provider registry.

pub fn models(&self) -> &ModelRegistry

Get the model registry.

pub fn tools(&self) -> Arc<ToolRegistry>

Get the shared tool registry.

pub fn ports(&self) -> &PortRegistry

Get the port registry (state, config, auth, event bus, …).

pub fn catalog(&self) -> &Arc<dyn ModelCatalog>

Catalog port accessor. Use this for all catalog queries.

Returns a reference to the Arc<dyn ModelCatalog>. The default (when OxicodeBuilder::with_catalog() is not called) is a NoopModelCatalog — all lookups return empty/None.

Example

let providers = oxicode.catalog().list_providers().await?;
let model = oxicode.catalog().get_model("anthropic", "claude-sonnet-4-20250514").await?;

pub fn mcp(&self) -> Option<Arc<McpManager>>

Get the MCP manager, if MCP is enabled.

This is the entry point for SDK consumers who want to use MCP from outside the agent loop — e.g. the TUI dashboard, RPC handlers, or custom agent integrations.

Returns None if MCP was disabled via OxicodeBuilder::with_mcp with false.

pub fn resolve_model(&self, model_id: &str) -> SdkResult<Model>

Resolve a model ID to a Model.

Accepts "provider/model" or bare "model" (defaults to “anthropic”).

Resolution order:

1. The catalog port (if wired) — reads the in-memory snapshot.
2. The static model registry (with_builtins).

The routing.excluded_models list is consulted before the catalog/static lookups — set_enabled(false) / exclude_model / unexclude_model on the shared RoutingControl instance take effect on the next resolution.

pub fn create_provider(&self, name: &str) -> SdkResult<Arc<dyn Provider>>

1. Custom providers registered via OxicodeBuilder::provider()
2. Provider factories registered via OxicodeBuilder::provider_factory()
3. Built-in providers with credential injection (if with_builtins() was called): a. Explicit per-provider key from OxicodeBuilder::api_key(name, key) b. The wired AuthProvider port (sync fast-path). This is the primary credential source for products like the CLI, which never call OxicodeBuilder::api_key() and instead register FileAuthProvider via .with_auth(...). Consulted on every create_provider call, so auth-store updates (e.g. a key entered via the TUI overlay) are picked up without rebuilding the engine. c. Provider env var (the create_builtin_provider_with_options fallback inside oxicode-ai).

This is the single credential authority for the agent loop: the AgentConfig.api_key field and the api_key params on Agent::switch_model / Agent::refresh_api_key are vestigial after this wiring and are removed in a follow-up. See issues #39 and #40.

pub fn providers_arc(&self) -> Arc<ProviderRegistry>

Get the provider registry (Arc clone).

pub fn models_arc(&self) -> Arc<ModelRegistry>

Get the model registry (Arc clone).

pub fn has_builtins(&self) -> bool

Check whether built-in providers are enabled.

pub fn routing(&self) -> &Arc<RoutingControl>

Borrow the shared crate::routing::RoutingControl instance. Use this to call set_enabled, exclude_model, set_fallback_models, etc. Mutations are observed by the next model/provider resolution.

Trait Implementations

impl Clone for Oxicode

fn clone(&self) -> Oxicode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ProviderResolver for Oxicode

Implement ProviderResolver so Oxicode can be used as Agent’s resolver.

fn resolve_provider(&self, name: &str) -> Option<Arc<dyn Provider>>

Resolve a provider by name, returning an Arc handle.

fn resolve_model(&self, model_id: &str) -> Option<Model>

Resolve a model ID (“provider/model” or bare “model”) to a Model.