Struct UltraFastClient

pub struct UltraFastClient { /* private fields */ }

UltraFast MCP Client

Implementations

impl UltraFastClient

pub fn new(info: ClientInfo, capabilities: ClientCapabilities) -> Self

Create a new MCP client

pub fn new_with_timeout( info: ClientInfo, capabilities: ClientCapabilities, timeout: Duration, ) -> Self

Create a new MCP client with custom timeout

pub fn with_timeout(self, timeout: Duration) -> Self

Set request timeout

pub fn with_timeout_config(self, config: TimeoutConfig) -> Self

Set timeout configuration

pub fn get_timeout_config(&self) -> TimeoutConfig

Get current timeout configuration

pub fn with_high_performance_timeouts(self) -> Self

Set timeout configuration for high-performance scenarios

pub fn with_long_running_timeouts(self) -> Self

Set timeout configuration for long-running operations

pub fn get_operation_timeout(&self, operation: &str) -> Duration

Get operation-specific timeout

pub fn with_auth(self, auth_method: AuthMethod) -> Self

Set authentication method

pub fn with_bearer_auth(self, token: String) -> Self

Set Bearer token authentication

pub fn with_bearer_auth_refresh<F, Fut>( self, token: String, refresh_fn: F, ) -> Self

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

Set Bearer token authentication with auto-refresh

pub fn with_oauth_auth(self, config: OAuthConfig) -> Self

Set OAuth authentication

pub fn with_api_key_auth(self, api_key: String) -> Self

Set API key authentication

pub fn with_api_key_auth_custom( self, api_key: String, header_name: String, ) -> Self

Set API key authentication with custom header name

pub fn with_basic_auth(self, username: String, password: String) -> Self

Set Basic authentication

pub fn with_custom_auth(self) -> Self

Set custom header authentication

pub async fn get_auth_headers( &self, ) -> Result<HashMap<String, String>, AuthError>

Get authentication headers for requests

pub fn with_elicitation_handler( self, handler: Arc<dyn ClientElicitationHandler>, ) -> Self

Set elicitation handler for handling server-initiated elicitation requests

pub async fn connect(&self, transport: Box<dyn Transport>) -> MCPResult<()>

Connect to a server using the provided transport

pub async fn connect_stdio(&self) -> MCPResult<()>

Connect to a server using STDIO transport

pub async fn connect_streamable_http(&self, url: &str) -> MCPResult<()>

Connect to a server using Streamable HTTP transport This method will automatically use any client-level authentication configured

pub async fn connect_http_with_auth( &self, url: &str, auth_token: String, ) -> MCPResult<()>

Connect to a server using HTTP transport with authentication

pub async fn connect_streamable_http_with_bearer( &self, url: &str, token: String, ) -> MCPResult<()>

Connect to a server using Streamable HTTP transport with Bearer token authentication

pub async fn connect_streamable_http_with_oauth( &self, url: &str, oauth_config: OAuthConfig, ) -> MCPResult<()>

Connect to a server using Streamable HTTP transport with OAuth 2.1 authentication

pub async fn connect_streamable_http_with_api_key( &self, url: &str, api_key: String, ) -> MCPResult<()>

Connect to a server using Streamable HTTP transport with API key authentication

pub async fn connect_streamable_http_with_api_key_custom( &self, url: &str, api_key: String, header_name: String, ) -> MCPResult<()>

Connect to a server using Streamable HTTP transport with API key authentication (custom header)

pub async fn connect_streamable_http_with_basic( &self, url: &str, username: String, password: String, ) -> MCPResult<()>

Connect to a server using Streamable HTTP transport with Basic authentication

pub async fn connect_streamable_http_with_config( &self, config: StreamableHttpClientConfig, ) -> MCPResult<()>

Connect to a server using Streamable HTTP transport with custom configuration

pub async fn initialize(&self) -> MCPResult<()>

Initialize the connection with the server Initialize the client connection This method must be called after connecting to establish the MCP protocol

pub async fn shutdown(&self, reason: Option<String>) -> MCPResult<()>

Shutdown the client

pub async fn disconnect(&self) -> MCPResult<()>

Disconnect from the server

pub async fn get_state(&self) -> ClientState

Get current client state

pub async fn can_operate(&self) -> bool

Check if client can perform operations

pub async fn get_server_info(&self) -> Option<ServerInfo>

Get server information

pub async fn get_server_capabilities(&self) -> Option<ServerCapabilities>

Get server capabilities

pub async fn get_negotiated_version(&self) -> Option<String>

Get negotiated protocol version

pub fn info(&self) -> &ClientInfo

Get client information

pub async fn check_server_capability(&self, capability: &str) -> MCPResult<bool>

Check if server supports a specific capability

pub async fn check_server_feature( &self, capability: &str, feature: &str, ) -> MCPResult<bool>

Check if server supports a specific feature within a capability

pub async fn list_tools( &self, request: ListToolsRequest, ) -> MCPResult<ListToolsResponse>

List available tools

pub async fn list_tools_default(&self) -> MCPResult<ListToolsResponse>

List tools with default parameters

pub async fn call_tool(&self, tool_call: ToolCall) -> MCPResult<ToolResult>

Call a tool

pub async fn list_resources( &self, request: ListResourcesRequest, ) -> MCPResult<ListResourcesResponse>

List available resources

pub async fn read_resource( &self, request: ReadResourceRequest, ) -> MCPResult<ReadResourceResponse>

Read a resource

pub async fn subscribe_resource(&self, uri: String) -> MCPResult<()>

Subscribe to resource changes

pub async fn list_prompts( &self, request: ListPromptsRequest, ) -> MCPResult<ListPromptsResponse>

List available prompts

pub async fn get_prompt( &self, request: GetPromptRequest, ) -> MCPResult<GetPromptResponse>

Get a specific prompt

pub async fn create_message( &self, request: CreateMessageRequest, ) -> MCPResult<CreateMessageResponse>

Create a message using sampling

pub async fn complete( &self, request: CompleteRequest, ) -> MCPResult<CompleteResponse>

Complete a request

pub async fn respond_to_elicitation( &self, response: ElicitationResponse, ) -> MCPResult<()>

Respond to elicitation request (called by client-side elicitation handler)

pub async fn list_roots(&self) -> MCPResult<Vec<Root>>

List filesystem roots

pub async fn set_log_level(&self, level: LogLevel) -> MCPResult<()>

Set log level

pub async fn ping(&self, data: Option<Value>) -> MCPResult<PingResponse>

Send ping

pub async fn start_ping_monitoring( &self, ping_interval: Duration, ) -> MCPResult<()>

Start periodic ping monitoring (optional, for connection health)

pub async fn stop_ping_monitoring(&self) -> MCPResult<()>

Stop ping monitoring

pub async fn notify_cancelled( &self, request_id: Value, reason: Option<String>, ) -> MCPResult<()>

Notify cancellation

pub async fn notify_progress( &self, progress_token: Value, progress: f64, total: Option<f64>, message: Option<String>, ) -> MCPResult<()>

Notify progress

pub fn should_send_progress(&self, last_progress: Instant) -> bool

Check if progress notification should be sent based on timeout configuration

pub fn get_progress_interval(&self) -> Duration

Get progress interval from timeout configuration

Trait Implementations

impl Debug for UltraFastClient

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

Formats the value using the given formatter.