Skip to main content

McpConfigBuilder

Struct McpConfigBuilder 

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

A set of MCP servers for one run.

Implementations§

Source§

impl McpConfigBuilder

Source

pub fn new() -> Self

An empty set.

Source

pub fn server(self, name: impl Into<String>, config: McpServerConfig) -> Self

Add a server.

Source

pub fn stdio_server( self, name: impl Into<String>, command: impl Into<String>, ) -> Self

Add a subprocess server. Shorthand for McpServerConfig::stdio.

Source

pub fn http_server( self, name: impl Into<String>, url: impl Into<String>, ) -> Self

Add an HTTP server. Shorthand for McpServerConfig::http.

Source

pub fn config_overrides(&self) -> Vec<String>

key=value strings for ExecCommand::config, or for the client builder’s config when the whole client should carry them.

Ordered, so the same set produces the same arguments.

Source

pub fn to_toml(&self) -> String

The same configuration as a TOML document.

Suitable for a $CODEX_HOME/<name>.config.toml profile, which --profile layers over the base config.

Source

pub fn write_profile( &self, codex_home: impl AsRef<Path>, profile: &str, ) -> Result<PathBuf>

Write to_toml to $CODEX_HOME/<profile>.config.toml and return the path.

Reachable afterwards as --profile <profile>. This writes into the user’s codex home, so it is persistent: prefer config_overrides for a single run.

Source

pub fn is_empty(&self) -> bool

Whether any server has been added.

Trait Implementations§

Source§

impl Clone for McpConfigBuilder

Source§

fn clone(&self) -> McpConfigBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for McpConfigBuilder

Source§

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

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

impl Default for McpConfigBuilder

Source§

fn default() -> McpConfigBuilder

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

impl Eq for McpConfigBuilder

Source§

impl PartialEq for McpConfigBuilder

Source§

fn eq(&self, other: &McpConfigBuilder) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for McpConfigBuilder

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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<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