Skip to main content

McpManager

Struct McpManager 

Source
pub struct McpManager { /* private fields */ }
Expand description

Central manager for all MCP server connections.

Created via McpManager::spawn() which returns an Arc<Self>. Use McpManager::new_no_spawn() only in tests where the lifecycle task is not needed.

Implementations§

Source§

impl McpManager

Source

pub fn spawn() -> Arc<Self>

Spawns the background lifecycle task using the oxicode-default config and disk paths (~/.config/oxicode/), and eagerly connects to any Eager / KeepAlive servers.

Returns Arc<Self> so it can be shared freely across the agent loop, the TUI dashboard, and the lifecycle task (via Weak).

Source

pub fn spawn_with_config(mcp_config: McpConfig) -> Arc<Self>

Spawn with a programmatically-supplied config (used by the SDK OxicodeBuilder::with_mcp_config). Disk paths default to the oxicode standard locations (~/.config/oxicode/).

Source

pub fn spawn_with_paths( mcp_config: McpConfig, cache_path: Option<PathBuf>, consent_path: Option<PathBuf>, ) -> Arc<Self>

Primary constructor. Spawn with a programmatically-supplied config and optional custom disk paths for the metadata cache and consent store.

Pass None for either path to use the oxicode default (~/.config/oxicode/mcp-cache.json / mcp-consent.json).

This is the constructor SDK consumers (e.g. oxios) should use when they self-host MCP state under their own config directory. It spawns the background lifecycle task and eagerly connects to any Eager / KeepAlive servers.

Returns Arc<Self> so it can be shared freely across the agent loop, the TUI dashboard, and the lifecycle task (via Weak).

Source

pub fn new_no_spawn() -> Self

Construct a manager without spawning the lifecycle task. Intended for tests that don’t need timer/disconnect behaviour.

Source

pub fn config(&self) -> RwLockReadGuard<'_, McpConfig>

Get a snapshot of the current config.

Source

pub fn replace_config(&self, new_config: McpConfig)

Hot-replace the in-memory MCP configuration.

Used by the /mcp management overlay after it writes a new config to disk: the updated server map becomes visible to connect(), status(), and the proxy tool without a full process restart. Existing live connections are left untouched; newly added servers connect lazily on first use (or eagerly if their LifecycleMode is eager/keep-alive).

Direct-tool registration happens once at boot from the cache, so newly-added directTools servers still require a restart to surface as first-class agent tools — but the mcp proxy tool can reach them immediately.

Source

pub fn set_credential_provider(&self, provider: Arc<dyn McpCredentialProvider>)

Inject a credential provider. Replaces the noop default. Called by oxicode-cli bootstrap (or any host product) to enable authenticated MCP servers.

Existing transports retain the provider they were constructed with; new transports created after this call pick up the new one at their next construction.

Source

pub fn consent(&self) -> &ConsentManager

Get the consent manager.

Source

pub fn cache(&self) -> &MetadataCache

Get the metadata cache.

Source

pub async fn status(self: &Arc<Self>) -> String

Get a formatted status summary (legacy mcp({}) interface).

Source

pub fn dashboard_data(self: &Arc<Self>) -> McpDashboardData

Snapshot of dashboard data (Phase 2). Synchronous — only reads parking_lot-guarded state and in-memory copies of cached tool lists, so it is safe to call from render().

Source

pub async fn connect(self: &Arc<Self>, server_name: &str) -> Result<String>

Connect to a specific MCP server by name. Selects the transport from the entry: command → stdio (spawn), url → Streamable HTTP. Stores the connected client and updates the metadata cache.

Source

pub fn trust_server(&self, server_name: &str) -> Result<()>

Trust an MCP server for spawn consent (persist Allow to disk). Used by oxicode mcp trust <server>. After this, the server’s next connect() proceeds past the consent gate.

Source

pub fn untrust_server(&self, server_name: &str) -> Result<()>

Revoke spawn trust for an MCP server (persist Deny to disk). Used by oxicode mcp untrust <server>. After this, the server’s next connect() is denied with McpError::ConsentDenied.

Source

pub async fn ensure_connected(self: &Arc<Self>, server_name: &str) -> bool

Lazily connect (or return true if already connected).

Source

pub async fn disconnect(self: &Arc<Self>, server_name: &str) -> Result<bool>

Manually disconnect a single server. Exposed for the MCP dashboard’s D key. Idempotent — returns Ok(true) if a live connection was actually closed, Ok(false) if the server was already disconnected.

Source

pub async fn reauth_server(self: &Arc<Self>, server_name: &str) -> Result<()>

Force-refresh the OAuth credential for server_name (v2.2). Used by /mcp reauth <server> to rotate credentials without restarting the process. Returns an error if no credential provider is configured, the server has no url, or the refresh fails.

Source

pub async fn call_tool( self: &Arc<Self>, tool_name: &str, args: Value, server_override: Option<&str>, ) -> Result<McpCallResult>

Call an MCP tool by name, optionally targeting a specific server.

Source

pub async fn list_resources( self: &Arc<Self>, server_name: &str, ) -> Result<Vec<Value>>

List resources from a connected MCP server (v2.3 G5).

Source

pub async fn read_resource( self: &Arc<Self>, server_name: &str, uri: &str, ) -> Result<Vec<McpContent>>

Read a resource URI from a connected MCP server (v2.3 G5).

Source

pub async fn list_prompts( self: &Arc<Self>, server_name: &str, ) -> Result<Vec<McpPrompt>>

List prompt templates from a connected MCP server (v2.3 G5).

Source

pub async fn get_prompt( self: &Arc<Self>, server_name: &str, name: &str, arguments: HashMap<String, String>, ) -> Result<Vec<Value>>

Get a prompt template with arguments (v2.3 G5).

Source

pub fn reset_idle_timer(self: &Arc<Self>, server_name: &str)

Reset (or start) the idle-disconnect timer for a server. Called after every successful tool use.

Source

pub async fn describe(self: &Arc<Self>, tool_name: &str) -> Result<String>

Describe a tool by name.

Source

pub async fn search( self: &Arc<Self>, query: &str, regex: bool, server_filter: Option<&str>, ) -> Result<String>

Search tools by name or description.

Source

pub async fn list_tools(self: &Arc<Self>, server_name: &str) -> Result<String>

List tools for a specific server.

Source

pub fn direct_tools_from_cache(self: &Arc<Self>) -> Vec<DirectToolDef>

Direct tool definitions for ToolRegistry registration (Phase 3). Reads from the metadata cache, applies direct_tools / exclude_tools filters, and returns the precomputed prefixed names.

Source

pub fn should_disable_proxy(self: &Arc<Self>) -> bool

Whether the mcp proxy tool should be hidden in the tool registry (Phase 3 — settings.disable_proxy_tool: true).

Trait Implementations§

Source§

impl Debug for McpManager

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for McpManager

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeSendSync for T

Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more