Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub port: u16,
    pub name: String,
    pub version: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub website_url: Option<String>,
    pub icons: Option<Vec<Icon>>,
    pub instructions: Option<String>,
    pub sse_keep_alive: Option<Duration>,
}
Expand description

How to serve, and how to introduce yourself.

name and version are constructor arguments rather than optional fields because they are not decoration: the proxy DERIVES its routing prefix from them, so they decide the tool names the agent actually sees. The rest are reporting only.

Fields§

§port: u16

The port the plugin’s manifest declares under mcp.port.

The host publishes exactly that port, so this and the manifest are two halves that have to agree: a mismatch means the host publishes a port nothing is listening on, and the plugin looks dead rather than misconfigured.

§name: String

The server name — load-bearing, not cosmetic.

The proxy builds each upstream’s ROUTING PREFIX from it (_ and . normalize to -), and prepends <prefix>_ to every tool name the agent sees. It is also the key the agent-SDK runners file this server under in their mcpServers config.

Prefixes escalate only as far as uniqueness demands: name, then name-version on collision, then name-version-index. Two plugins sharing a name AND version therefore fall through to a positional index — legal, but unreadable and tied to sort order. Pick a distinct name.

§version: String

The server version — the prefix collision tie-breaker (see name), and reported by servers/list.

§title: Option<String>

Human-readable title. Reporting only.

§description: Option<String>

What this server is. Reporting only.

§website_url: Option<String>

Where to read more. Reporting only.

§icons: Option<Vec<Icon>>

Icons for a UI to show. Reporting only.

§instructions: Option<String>

How a model should use this server — the one field here written FOR the agent rather than about the plugin. Surfaced through agents mcp servers list.

§sse_keep_alive: Option<Duration>

How often to ping an idle SSE stream, or None to never.

Worth having because the connection crosses podman’s port publish and whatever sits between: an idle stream can be reaped by something in the middle that has no idea the plugin is simply thinking.

Implementations§

Source§

impl Config

Source

pub fn new( port: u16, name: impl Into<String>, version: impl Into<String>, ) -> Self

The config for a plugin whose manifest declares mcp.port = port, identifying itself as name/version.

Both identifiers are required for the reason on name: defaulting them would silently hand every plugin the same routing prefix.

Source

pub fn with_title(self, title: impl Into<String>) -> Self

Set the human-readable title.

Source

pub fn with_description(self, description: impl Into<String>) -> Self

Set what this server is.

Source

pub fn with_website_url(self, website_url: impl Into<String>) -> Self

Set where to read more.

Source

pub fn with_icons(self, icons: impl IntoIterator<Item = Icon>) -> Self

Set the icons a UI may show.

Source

pub fn with_instructions(self, instructions: impl Into<String>) -> Self

Set how a model should use this server.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

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 Config

Source§

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

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

impl PartialEq for Config

Source§

fn eq(&self, other: &Config) -> 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 Config

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToAst for T

Source§

fn ast(self, begin: usize, end: usize) -> Spanned<Self>

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<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