Skip to main content

Root

Struct Root 

Source
pub struct Root {
    pub uri: String,
    pub name: Option<String>,
    pub meta: Option<HashMap<String, Value>>,
}
๐Ÿ‘ŽDeprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28). Replacement: pass directories or files via tool parameters, resource URIs, or server configuration. Earliest removal: first release on/after 2027-07-28.

Expand description

Root directory entry.

Deprecated per SEP-2577 โ€” see module-level docs.

Fieldsยง

ยงuri: String
๐Ÿ‘ŽDeprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28). Replacement: pass directories or files via tool parameters, resource URIs, or server configuration. Earliest removal: first release on/after 2027-07-28.

URI of the root (must start with โ€œfile://โ€ currently)

ยงname: Option<String>
๐Ÿ‘ŽDeprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28). Replacement: pass directories or files via tool parameters, resource URIs, or server configuration. Earliest removal: first release on/after 2027-07-28.

Optional human-readable name

ยงmeta: Option<HashMap<String, Value>>
๐Ÿ‘ŽDeprecated since 0.4.0:

Deprecated per SEP-2577 (2026-07-28). Replacement: pass directories or files via tool parameters, resource URIs, or server configuration. Earliest removal: first release on/after 2027-07-28.

Optional metadata

Implementationsยง

Sourceยง

impl Root

Source

pub fn new(uri: impl Into<String>) -> Root

Source

pub fn with_name(self, name: impl Into<String>) -> Root

Source

pub fn with_meta(self, meta: HashMap<String, Value>) -> Root

Source

pub fn validate(&self) -> Result<(), String>

Validate that the URI follows MCP requirements

Trait Implementationsยง

Sourceยง

impl Clone for Root

Sourceยง

fn clone(&self) -> Root

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 Root

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl<'de> Deserialize<'de> for Root

Sourceยง

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

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

impl HasRootAnnotations for Root

Sourceยง

fn annotations(&self) -> Option<&HashMap<String, Value>>

Get custom metadata
Sourceยง

fn tags(&self) -> Option<&[String]>

Get root-specific tags or labels
Sourceยง

impl HasRootFiltering for Root

Sourceยง

fn allowed_extensions(&self) -> Option<&[String]>

File extensions to include (None = all)
Sourceยง

fn excluded_patterns(&self) -> Option<&[String]>

File patterns to exclude (glob patterns)
Sourceยง

fn should_include(&self, path: &str) -> bool

Check if a file should be included
Sourceยง

impl HasRootMetadata for Root

Sourceยง

fn name(&self) -> Option<&str>

Optional human-readable name
Sourceยง

fn uri(&self) -> &str

The root URI (must start with โ€œfile://โ€)
Sourceยง

fn description(&self) -> Option<&str>

Optional description or additional metadata
Sourceยง

impl HasRootPermissions for Root

Sourceยง

fn can_read(&self, _path: &str) -> bool

Check if read access is allowed for this path
Sourceยง

fn can_write(&self, _path: &str) -> bool

Check if write access is allowed for this path
Sourceยง

fn max_depth(&self) -> Option<usize>

Get maximum depth for directory traversal
Sourceยง

impl Serialize for Root

Sourceยง

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::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<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> 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<B> IntoFunctionResponse<B, Body> for B
where B: Serialize,

Sourceยง

fn into_response(self) -> FunctionResponse<B, Body>

Convert the type into a FunctionResponse.
Sourceยง

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

Sourceยง

impl<T> RootDefinition for T

Sourceยง

fn to_root(&self) -> Root

Convert this root definition to a protocol Root
Sourceยง

fn validate(&self) -> Result<(), String>

Validate this root definition
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