Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions crates/rmcp/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -230,3 +230,13 @@ path = "tests/test_sampling.rs"
name = "test_close_connection"
required-features = ["server", "client"]
path = "tests/test_close_connection.rs"

[[test]]
name = "test_custom_headers"
required-features = [
"client",
"server",
"transport-streamable-http-client-reqwest",
"transport-streamable-http-server",
]
path = "tests/test_custom_headers.rs"
8 changes: 5 additions & 3 deletions crates/rmcp/src/transport/auth.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,8 @@ use thiserror::Error;
use tokio::sync::{Mutex, RwLock};
use tracing::{debug, error, warn};

use crate::transport::common::http_header::HEADER_MCP_PROTOCOL_VERSION;

const DEFAULT_EXCHANGE_URL: &str = "http://localhost";

/// Stored credentials for OAuth2 authorization
Expand DownExpand Up@@ -1051,7 +1053,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(discovery_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1171,7 +1173,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1224,7 +1226,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(resource_metadata_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
use std::collections::HashMap;

use http::{HeaderName, HeaderValue};

use crate::transport::{
auth::AuthClient,
streamable_http_client::{StreamableHttpClient, StreamableHttpError},
Expand DownExpand Up@@ -47,6 +51,7 @@ where
message: crate::model::ClientJsonRpcMessage,
session_id: Option<std::sync::Arc<str>>,
mut auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<
crate::transport::streamable_http_client::StreamableHttpPostResponse,
StreamableHttpError<Self::Error>,
Expand All@@ -55,7 +60,7 @@ where
auth_token = Some(self.get_access_token().await?);
}
self.http_client
.post_message(uri, message, session_id, auth_token)
.post_message(uri, message, session_id, auth_token, custom_headers)
.await
}
}
1 change: 1 addition & 0 deletions crates/rmcp/src/transport/common/http_header.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
pub const HEADER_SESSION_ID: &str = "Mcp-Session-Id";
pub const HEADER_LAST_EVENT_ID: &str = "Last-Event-Id";
pub const HEADER_MCP_PROTOCOL_VERSION: &str = "MCP-Protocol-Version";
pub const EVENT_STREAM_MIME_TYPE: &str = "text/event-stream";
pub const JSON_MIME_TYPE: &str = "application/json";
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
use std::{borrow::Cow, sync::Arc};
use std::{borrow::Cow, collections::HashMap, sync::Arc};

use futures::{StreamExt, stream::BoxStream};
use http::header::WWW_AUTHENTICATE;
use http::{HeaderName, HeaderValue, header::WWW_AUTHENTICATE};
use reqwest::header::ACCEPT;
use sse_stream::{Sse, SseStream};

use crate::{
model::{ClientJsonRpcMessage, ServerJsonRpcMessage},
transport::{
common::http_header::{
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_SESSION_ID, JSON_MIME_TYPE,
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_MCP_PROTOCOL_VERSION,
HEADER_SESSION_ID, JSON_MIME_TYPE,
},
streamable_http_client::*,
},
Expand DownExpand Up@@ -94,13 +95,34 @@ impl StreamableHttpClient for reqwest::Client {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>> {
let mut request = self
.post(uri.as_ref())
.header(ACCEPT, [EVENT_STREAM_MIME_TYPE, JSON_MIME_TYPE].join(", "));
if let Some(auth_header) = auth_token {
request = request.bearer_auth(auth_header);
}

// Apply custom headers
let reserved_headers = [
ACCEPT.as_str(),
HEADER_SESSION_ID,
HEADER_MCP_PROTOCOL_VERSION,
HEADER_LAST_EVENT_ID,
];
for (name, value) in custom_headers {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps disallow any of the headers that are controlled by the default client logic?

ACCEPTHEADER_SESSION_ID etc

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would check https://modelcontextprotocol.io/specification/2025-11-25/basic/transports#streamable-http for a full list

MCP-Protocol-Version is another one that comes to mind

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. I've updated the PR to add the check.

if reserved_headers
.iter()
.any(|&r| name.as_str().eq_ignore_ascii_case(r))
{
return Err(StreamableHttpError::ReservedHeaderConflict(
name.to_string(),
));
}

request = request.header(name, value);
}
if let Some(session_id) = session_id {
request = request.header(HEADER_SESSION_ID, session_id.as_ref());
}
Expand Down
45 changes: 44 additions & 1 deletion crates/rmcp/src/transport/streamable_http_client.rs
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
use std::{borrow::Cow, sync::Arc, time::Duration};
use std::{borrow::Cow, collections::HashMap, sync::Arc, time::Duration};

use futures::{Stream, StreamExt, future::BoxFuture, stream::BoxStream};
use http::{HeaderName, HeaderValue};
pub use sse_stream::Error as SseError;
use sse_stream::Sse;
use thiserror::Error;
Expand DownExpand Up@@ -76,6 +77,8 @@ pub enum StreamableHttpError<E: std::error::Error + Send + Sync + 'static> {
AuthRequired(AuthRequiredError),
#[error("Insufficient scope")]
InsufficientScope(InsufficientScopeError),
#[error("Header name '{0}' is reserved and conflicts with default headers")]
ReservedHeaderConflict(String),
}

#[derive(Debug, Clone, Error)]
Expand DownExpand Up@@ -173,6 +176,7 @@ pub trait StreamableHttpClient: Clone + Send + 'static {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_header: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> impl Future<Output = Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>>>
+ Send
+ '_;
Expand DownExpand Up@@ -324,6 +328,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialize_request,
None,
self.config.auth_header,
self.config.custom_headers,
)
.await
{
Expand DownExpand Up@@ -372,6 +377,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialized_notification.message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await
.map_err(WorkerQuitReason::fatal_context(
Expand DownExpand Up@@ -477,6 +483,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await;
let send_result = match response {
Expand DownExpand Up@@ -609,8 +616,10 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// #[derive(Clone)]
Expand All@@ -634,6 +643,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -690,8 +700,10 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// // Define your custom client
Expand All@@ -716,6 +728,7 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -759,6 +772,8 @@ pub struct StreamableHttpClientTransportConfig {
pub allow_stateless: bool,
/// The value to send in the authorization header
pub auth_header: Option<String>,
/// Custom HTTP headers to include with every request
pub custom_headers: HashMap<HeaderName, HeaderValue>,
}

impl StreamableHttpClientTransportConfig {
Expand All@@ -779,6 +794,33 @@ impl StreamableHttpClientTransportConfig {
self.auth_header = Some(value.into());
self
}

/// Set custom HTTP headers to include with every request
///
/// # Arguments
///
/// * `custom_headers` - A HashMap of header names to header values
///
/// # Example
///
/// ```rust,no_run
/// use std::collections::HashMap;
/// use http::{HeaderName, HeaderValue};
/// use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig;
///
/// let mut headers = HashMap::new();
/// headers.insert(
/// HeaderName::from_static("x-custom-header"),
/// HeaderValue::from_static("custom-value")
/// );
///
/// let config = StreamableHttpClientTransportConfig::with_uri("http://localhost:8000")
/// .custom_headers(headers);
/// ```
pub fn custom_headers(mut self, custom_headers: HashMap<HeaderName, HeaderValue>) -> Self {
self.custom_headers = custom_headers;
self
}
}

impl Default for StreamableHttpClientTransportConfig {
Expand All@@ -789,6 +831,7 @@ impl Default for StreamableHttpClientTransportConfig {
channel_buffer_capacity: 16,
allow_stateless: true,
auth_header: None,
custom_headers: HashMap::new(),
}
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions crates/rmcp/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -230,3 +230,13 @@ path = "tests/test_sampling.rs"
name = "test_close_connection"
required-features = ["server", "client"]
path = "tests/test_close_connection.rs"

[[test]]
name = "test_custom_headers"
required-features = [
"client",
"server",
"transport-streamable-http-client-reqwest",
"transport-streamable-http-server",
]
path = "tests/test_custom_headers.rs"
8 changes: 5 additions & 3 deletions crates/rmcp/src/transport/auth.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,8 @@ use thiserror::Error;
use tokio::sync::{Mutex, RwLock};
use tracing::{debug, error, warn};

use crate::transport::common::http_header::HEADER_MCP_PROTOCOL_VERSION;

const DEFAULT_EXCHANGE_URL: &str = "http://localhost";

/// Stored credentials for OAuth2 authorization
Expand DownExpand Up@@ -1051,7 +1053,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(discovery_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1171,7 +1173,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1224,7 +1226,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(resource_metadata_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
use std::collections::HashMap;

use http::{HeaderName, HeaderValue};

use crate::transport::{
auth::AuthClient,
streamable_http_client::{StreamableHttpClient, StreamableHttpError},
Expand DownExpand Up@@ -47,6 +51,7 @@ where
message: crate::model::ClientJsonRpcMessage,
session_id: Option<std::sync::Arc<str>>,
mut auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<
crate::transport::streamable_http_client::StreamableHttpPostResponse,
StreamableHttpError<Self::Error>,
Expand All@@ -55,7 +60,7 @@ where
auth_token = Some(self.get_access_token().await?);
}
self.http_client
.post_message(uri, message, session_id, auth_token)
.post_message(uri, message, session_id, auth_token, custom_headers)
.await
}
}
1 change: 1 addition & 0 deletions crates/rmcp/src/transport/common/http_header.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
pub const HEADER_SESSION_ID: &str = "Mcp-Session-Id";
pub const HEADER_LAST_EVENT_ID: &str = "Last-Event-Id";
pub const HEADER_MCP_PROTOCOL_VERSION: &str = "MCP-Protocol-Version";
pub const EVENT_STREAM_MIME_TYPE: &str = "text/event-stream";
pub const JSON_MIME_TYPE: &str = "application/json";
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
use std::{borrow::Cow, sync::Arc};
use std::{borrow::Cow, collections::HashMap, sync::Arc};

use futures::{StreamExt, stream::BoxStream};
use http::header::WWW_AUTHENTICATE;
use http::{HeaderName, HeaderValue, header::WWW_AUTHENTICATE};
use reqwest::header::ACCEPT;
use sse_stream::{Sse, SseStream};

use crate::{
model::{ClientJsonRpcMessage, ServerJsonRpcMessage},
transport::{
common::http_header::{
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_SESSION_ID, JSON_MIME_TYPE,
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_MCP_PROTOCOL_VERSION,
HEADER_SESSION_ID, JSON_MIME_TYPE,
},
streamable_http_client::*,
},
Expand DownExpand Up@@ -94,13 +95,34 @@ impl StreamableHttpClient for reqwest::Client {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>> {
let mut request = self
.post(uri.as_ref())
.header(ACCEPT, [EVENT_STREAM_MIME_TYPE, JSON_MIME_TYPE].join(", "));
if let Some(auth_header) = auth_token {
request = request.bearer_auth(auth_header);
}

// Apply custom headers
let reserved_headers = [
ACCEPT.as_str(),
HEADER_SESSION_ID,
HEADER_MCP_PROTOCOL_VERSION,
HEADER_LAST_EVENT_ID,
];
for (name, value) in custom_headers {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps disallow any of the headers that are controlled by the default client logic?

ACCEPTHEADER_SESSION_ID etc

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would check https://modelcontextprotocol.io/specification/2025-11-25/basic/transports#streamable-http for a full list

MCP-Protocol-Version is another one that comes to mind

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. I've updated the PR to add the check.

if reserved_headers
.iter()
.any(|&r| name.as_str().eq_ignore_ascii_case(r))
{
return Err(StreamableHttpError::ReservedHeaderConflict(
name.to_string(),
));
}

request = request.header(name, value);
}
if let Some(session_id) = session_id {
request = request.header(HEADER_SESSION_ID, session_id.as_ref());
}
Expand Down
45 changes: 44 additions & 1 deletion crates/rmcp/src/transport/streamable_http_client.rs
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
use std::{borrow::Cow, sync::Arc, time::Duration};
use std::{borrow::Cow, collections::HashMap, sync::Arc, time::Duration};

use futures::{Stream, StreamExt, future::BoxFuture, stream::BoxStream};
use http::{HeaderName, HeaderValue};
pub use sse_stream::Error as SseError;
use sse_stream::Sse;
use thiserror::Error;
Expand DownExpand Up@@ -76,6 +77,8 @@ pub enum StreamableHttpError<E: std::error::Error + Send + Sync + 'static> {
AuthRequired(AuthRequiredError),
#[error("Insufficient scope")]
InsufficientScope(InsufficientScopeError),
#[error("Header name '{0}' is reserved and conflicts with default headers")]
ReservedHeaderConflict(String),
}

#[derive(Debug, Clone, Error)]
Expand DownExpand Up@@ -173,6 +176,7 @@ pub trait StreamableHttpClient: Clone + Send + 'static {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_header: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> impl Future<Output = Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>>>
+ Send
+ '_;
Expand DownExpand Up@@ -324,6 +328,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialize_request,
None,
self.config.auth_header,
self.config.custom_headers,
)
.await
{
Expand DownExpand Up@@ -372,6 +377,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialized_notification.message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await
.map_err(WorkerQuitReason::fatal_context(
Expand DownExpand Up@@ -477,6 +483,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await;
let send_result = match response {
Expand DownExpand Up@@ -609,8 +616,10 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// #[derive(Clone)]
Expand All@@ -634,6 +643,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -690,8 +700,10 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// // Define your custom client
Expand All@@ -716,6 +728,7 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -759,6 +772,8 @@ pub struct StreamableHttpClientTransportConfig {
pub allow_stateless: bool,
/// The value to send in the authorization header
pub auth_header: Option<String>,
/// Custom HTTP headers to include with every request
pub custom_headers: HashMap<HeaderName, HeaderValue>,
}

impl StreamableHttpClientTransportConfig {
Expand All@@ -779,6 +794,33 @@ impl StreamableHttpClientTransportConfig {
self.auth_header = Some(value.into());
self
}

/// Set custom HTTP headers to include with every request
///
/// # Arguments
///
/// * `custom_headers` - A HashMap of header names to header values
///
/// # Example
///
/// ```rust,no_run
/// use std::collections::HashMap;
/// use http::{HeaderName, HeaderValue};
/// use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig;
///
/// let mut headers = HashMap::new();
/// headers.insert(
/// HeaderName::from_static("x-custom-header"),
/// HeaderValue::from_static("custom-value")
/// );
///
/// let config = StreamableHttpClientTransportConfig::with_uri("http://localhost:8000")
/// .custom_headers(headers);
/// ```
pub fn custom_headers(mut self, custom_headers: HashMap<HeaderName, HeaderValue>) -> Self {
self.custom_headers = custom_headers;
self
}
}

impl Default for StreamableHttpClientTransportConfig {
Expand All@@ -789,6 +831,7 @@ impl Default for StreamableHttpClientTransportConfig {
channel_buffer_capacity: 16,
allow_stateless: true,
auth_header: None,
custom_headers: HashMap::new(),
}
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions crates/rmcp/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -230,3 +230,13 @@ path = "tests/test_sampling.rs"
name = "test_close_connection"
required-features = ["server", "client"]
path = "tests/test_close_connection.rs"

[[test]]
name = "test_custom_headers"
required-features = [
"client",
"server",
"transport-streamable-http-client-reqwest",
"transport-streamable-http-server",
]
path = "tests/test_custom_headers.rs"
8 changes: 5 additions & 3 deletions crates/rmcp/src/transport/auth.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,8 @@ use thiserror::Error;
use tokio::sync::{Mutex, RwLock};
use tracing::{debug, error, warn};

use crate::transport::common::http_header::HEADER_MCP_PROTOCOL_VERSION;

const DEFAULT_EXCHANGE_URL: &str = "http://localhost";

/// Stored credentials for OAuth2 authorization
Expand DownExpand Up@@ -1051,7 +1053,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(discovery_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1171,7 +1173,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1224,7 +1226,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(resource_metadata_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
use std::collections::HashMap;

use http::{HeaderName, HeaderValue};

use crate::transport::{
auth::AuthClient,
streamable_http_client::{StreamableHttpClient, StreamableHttpError},
Expand DownExpand Up@@ -47,6 +51,7 @@ where
message: crate::model::ClientJsonRpcMessage,
session_id: Option<std::sync::Arc<str>>,
mut auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<
crate::transport::streamable_http_client::StreamableHttpPostResponse,
StreamableHttpError<Self::Error>,
Expand All@@ -55,7 +60,7 @@ where
auth_token = Some(self.get_access_token().await?);
}
self.http_client
.post_message(uri, message, session_id, auth_token)
.post_message(uri, message, session_id, auth_token, custom_headers)
.await
}
}
1 change: 1 addition & 0 deletions crates/rmcp/src/transport/common/http_header.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
pub const HEADER_SESSION_ID: &str = "Mcp-Session-Id";
pub const HEADER_LAST_EVENT_ID: &str = "Last-Event-Id";
pub const HEADER_MCP_PROTOCOL_VERSION: &str = "MCP-Protocol-Version";
pub const EVENT_STREAM_MIME_TYPE: &str = "text/event-stream";
pub const JSON_MIME_TYPE: &str = "application/json";
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
use std::{borrow::Cow, sync::Arc};
use std::{borrow::Cow, collections::HashMap, sync::Arc};

use futures::{StreamExt, stream::BoxStream};
use http::header::WWW_AUTHENTICATE;
use http::{HeaderName, HeaderValue, header::WWW_AUTHENTICATE};
use reqwest::header::ACCEPT;
use sse_stream::{Sse, SseStream};

use crate::{
model::{ClientJsonRpcMessage, ServerJsonRpcMessage},
transport::{
common::http_header::{
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_SESSION_ID, JSON_MIME_TYPE,
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_MCP_PROTOCOL_VERSION,
HEADER_SESSION_ID, JSON_MIME_TYPE,
},
streamable_http_client::*,
},
Expand DownExpand Up@@ -94,13 +95,34 @@ impl StreamableHttpClient for reqwest::Client {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>> {
let mut request = self
.post(uri.as_ref())
.header(ACCEPT, [EVENT_STREAM_MIME_TYPE, JSON_MIME_TYPE].join(", "));
if let Some(auth_header) = auth_token {
request = request.bearer_auth(auth_header);
}

// Apply custom headers
let reserved_headers = [
ACCEPT.as_str(),
HEADER_SESSION_ID,
HEADER_MCP_PROTOCOL_VERSION,
HEADER_LAST_EVENT_ID,
];
for (name, value) in custom_headers {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps disallow any of the headers that are controlled by the default client logic?

ACCEPTHEADER_SESSION_ID etc

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would check https://modelcontextprotocol.io/specification/2025-11-25/basic/transports#streamable-http for a full list

MCP-Protocol-Version is another one that comes to mind

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. I've updated the PR to add the check.

if reserved_headers
.iter()
.any(|&r| name.as_str().eq_ignore_ascii_case(r))
{
return Err(StreamableHttpError::ReservedHeaderConflict(
name.to_string(),
));
}

request = request.header(name, value);
}
if let Some(session_id) = session_id {
request = request.header(HEADER_SESSION_ID, session_id.as_ref());
}
Expand Down
45 changes: 44 additions & 1 deletion crates/rmcp/src/transport/streamable_http_client.rs
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
use std::{borrow::Cow, sync::Arc, time::Duration};
use std::{borrow::Cow, collections::HashMap, sync::Arc, time::Duration};

use futures::{Stream, StreamExt, future::BoxFuture, stream::BoxStream};
use http::{HeaderName, HeaderValue};
pub use sse_stream::Error as SseError;
use sse_stream::Sse;
use thiserror::Error;
Expand DownExpand Up@@ -76,6 +77,8 @@ pub enum StreamableHttpError<E: std::error::Error + Send + Sync + 'static> {
AuthRequired(AuthRequiredError),
#[error("Insufficient scope")]
InsufficientScope(InsufficientScopeError),
#[error("Header name '{0}' is reserved and conflicts with default headers")]
ReservedHeaderConflict(String),
}

#[derive(Debug, Clone, Error)]
Expand DownExpand Up@@ -173,6 +176,7 @@ pub trait StreamableHttpClient: Clone + Send + 'static {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_header: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> impl Future<Output = Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>>>
+ Send
+ '_;
Expand DownExpand Up@@ -324,6 +328,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialize_request,
None,
self.config.auth_header,
self.config.custom_headers,
)
.await
{
Expand DownExpand Up@@ -372,6 +377,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialized_notification.message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await
.map_err(WorkerQuitReason::fatal_context(
Expand DownExpand Up@@ -477,6 +483,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await;
let send_result = match response {
Expand DownExpand Up@@ -609,8 +616,10 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// #[derive(Clone)]
Expand All@@ -634,6 +643,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -690,8 +700,10 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// // Define your custom client
Expand All@@ -716,6 +728,7 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -759,6 +772,8 @@ pub struct StreamableHttpClientTransportConfig {
pub allow_stateless: bool,
/// The value to send in the authorization header
pub auth_header: Option<String>,
/// Custom HTTP headers to include with every request
pub custom_headers: HashMap<HeaderName, HeaderValue>,
}

impl StreamableHttpClientTransportConfig {
Expand All@@ -779,6 +794,33 @@ impl StreamableHttpClientTransportConfig {
self.auth_header = Some(value.into());
self
}

/// Set custom HTTP headers to include with every request
///
/// # Arguments
///
/// * `custom_headers` - A HashMap of header names to header values
///
/// # Example
///
/// ```rust,no_run
/// use std::collections::HashMap;
/// use http::{HeaderName, HeaderValue};
/// use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig;
///
/// let mut headers = HashMap::new();
/// headers.insert(
/// HeaderName::from_static("x-custom-header"),
/// HeaderValue::from_static("custom-value")
/// );
///
/// let config = StreamableHttpClientTransportConfig::with_uri("http://localhost:8000")
/// .custom_headers(headers);
/// ```
pub fn custom_headers(mut self, custom_headers: HashMap<HeaderName, HeaderValue>) -> Self {
self.custom_headers = custom_headers;
self
}
}

impl Default for StreamableHttpClientTransportConfig {
Expand All@@ -789,6 +831,7 @@ impl Default for StreamableHttpClientTransportConfig {
channel_buffer_capacity: 16,
allow_stateless: true,
auth_header: None,
custom_headers: HashMap::new(),
}
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions crates/rmcp/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -230,3 +230,13 @@ path = "tests/test_sampling.rs"
name = "test_close_connection"
required-features = ["server", "client"]
path = "tests/test_close_connection.rs"

[[test]]
name = "test_custom_headers"
required-features = [
"client",
"server",
"transport-streamable-http-client-reqwest",
"transport-streamable-http-server",
]
path = "tests/test_custom_headers.rs"
8 changes: 5 additions & 3 deletions crates/rmcp/src/transport/auth.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,8 @@ use thiserror::Error;
use tokio::sync::{Mutex, RwLock};
use tracing::{debug, error, warn};

use crate::transport::common::http_header::HEADER_MCP_PROTOCOL_VERSION;

const DEFAULT_EXCHANGE_URL: &str = "http://localhost";

/// Stored credentials for OAuth2 authorization
Expand DownExpand Up@@ -1051,7 +1053,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(discovery_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1171,7 +1173,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1224,7 +1226,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(resource_metadata_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
use std::collections::HashMap;

use http::{HeaderName, HeaderValue};

use crate::transport::{
auth::AuthClient,
streamable_http_client::{StreamableHttpClient, StreamableHttpError},
Expand DownExpand Up@@ -47,6 +51,7 @@ where
message: crate::model::ClientJsonRpcMessage,
session_id: Option<std::sync::Arc<str>>,
mut auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<
crate::transport::streamable_http_client::StreamableHttpPostResponse,
StreamableHttpError<Self::Error>,
Expand All@@ -55,7 +60,7 @@ where
auth_token = Some(self.get_access_token().await?);
}
self.http_client
.post_message(uri, message, session_id, auth_token)
.post_message(uri, message, session_id, auth_token, custom_headers)
.await
}
}
1 change: 1 addition & 0 deletions crates/rmcp/src/transport/common/http_header.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
pub const HEADER_SESSION_ID: &str = "Mcp-Session-Id";
pub const HEADER_LAST_EVENT_ID: &str = "Last-Event-Id";
pub const HEADER_MCP_PROTOCOL_VERSION: &str = "MCP-Protocol-Version";
pub const EVENT_STREAM_MIME_TYPE: &str = "text/event-stream";
pub const JSON_MIME_TYPE: &str = "application/json";
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
use std::{borrow::Cow, sync::Arc};
use std::{borrow::Cow, collections::HashMap, sync::Arc};

use futures::{StreamExt, stream::BoxStream};
use http::header::WWW_AUTHENTICATE;
use http::{HeaderName, HeaderValue, header::WWW_AUTHENTICATE};
use reqwest::header::ACCEPT;
use sse_stream::{Sse, SseStream};

use crate::{
model::{ClientJsonRpcMessage, ServerJsonRpcMessage},
transport::{
common::http_header::{
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_SESSION_ID, JSON_MIME_TYPE,
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_MCP_PROTOCOL_VERSION,
HEADER_SESSION_ID, JSON_MIME_TYPE,
},
streamable_http_client::*,
},
Expand DownExpand Up@@ -94,13 +95,34 @@ impl StreamableHttpClient for reqwest::Client {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>> {
let mut request = self
.post(uri.as_ref())
.header(ACCEPT, [EVENT_STREAM_MIME_TYPE, JSON_MIME_TYPE].join(", "));
if let Some(auth_header) = auth_token {
request = request.bearer_auth(auth_header);
}

// Apply custom headers
let reserved_headers = [
ACCEPT.as_str(),
HEADER_SESSION_ID,
HEADER_MCP_PROTOCOL_VERSION,
HEADER_LAST_EVENT_ID,
];
for (name, value) in custom_headers {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps disallow any of the headers that are controlled by the default client logic?

ACCEPTHEADER_SESSION_ID etc

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would check https://modelcontextprotocol.io/specification/2025-11-25/basic/transports#streamable-http for a full list

MCP-Protocol-Version is another one that comes to mind

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. I've updated the PR to add the check.

if reserved_headers
.iter()
.any(|&r| name.as_str().eq_ignore_ascii_case(r))
{
return Err(StreamableHttpError::ReservedHeaderConflict(
name.to_string(),
));
}

request = request.header(name, value);
}
if let Some(session_id) = session_id {
request = request.header(HEADER_SESSION_ID, session_id.as_ref());
}
Expand Down
45 changes: 44 additions & 1 deletion crates/rmcp/src/transport/streamable_http_client.rs
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
use std::{borrow::Cow, sync::Arc, time::Duration};
use std::{borrow::Cow, collections::HashMap, sync::Arc, time::Duration};

use futures::{Stream, StreamExt, future::BoxFuture, stream::BoxStream};
use http::{HeaderName, HeaderValue};
pub use sse_stream::Error as SseError;
use sse_stream::Sse;
use thiserror::Error;
Expand DownExpand Up@@ -76,6 +77,8 @@ pub enum StreamableHttpError<E: std::error::Error + Send + Sync + 'static> {
AuthRequired(AuthRequiredError),
#[error("Insufficient scope")]
InsufficientScope(InsufficientScopeError),
#[error("Header name '{0}' is reserved and conflicts with default headers")]
ReservedHeaderConflict(String),
}

#[derive(Debug, Clone, Error)]
Expand DownExpand Up@@ -173,6 +176,7 @@ pub trait StreamableHttpClient: Clone + Send + 'static {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_header: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> impl Future<Output = Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>>>
+ Send
+ '_;
Expand DownExpand Up@@ -324,6 +328,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialize_request,
None,
self.config.auth_header,
self.config.custom_headers,
)
.await
{
Expand DownExpand Up@@ -372,6 +377,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialized_notification.message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await
.map_err(WorkerQuitReason::fatal_context(
Expand DownExpand Up@@ -477,6 +483,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await;
let send_result = match response {
Expand DownExpand Up@@ -609,8 +616,10 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// #[derive(Clone)]
Expand All@@ -634,6 +643,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -690,8 +700,10 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// // Define your custom client
Expand All@@ -716,6 +728,7 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -759,6 +772,8 @@ pub struct StreamableHttpClientTransportConfig {
pub allow_stateless: bool,
/// The value to send in the authorization header
pub auth_header: Option<String>,
/// Custom HTTP headers to include with every request
pub custom_headers: HashMap<HeaderName, HeaderValue>,
}

impl StreamableHttpClientTransportConfig {
Expand All@@ -779,6 +794,33 @@ impl StreamableHttpClientTransportConfig {
self.auth_header = Some(value.into());
self
}

/// Set custom HTTP headers to include with every request
///
/// # Arguments
///
/// * `custom_headers` - A HashMap of header names to header values
///
/// # Example
///
/// ```rust,no_run
/// use std::collections::HashMap;
/// use http::{HeaderName, HeaderValue};
/// use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig;
///
/// let mut headers = HashMap::new();
/// headers.insert(
/// HeaderName::from_static("x-custom-header"),
/// HeaderValue::from_static("custom-value")
/// );
///
/// let config = StreamableHttpClientTransportConfig::with_uri("http://localhost:8000")
/// .custom_headers(headers);
/// ```
pub fn custom_headers(mut self, custom_headers: HashMap<HeaderName, HeaderValue>) -> Self {
self.custom_headers = custom_headers;
self
}
}

impl Default for StreamableHttpClientTransportConfig {
Expand All@@ -789,6 +831,7 @@ impl Default for StreamableHttpClientTransportConfig {
channel_buffer_capacity: 16,
allow_stateless: true,
auth_header: None,
custom_headers: HashMap::new(),
}
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions crates/rmcp/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -230,3 +230,13 @@ path = "tests/test_sampling.rs"
name = "test_close_connection"
required-features = ["server", "client"]
path = "tests/test_close_connection.rs"

[[test]]
name = "test_custom_headers"
required-features = [
"client",
"server",
"transport-streamable-http-client-reqwest",
"transport-streamable-http-server",
]
path = "tests/test_custom_headers.rs"
8 changes: 5 additions & 3 deletions crates/rmcp/src/transport/auth.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,8 @@ use thiserror::Error;
use tokio::sync::{Mutex, RwLock};
use tracing::{debug, error, warn};

use crate::transport::common::http_header::HEADER_MCP_PROTOCOL_VERSION;

const DEFAULT_EXCHANGE_URL: &str = "http://localhost";

/// Stored credentials for OAuth2 authorization
Expand DownExpand Up@@ -1051,7 +1053,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(discovery_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1171,7 +1173,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1224,7 +1226,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(resource_metadata_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
use std::collections::HashMap;

use http::{HeaderName, HeaderValue};

use crate::transport::{
auth::AuthClient,
streamable_http_client::{StreamableHttpClient, StreamableHttpError},
Expand DownExpand Up@@ -47,6 +51,7 @@ where
message: crate::model::ClientJsonRpcMessage,
session_id: Option<std::sync::Arc<str>>,
mut auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<
crate::transport::streamable_http_client::StreamableHttpPostResponse,
StreamableHttpError<Self::Error>,
Expand All@@ -55,7 +60,7 @@ where
auth_token = Some(self.get_access_token().await?);
}
self.http_client
.post_message(uri, message, session_id, auth_token)
.post_message(uri, message, session_id, auth_token, custom_headers)
.await
}
}
1 change: 1 addition & 0 deletions crates/rmcp/src/transport/common/http_header.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
pub const HEADER_SESSION_ID: &str = "Mcp-Session-Id";
pub const HEADER_LAST_EVENT_ID: &str = "Last-Event-Id";
pub const HEADER_MCP_PROTOCOL_VERSION: &str = "MCP-Protocol-Version";
pub const EVENT_STREAM_MIME_TYPE: &str = "text/event-stream";
pub const JSON_MIME_TYPE: &str = "application/json";
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
use std::{borrow::Cow, sync::Arc};
use std::{borrow::Cow, collections::HashMap, sync::Arc};

use futures::{StreamExt, stream::BoxStream};
use http::header::WWW_AUTHENTICATE;
use http::{HeaderName, HeaderValue, header::WWW_AUTHENTICATE};
use reqwest::header::ACCEPT;
use sse_stream::{Sse, SseStream};

use crate::{
model::{ClientJsonRpcMessage, ServerJsonRpcMessage},
transport::{
common::http_header::{
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_SESSION_ID, JSON_MIME_TYPE,
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_MCP_PROTOCOL_VERSION,
HEADER_SESSION_ID, JSON_MIME_TYPE,
},
streamable_http_client::*,
},
Expand DownExpand Up@@ -94,13 +95,34 @@ impl StreamableHttpClient for reqwest::Client {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>> {
let mut request = self
.post(uri.as_ref())
.header(ACCEPT, [EVENT_STREAM_MIME_TYPE, JSON_MIME_TYPE].join(", "));
if let Some(auth_header) = auth_token {
request = request.bearer_auth(auth_header);
}

// Apply custom headers
let reserved_headers = [
ACCEPT.as_str(),
HEADER_SESSION_ID,
HEADER_MCP_PROTOCOL_VERSION,
HEADER_LAST_EVENT_ID,
];
for (name, value) in custom_headers {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps disallow any of the headers that are controlled by the default client logic?

ACCEPTHEADER_SESSION_ID etc

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would check https://modelcontextprotocol.io/specification/2025-11-25/basic/transports#streamable-http for a full list

MCP-Protocol-Version is another one that comes to mind

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. I've updated the PR to add the check.

if reserved_headers
.iter()
.any(|&r| name.as_str().eq_ignore_ascii_case(r))
{
return Err(StreamableHttpError::ReservedHeaderConflict(
name.to_string(),
));
}

request = request.header(name, value);
}
if let Some(session_id) = session_id {
request = request.header(HEADER_SESSION_ID, session_id.as_ref());
}
Expand Down
45 changes: 44 additions & 1 deletion crates/rmcp/src/transport/streamable_http_client.rs
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
use std::{borrow::Cow, sync::Arc, time::Duration};
use std::{borrow::Cow, collections::HashMap, sync::Arc, time::Duration};

use futures::{Stream, StreamExt, future::BoxFuture, stream::BoxStream};
use http::{HeaderName, HeaderValue};
pub use sse_stream::Error as SseError;
use sse_stream::Sse;
use thiserror::Error;
Expand DownExpand Up@@ -76,6 +77,8 @@ pub enum StreamableHttpError<E: std::error::Error + Send + Sync + 'static> {
AuthRequired(AuthRequiredError),
#[error("Insufficient scope")]
InsufficientScope(InsufficientScopeError),
#[error("Header name '{0}' is reserved and conflicts with default headers")]
ReservedHeaderConflict(String),
}

#[derive(Debug, Clone, Error)]
Expand DownExpand Up@@ -173,6 +176,7 @@ pub trait StreamableHttpClient: Clone + Send + 'static {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_header: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> impl Future<Output = Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>>>
+ Send
+ '_;
Expand DownExpand Up@@ -324,6 +328,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialize_request,
None,
self.config.auth_header,
self.config.custom_headers,
)
.await
{
Expand DownExpand Up@@ -372,6 +377,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialized_notification.message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await
.map_err(WorkerQuitReason::fatal_context(
Expand DownExpand Up@@ -477,6 +483,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await;
let send_result = match response {
Expand DownExpand Up@@ -609,8 +616,10 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// #[derive(Clone)]
Expand All@@ -634,6 +643,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -690,8 +700,10 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// // Define your custom client
Expand All@@ -716,6 +728,7 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -759,6 +772,8 @@ pub struct StreamableHttpClientTransportConfig {
pub allow_stateless: bool,
/// The value to send in the authorization header
pub auth_header: Option<String>,
/// Custom HTTP headers to include with every request
pub custom_headers: HashMap<HeaderName, HeaderValue>,
}

impl StreamableHttpClientTransportConfig {
Expand All@@ -779,6 +794,33 @@ impl StreamableHttpClientTransportConfig {
self.auth_header = Some(value.into());
self
}

/// Set custom HTTP headers to include with every request
///
/// # Arguments
///
/// * `custom_headers` - A HashMap of header names to header values
///
/// # Example
///
/// ```rust,no_run
/// use std::collections::HashMap;
/// use http::{HeaderName, HeaderValue};
/// use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig;
///
/// let mut headers = HashMap::new();
/// headers.insert(
/// HeaderName::from_static("x-custom-header"),
/// HeaderValue::from_static("custom-value")
/// );
///
/// let config = StreamableHttpClientTransportConfig::with_uri("http://localhost:8000")
/// .custom_headers(headers);
/// ```
pub fn custom_headers(mut self, custom_headers: HashMap<HeaderName, HeaderValue>) -> Self {
self.custom_headers = custom_headers;
self
}
}

impl Default for StreamableHttpClientTransportConfig {
Expand All@@ -789,6 +831,7 @@ impl Default for StreamableHttpClientTransportConfig {
channel_buffer_capacity: 16,
allow_stateless: true,
auth_header: None,
custom_headers: HashMap::new(),
}
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions crates/rmcp/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -230,3 +230,13 @@ path = "tests/test_sampling.rs"
name = "test_close_connection"
required-features = ["server", "client"]
path = "tests/test_close_connection.rs"

[[test]]
name = "test_custom_headers"
required-features = [
"client",
"server",
"transport-streamable-http-client-reqwest",
"transport-streamable-http-server",
]
path = "tests/test_custom_headers.rs"
8 changes: 5 additions & 3 deletions crates/rmcp/src/transport/auth.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,8 @@ use thiserror::Error;
use tokio::sync::{Mutex, RwLock};
use tracing::{debug, error, warn};

use crate::transport::common::http_header::HEADER_MCP_PROTOCOL_VERSION;

const DEFAULT_EXCHANGE_URL: &str = "http://localhost";

/// Stored credentials for OAuth2 authorization
Expand DownExpand Up@@ -1051,7 +1053,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(discovery_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1171,7 +1173,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1224,7 +1226,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(resource_metadata_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
use std::collections::HashMap;

use http::{HeaderName, HeaderValue};

use crate::transport::{
auth::AuthClient,
streamable_http_client::{StreamableHttpClient, StreamableHttpError},
Expand DownExpand Up@@ -47,6 +51,7 @@ where
message: crate::model::ClientJsonRpcMessage,
session_id: Option<std::sync::Arc<str>>,
mut auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<
crate::transport::streamable_http_client::StreamableHttpPostResponse,
StreamableHttpError<Self::Error>,
Expand All@@ -55,7 +60,7 @@ where
auth_token = Some(self.get_access_token().await?);
}
self.http_client
.post_message(uri, message, session_id, auth_token)
.post_message(uri, message, session_id, auth_token, custom_headers)
.await
}
}
1 change: 1 addition & 0 deletions crates/rmcp/src/transport/common/http_header.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
pub const HEADER_SESSION_ID: &str = "Mcp-Session-Id";
pub const HEADER_LAST_EVENT_ID: &str = "Last-Event-Id";
pub const HEADER_MCP_PROTOCOL_VERSION: &str = "MCP-Protocol-Version";
pub const EVENT_STREAM_MIME_TYPE: &str = "text/event-stream";
pub const JSON_MIME_TYPE: &str = "application/json";
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
use std::{borrow::Cow, sync::Arc};
use std::{borrow::Cow, collections::HashMap, sync::Arc};

use futures::{StreamExt, stream::BoxStream};
use http::header::WWW_AUTHENTICATE;
use http::{HeaderName, HeaderValue, header::WWW_AUTHENTICATE};
use reqwest::header::ACCEPT;
use sse_stream::{Sse, SseStream};

use crate::{
model::{ClientJsonRpcMessage, ServerJsonRpcMessage},
transport::{
common::http_header::{
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_SESSION_ID, JSON_MIME_TYPE,
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_MCP_PROTOCOL_VERSION,
HEADER_SESSION_ID, JSON_MIME_TYPE,
},
streamable_http_client::*,
},
Expand DownExpand Up@@ -94,13 +95,34 @@ impl StreamableHttpClient for reqwest::Client {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>> {
let mut request = self
.post(uri.as_ref())
.header(ACCEPT, [EVENT_STREAM_MIME_TYPE, JSON_MIME_TYPE].join(", "));
if let Some(auth_header) = auth_token {
request = request.bearer_auth(auth_header);
}

// Apply custom headers
let reserved_headers = [
ACCEPT.as_str(),
HEADER_SESSION_ID,
HEADER_MCP_PROTOCOL_VERSION,
HEADER_LAST_EVENT_ID,
];
for (name, value) in custom_headers {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps disallow any of the headers that are controlled by the default client logic?

ACCEPTHEADER_SESSION_ID etc

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would check https://modelcontextprotocol.io/specification/2025-11-25/basic/transports#streamable-http for a full list

MCP-Protocol-Version is another one that comes to mind

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. I've updated the PR to add the check.

if reserved_headers
.iter()
.any(|&r| name.as_str().eq_ignore_ascii_case(r))
{
return Err(StreamableHttpError::ReservedHeaderConflict(
name.to_string(),
));
}

request = request.header(name, value);
}
if let Some(session_id) = session_id {
request = request.header(HEADER_SESSION_ID, session_id.as_ref());
}
Expand Down
45 changes: 44 additions & 1 deletion crates/rmcp/src/transport/streamable_http_client.rs
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
use std::{borrow::Cow, sync::Arc, time::Duration};
use std::{borrow::Cow, collections::HashMap, sync::Arc, time::Duration};

use futures::{Stream, StreamExt, future::BoxFuture, stream::BoxStream};
use http::{HeaderName, HeaderValue};
pub use sse_stream::Error as SseError;
use sse_stream::Sse;
use thiserror::Error;
Expand DownExpand Up@@ -76,6 +77,8 @@ pub enum StreamableHttpError<E: std::error::Error + Send + Sync + 'static> {
AuthRequired(AuthRequiredError),
#[error("Insufficient scope")]
InsufficientScope(InsufficientScopeError),
#[error("Header name '{0}' is reserved and conflicts with default headers")]
ReservedHeaderConflict(String),
}

#[derive(Debug, Clone, Error)]
Expand DownExpand Up@@ -173,6 +176,7 @@ pub trait StreamableHttpClient: Clone + Send + 'static {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_header: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> impl Future<Output = Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>>>
+ Send
+ '_;
Expand DownExpand Up@@ -324,6 +328,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialize_request,
None,
self.config.auth_header,
self.config.custom_headers,
)
.await
{
Expand DownExpand Up@@ -372,6 +377,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialized_notification.message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await
.map_err(WorkerQuitReason::fatal_context(
Expand DownExpand Up@@ -477,6 +483,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await;
let send_result = match response {
Expand DownExpand Up@@ -609,8 +616,10 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// #[derive(Clone)]
Expand All@@ -634,6 +643,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -690,8 +700,10 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// // Define your custom client
Expand All@@ -716,6 +728,7 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -759,6 +772,8 @@ pub struct StreamableHttpClientTransportConfig {
pub allow_stateless: bool,
/// The value to send in the authorization header
pub auth_header: Option<String>,
/// Custom HTTP headers to include with every request
pub custom_headers: HashMap<HeaderName, HeaderValue>,
}

impl StreamableHttpClientTransportConfig {
Expand All@@ -779,6 +794,33 @@ impl StreamableHttpClientTransportConfig {
self.auth_header = Some(value.into());
self
}

/// Set custom HTTP headers to include with every request
///
/// # Arguments
///
/// * `custom_headers` - A HashMap of header names to header values
///
/// # Example
///
/// ```rust,no_run
/// use std::collections::HashMap;
/// use http::{HeaderName, HeaderValue};
/// use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig;
///
/// let mut headers = HashMap::new();
/// headers.insert(
/// HeaderName::from_static("x-custom-header"),
/// HeaderValue::from_static("custom-value")
/// );
///
/// let config = StreamableHttpClientTransportConfig::with_uri("http://localhost:8000")
/// .custom_headers(headers);
/// ```
pub fn custom_headers(mut self, custom_headers: HashMap<HeaderName, HeaderValue>) -> Self {
self.custom_headers = custom_headers;
self
}
}

impl Default for StreamableHttpClientTransportConfig {
Expand All@@ -789,6 +831,7 @@ impl Default for StreamableHttpClientTransportConfig {
channel_buffer_capacity: 16,
allow_stateless: true,
auth_header: None,
custom_headers: HashMap::new(),
}
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions crates/rmcp/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -230,3 +230,13 @@ path = "tests/test_sampling.rs"
name = "test_close_connection"
required-features = ["server", "client"]
path = "tests/test_close_connection.rs"

[[test]]
name = "test_custom_headers"
required-features = [
"client",
"server",
"transport-streamable-http-client-reqwest",
"transport-streamable-http-server",
]
path = "tests/test_custom_headers.rs"
8 changes: 5 additions & 3 deletions crates/rmcp/src/transport/auth.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,8 @@ use thiserror::Error;
use tokio::sync::{Mutex, RwLock};
use tracing::{debug, error, warn};

use crate::transport::common::http_header::HEADER_MCP_PROTOCOL_VERSION;

const DEFAULT_EXCHANGE_URL: &str = "http://localhost";

/// Stored credentials for OAuth2 authorization
Expand DownExpand Up@@ -1051,7 +1053,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(discovery_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1171,7 +1173,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1224,7 +1226,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(resource_metadata_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
use std::collections::HashMap;

use http::{HeaderName, HeaderValue};

use crate::transport::{
auth::AuthClient,
streamable_http_client::{StreamableHttpClient, StreamableHttpError},
Expand DownExpand Up@@ -47,6 +51,7 @@ where
message: crate::model::ClientJsonRpcMessage,
session_id: Option<std::sync::Arc<str>>,
mut auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<
crate::transport::streamable_http_client::StreamableHttpPostResponse,
StreamableHttpError<Self::Error>,
Expand All@@ -55,7 +60,7 @@ where
auth_token = Some(self.get_access_token().await?);
}
self.http_client
.post_message(uri, message, session_id, auth_token)
.post_message(uri, message, session_id, auth_token, custom_headers)
.await
}
}
1 change: 1 addition & 0 deletions crates/rmcp/src/transport/common/http_header.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
pub const HEADER_SESSION_ID: &str = "Mcp-Session-Id";
pub const HEADER_LAST_EVENT_ID: &str = "Last-Event-Id";
pub const HEADER_MCP_PROTOCOL_VERSION: &str = "MCP-Protocol-Version";
pub const EVENT_STREAM_MIME_TYPE: &str = "text/event-stream";
pub const JSON_MIME_TYPE: &str = "application/json";
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
use std::{borrow::Cow, sync::Arc};
use std::{borrow::Cow, collections::HashMap, sync::Arc};

use futures::{StreamExt, stream::BoxStream};
use http::header::WWW_AUTHENTICATE;
use http::{HeaderName, HeaderValue, header::WWW_AUTHENTICATE};
use reqwest::header::ACCEPT;
use sse_stream::{Sse, SseStream};

use crate::{
model::{ClientJsonRpcMessage, ServerJsonRpcMessage},
transport::{
common::http_header::{
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_SESSION_ID, JSON_MIME_TYPE,
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_MCP_PROTOCOL_VERSION,
HEADER_SESSION_ID, JSON_MIME_TYPE,
},
streamable_http_client::*,
},
Expand DownExpand Up@@ -94,13 +95,34 @@ impl StreamableHttpClient for reqwest::Client {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>> {
let mut request = self
.post(uri.as_ref())
.header(ACCEPT, [EVENT_STREAM_MIME_TYPE, JSON_MIME_TYPE].join(", "));
if let Some(auth_header) = auth_token {
request = request.bearer_auth(auth_header);
}

// Apply custom headers
let reserved_headers = [
ACCEPT.as_str(),
HEADER_SESSION_ID,
HEADER_MCP_PROTOCOL_VERSION,
HEADER_LAST_EVENT_ID,
];
for (name, value) in custom_headers {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps disallow any of the headers that are controlled by the default client logic?

ACCEPTHEADER_SESSION_ID etc

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would check https://modelcontextprotocol.io/specification/2025-11-25/basic/transports#streamable-http for a full list

MCP-Protocol-Version is another one that comes to mind

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. I've updated the PR to add the check.

if reserved_headers
.iter()
.any(|&r| name.as_str().eq_ignore_ascii_case(r))
{
return Err(StreamableHttpError::ReservedHeaderConflict(
name.to_string(),
));
}

request = request.header(name, value);
}
if let Some(session_id) = session_id {
request = request.header(HEADER_SESSION_ID, session_id.as_ref());
}
Expand Down
45 changes: 44 additions & 1 deletion crates/rmcp/src/transport/streamable_http_client.rs
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
use std::{borrow::Cow, sync::Arc, time::Duration};
use std::{borrow::Cow, collections::HashMap, sync::Arc, time::Duration};

use futures::{Stream, StreamExt, future::BoxFuture, stream::BoxStream};
use http::{HeaderName, HeaderValue};
pub use sse_stream::Error as SseError;
use sse_stream::Sse;
use thiserror::Error;
Expand DownExpand Up@@ -76,6 +77,8 @@ pub enum StreamableHttpError<E: std::error::Error + Send + Sync + 'static> {
AuthRequired(AuthRequiredError),
#[error("Insufficient scope")]
InsufficientScope(InsufficientScopeError),
#[error("Header name '{0}' is reserved and conflicts with default headers")]
ReservedHeaderConflict(String),
}

#[derive(Debug, Clone, Error)]
Expand DownExpand Up@@ -173,6 +176,7 @@ pub trait StreamableHttpClient: Clone + Send + 'static {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_header: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> impl Future<Output = Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>>>
+ Send
+ '_;
Expand DownExpand Up@@ -324,6 +328,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialize_request,
None,
self.config.auth_header,
self.config.custom_headers,
)
.await
{
Expand DownExpand Up@@ -372,6 +377,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialized_notification.message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await
.map_err(WorkerQuitReason::fatal_context(
Expand DownExpand Up@@ -477,6 +483,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await;
let send_result = match response {
Expand DownExpand Up@@ -609,8 +616,10 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// #[derive(Clone)]
Expand All@@ -634,6 +643,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -690,8 +700,10 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// // Define your custom client
Expand All@@ -716,6 +728,7 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -759,6 +772,8 @@ pub struct StreamableHttpClientTransportConfig {
pub allow_stateless: bool,
/// The value to send in the authorization header
pub auth_header: Option<String>,
/// Custom HTTP headers to include with every request
pub custom_headers: HashMap<HeaderName, HeaderValue>,
}

impl StreamableHttpClientTransportConfig {
Expand All@@ -779,6 +794,33 @@ impl StreamableHttpClientTransportConfig {
self.auth_header = Some(value.into());
self
}

/// Set custom HTTP headers to include with every request
///
/// # Arguments
///
/// * `custom_headers` - A HashMap of header names to header values
///
/// # Example
///
/// ```rust,no_run
/// use std::collections::HashMap;
/// use http::{HeaderName, HeaderValue};
/// use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig;
///
/// let mut headers = HashMap::new();
/// headers.insert(
/// HeaderName::from_static("x-custom-header"),
/// HeaderValue::from_static("custom-value")
/// );
///
/// let config = StreamableHttpClientTransportConfig::with_uri("http://localhost:8000")
/// .custom_headers(headers);
/// ```
pub fn custom_headers(mut self, custom_headers: HashMap<HeaderName, HeaderValue>) -> Self {
self.custom_headers = custom_headers;
self
}
}

impl Default for StreamableHttpClientTransportConfig {
Expand All@@ -789,6 +831,7 @@ impl Default for StreamableHttpClientTransportConfig {
channel_buffer_capacity: 16,
allow_stateless: true,
auth_header: None,
custom_headers: HashMap::new(),
}
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions crates/rmcp/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -230,3 +230,13 @@ path = "tests/test_sampling.rs"
name = "test_close_connection"
required-features = ["server", "client"]
path = "tests/test_close_connection.rs"

[[test]]
name = "test_custom_headers"
required-features = [
"client",
"server",
"transport-streamable-http-client-reqwest",
"transport-streamable-http-server",
]
path = "tests/test_custom_headers.rs"
8 changes: 5 additions & 3 deletions crates/rmcp/src/transport/auth.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,8 @@ use thiserror::Error;
use tokio::sync::{Mutex, RwLock};
use tracing::{debug, error, warn};

use crate::transport::common::http_header::HEADER_MCP_PROTOCOL_VERSION;

const DEFAULT_EXCHANGE_URL: &str = "http://localhost";

/// Stored credentials for OAuth2 authorization
Expand DownExpand Up@@ -1051,7 +1053,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(discovery_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1171,7 +1173,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand DownExpand Up@@ -1224,7 +1226,7 @@ impl AuthorizationManager {
let response = match self
.http_client
.get(resource_metadata_url.clone())
.header("MCP-Protocol-Version", "2024-11-05")
.header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05")
.send()
.await
{
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
use std::collections::HashMap;

use http::{HeaderName, HeaderValue};

use crate::transport::{
auth::AuthClient,
streamable_http_client::{StreamableHttpClient, StreamableHttpError},
Expand DownExpand Up@@ -47,6 +51,7 @@ where
message: crate::model::ClientJsonRpcMessage,
session_id: Option<std::sync::Arc<str>>,
mut auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<
crate::transport::streamable_http_client::StreamableHttpPostResponse,
StreamableHttpError<Self::Error>,
Expand All@@ -55,7 +60,7 @@ where
auth_token = Some(self.get_access_token().await?);
}
self.http_client
.post_message(uri, message, session_id, auth_token)
.post_message(uri, message, session_id, auth_token, custom_headers)
.await
}
}
1 change: 1 addition & 0 deletions crates/rmcp/src/transport/common/http_header.rs
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
pub const HEADER_SESSION_ID: &str = "Mcp-Session-Id";
pub const HEADER_LAST_EVENT_ID: &str = "Last-Event-Id";
pub const HEADER_MCP_PROTOCOL_VERSION: &str = "MCP-Protocol-Version";
pub const EVENT_STREAM_MIME_TYPE: &str = "text/event-stream";
pub const JSON_MIME_TYPE: &str = "application/json";
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
use std::{borrow::Cow, sync::Arc};
use std::{borrow::Cow, collections::HashMap, sync::Arc};

use futures::{StreamExt, stream::BoxStream};
use http::header::WWW_AUTHENTICATE;
use http::{HeaderName, HeaderValue, header::WWW_AUTHENTICATE};
use reqwest::header::ACCEPT;
use sse_stream::{Sse, SseStream};

use crate::{
model::{ClientJsonRpcMessage, ServerJsonRpcMessage},
transport::{
common::http_header::{
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_SESSION_ID, JSON_MIME_TYPE,
EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_MCP_PROTOCOL_VERSION,
HEADER_SESSION_ID, JSON_MIME_TYPE,
},
streamable_http_client::*,
},
Expand DownExpand Up@@ -94,13 +95,34 @@ impl StreamableHttpClient for reqwest::Client {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_token: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>> {
let mut request = self
.post(uri.as_ref())
.header(ACCEPT, [EVENT_STREAM_MIME_TYPE, JSON_MIME_TYPE].join(", "));
if let Some(auth_header) = auth_token {
request = request.bearer_auth(auth_header);
}

// Apply custom headers
let reserved_headers = [
ACCEPT.as_str(),
HEADER_SESSION_ID,
HEADER_MCP_PROTOCOL_VERSION,
HEADER_LAST_EVENT_ID,
];
for (name, value) in custom_headers {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps disallow any of the headers that are controlled by the default client logic?

ACCEPTHEADER_SESSION_ID etc

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would check https://modelcontextprotocol.io/specification/2025-11-25/basic/transports#streamable-http for a full list

MCP-Protocol-Version is another one that comes to mind

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. I've updated the PR to add the check.

if reserved_headers
.iter()
.any(|&r| name.as_str().eq_ignore_ascii_case(r))
{
return Err(StreamableHttpError::ReservedHeaderConflict(
name.to_string(),
));
}

request = request.header(name, value);
}
if let Some(session_id) = session_id {
request = request.header(HEADER_SESSION_ID, session_id.as_ref());
}
Expand Down
45 changes: 44 additions & 1 deletion crates/rmcp/src/transport/streamable_http_client.rs
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
use std::{borrow::Cow, sync::Arc, time::Duration};
use std::{borrow::Cow, collections::HashMap, sync::Arc, time::Duration};

use futures::{Stream, StreamExt, future::BoxFuture, stream::BoxStream};
use http::{HeaderName, HeaderValue};
pub use sse_stream::Error as SseError;
use sse_stream::Sse;
use thiserror::Error;
Expand DownExpand Up@@ -76,6 +77,8 @@ pub enum StreamableHttpError<E: std::error::Error + Send + Sync + 'static> {
AuthRequired(AuthRequiredError),
#[error("Insufficient scope")]
InsufficientScope(InsufficientScopeError),
#[error("Header name '{0}' is reserved and conflicts with default headers")]
ReservedHeaderConflict(String),
}

#[derive(Debug, Clone, Error)]
Expand DownExpand Up@@ -173,6 +176,7 @@ pub trait StreamableHttpClient: Clone + Send + 'static {
message: ClientJsonRpcMessage,
session_id: Option<Arc<str>>,
auth_header: Option<String>,
custom_headers: HashMap<HeaderName, HeaderValue>,
) -> impl Future<Output = Result<StreamableHttpPostResponse, StreamableHttpError<Self::Error>>>
+ Send
+ '_;
Expand DownExpand Up@@ -324,6 +328,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialize_request,
None,
self.config.auth_header,
self.config.custom_headers,
)
.await
{
Expand DownExpand Up@@ -372,6 +377,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
initialized_notification.message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await
.map_err(WorkerQuitReason::fatal_context(
Expand DownExpand Up@@ -477,6 +483,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
message,
session_id.clone(),
config.auth_header.clone(),
config.custom_headers.clone(),
)
.await;
let send_result = match response {
Expand DownExpand Up@@ -609,8 +616,10 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// #[derive(Clone)]
Expand All@@ -634,6 +643,7 @@ impl<C: StreamableHttpClient> Worker for StreamableHttpClientWorker<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -690,8 +700,10 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// StreamableHttpClientTransportConfig
/// };
/// use std::sync::Arc;
/// use std::collections::HashMap;
/// use futures::stream::BoxStream;
/// use rmcp::model::ClientJsonRpcMessage;
/// use http::{HeaderName, HeaderValue};
/// use sse_stream::{Sse, Error as SseError};
///
/// // Define your custom client
Expand All@@ -716,6 +728,7 @@ impl<C: StreamableHttpClient> StreamableHttpClientTransport<C> {
/// _message: ClientJsonRpcMessage,
/// _session_id: Option<Arc<str>>,
/// _auth_header: Option<String>,
/// _custom_headers: HashMap<HeaderName, HeaderValue>,
/// ) -> Result<rmcp::transport::streamable_http_client::StreamableHttpPostResponse, rmcp::transport::streamable_http_client::StreamableHttpError<Self::Error>> {
/// todo!()
/// }
Expand DownExpand Up@@ -759,6 +772,8 @@ pub struct StreamableHttpClientTransportConfig {
pub allow_stateless: bool,
/// The value to send in the authorization header
pub auth_header: Option<String>,
/// Custom HTTP headers to include with every request
pub custom_headers: HashMap<HeaderName, HeaderValue>,
}

impl StreamableHttpClientTransportConfig {
Expand All@@ -779,6 +794,33 @@ impl StreamableHttpClientTransportConfig {
self.auth_header = Some(value.into());
self
}

/// Set custom HTTP headers to include with every request
///
/// # Arguments
///
/// * `custom_headers` - A HashMap of header names to header values
///
/// # Example
///
/// ```rust,no_run
/// use std::collections::HashMap;
/// use http::{HeaderName, HeaderValue};
/// use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig;
///
/// let mut headers = HashMap::new();
/// headers.insert(
/// HeaderName::from_static("x-custom-header"),
/// HeaderValue::from_static("custom-value")
/// );
///
/// let config = StreamableHttpClientTransportConfig::with_uri("http://localhost:8000")
/// .custom_headers(headers);
/// ```
pub fn custom_headers(mut self, custom_headers: HashMap<HeaderName, HeaderValue>) -> Self {
self.custom_headers = custom_headers;
self
}
}

impl Default for StreamableHttpClientTransportConfig {
Expand All@@ -789,6 +831,7 @@ impl Default for StreamableHttpClientTransportConfig {
channel_buffer_capacity: 16,
allow_stateless: true,
auth_header: None,
custom_headers: HashMap::new(),
}
}
}
Loading