Struct ResourceBuilder 

pub struct ResourceBuilder { /* private fields */ }

Builder for creating resources with a fluent API

Example

use tower_mcp::resource::ResourceBuilder;
use tower_mcp::protocol::{ReadResourceResult, ResourceContent};

let resource = ResourceBuilder::new("file:///config.json")
    .name("Configuration")
    .description("Application configuration file")
    .mime_type("application/json")
    .handler(|| async {
        Ok(ReadResourceResult {
            contents: vec![ResourceContent {
                uri: "file:///config.json".to_string(),
                mime_type: Some("application/json".to_string()),
                text: Some(r#"{"setting": "value"}"#.to_string()),
                blob: None,
            }],
        })
    })
    .build();

assert_eq!(resource.uri, "file:///config.json");

Implementations

impl ResourceBuilder

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

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

Set the resource name (human-readable)

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

Set a human-readable title for the resource

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

Set the resource description

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

Set the MIME type of the resource

pub fn icon(self, src: impl Into<String>) -> Self

Add an icon for the resource

pub fn icon_with_meta( self, src: impl Into<String>, mime_type: Option<String>, sizes: Option<Vec<String>>, ) -> Self

Add an icon with metadata

pub fn size(self, size: u64) -> Self

Set the size of the resource in bytes

pub fn handler<F, Fut>(self, handler: F) -> ResourceBuilderWithHandler<F>

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<ReadResourceResult>> + Send + 'static,

Set the handler function for reading the resource.

Returns a ResourceBuilderWithHandler that can be used to apply middleware layers via .layer() or build the resource directly via .build().

pub fn handler_with_context<F, Fut>( self, handler: F, ) -> ResourceBuilderWithContextHandler<F>

where F: Fn(RequestContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<ReadResourceResult>> + Send + 'static,

Set a context-aware handler for reading the resource.

The handler receives a RequestContext for progress reporting and cancellation checking.

Returns a ResourceBuilderWithContextHandler that can be used to apply middleware layers via .layer() or build the resource directly via .build().

pub fn text(self, content: impl Into<String>) -> Resource

Create a static text resource (convenience method)

pub fn json(self, value: Value) -> Resource

Create a static JSON resource (convenience method)