Skip to main content

McpConfig

Struct McpConfig 

Source
pub struct McpConfig {
    pub title: Option<String>,
    pub description: Option<String>,
    pub instructions: Option<String>,
    pub tool_prefix: Option<ToolPrefix>,
}
Expand description

Optional overrides for the text mcpls reports about itself over MCP.

Every field is None by default, which keeps today’s hardcoded serverInfo.title/description and built-in capability blurb unchanged. serverInfo.name, version, and website_url are not configurable here: name is the MCP-spec machine identifier asserted in integration tests, and version/website_url are project metadata, not presentation text.

A configured instructions replaces the built-in capability blurb in ServerInfo.instructions rather than appending to it – an agent that reads instructions at connection time (see skills/mcpls/SKILL.md) sees only the configured text, plus the unrelated untrusted-project-config NOTE (see ServerConfig::project_config_ignored), which is always appended afterward regardless of this field.

Every field reaches an MCP client verbatim on every initialize response, into what is typically an LLM context window – this is why ServerConfig::validate enforces the MAX_MCP_* byte caps on all three.

§Examples

use mcpls_core::config::ServerConfig;

let toml = r#"
    [mcp]
    title = "My Custom Bridge"
    description = "Internal LSP bridge for Acme Corp"
    instructions = "Use get_hover before get_definition."
"#;
let config: ServerConfig = toml::from_str(toml).unwrap();
assert_eq!(config.mcp.title.as_deref(), Some("My Custom Bridge"));

Fields§

§title: Option<String>

Overrides serverInfo.title. Omit to keep the built-in title.

§description: Option<String>

Overrides serverInfo.description. Omit to keep the built-in description (CARGO_PKG_DESCRIPTION).

§instructions: Option<String>

Replaces the built-in ServerInfo.instructions capability blurb. Omit to keep the built-in text. The untrusted-project-config NOTE (see ServerConfig::project_config_ignored) is still appended after this value when set.

§tool_prefix: Option<ToolPrefix>

Prefixes every MCP tool name with {tool_prefix}_, so an MCP client running multiple mcpls bridges concurrently (one per project) can tell their tools apart. Omit to keep the default, unprefixed tool names.

Trait Implementations§

Source§

impl Clone for McpConfig

Source§

fn clone(&self) -> McpConfig

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 McpConfig

Source§

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

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

impl Default for McpConfig

Source§

fn default() -> McpConfig

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

impl<'de> Deserialize<'de> for McpConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for McpConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

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

fn try_from(value: U) -> Result<T, !>

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