Skip to main content

HttpClientConfig

Struct HttpClientConfig 

Source
pub struct HttpClientConfig {
    pub headers: HashMap<String, String>,
    pub auto_sse: bool,
    pub channel_capacity: usize,
    pub request_timeout: Duration,
    pub notification_timeout: Duration,
    pub sse_reconnect: bool,
    pub sse_reconnect_delay: Duration,
    pub max_sse_reconnect_attempts: u32,
    pub session_recovery: bool,
    pub max_sse_event_size: usize,
}
Expand description

Configuration for HttpClientTransport.

§Example

use tower_mcp::client::{HttpClientTransport, HttpClientConfig};
use std::time::Duration;

let config = HttpClientConfig {
    request_timeout: Duration::from_secs(60),
    ..Default::default()
};
let transport = HttpClientTransport::with_config("http://localhost:3000", config);

Fields§

§headers: HashMap<String, String>

Custom headers to include on every request (e.g., auth tokens).

§auto_sse: bool

Whether to automatically open the standalone SSE notification stream after initialization. Associated POST response streams used for sampling, elicitation, and roots requests work independently. Default: true.

§channel_capacity: usize

Capacity of the internal message channel. Default: 256.

§request_timeout: Duration

Timeout for HTTP requests. Default: 30 seconds.

§notification_timeout: Duration

Timeout for notification POSTs (frames without an id), capped at request_timeout.

Notifications are awaited inline so notifications/initialized is ordered ahead of the first request, which blocks the client’s message loop for the duration. This bounds that block independently of request_timeout so a server that stalls a notification’s 202 cannot freeze the client for the full request timeout. Default: 5 seconds.

§sse_reconnect: bool

Whether to attempt SSE reconnection on disconnect. Default: true.

§sse_reconnect_delay: Duration

Delay before SSE reconnection attempts. Default: 1 second.

§max_sse_reconnect_attempts: u32

Maximum SSE reconnection attempts before giving up. Default: 5.

§session_recovery: bool

Whether to support automatic session recovery on expiry. When enabled, HTTP 404 responses (with a session ID attached) and JSON-RPC -32005 errors trigger re-initialization. Default: true.

§max_sse_event_size: usize

Maximum size in bytes buffered for a single SSE event.

A server that streams an event without ever terminating it would otherwise grow the parse buffer without bound. When a single event’s buffered size exceeds this cap, the stream is terminated with Error::SseEventTooLarge. Default: 16 MiB (matching rmcp).

Implementations§

Source§

impl HttpClientConfig

Source

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

Set a Bearer token for authentication.

Source

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

Set an API key using a custom header name.

Source

pub fn basic_auth( self, username: impl AsRef<str>, password: impl AsRef<str>, ) -> Self

Set Basic authentication credentials.

Source

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

Add a custom header.

Trait Implementations§

Source§

impl Clone for HttpClientConfig

Source§

fn clone(&self) -> HttpClientConfig

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 HttpClientConfig

Source§

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

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

impl Default for HttpClientConfig

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be 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