1use std::{
2 future::Future,
3 marker::PhantomData,
4 sync::{Arc, Mutex},
5};
6
7use futures::{SinkExt, StreamExt};
8use rmcp::{
9 service::{RoleServer, RxJsonRpcMessage, ServiceRole, TxJsonRpcMessage},
10 transport::Transport,
11};
12use serde::{Serialize, de::DeserializeOwned};
13use thiserror::Error;
14use tokio::{
15 io::{AsyncRead, AsyncWrite},
16 sync::Mutex as AsyncMutex,
17};
18use tokio_util::{
19 bytes::{Buf, BufMut, BytesMut},
20 codec::{Decoder, Encoder, FramedRead, FramedWrite},
21};
22
23#[derive(Clone, Copy, Debug, Eq, PartialEq)]
24enum WireProtocol {
25 JsonLine,
26 ContentLength,
27}
28
29#[derive(Debug, Clone)]
30struct SharedProtocol(Arc<Mutex<Option<WireProtocol>>>);
31
32impl SharedProtocol {
33 fn new() -> Self {
34 Self(Arc::new(Mutex::new(None)))
35 }
36
37 fn get(&self) -> Option<WireProtocol> {
38 *self
39 .0
40 .lock()
41 .unwrap_or_else(std::sync::PoisonError::into_inner)
42 }
43
44 fn set_if_unset(&self, protocol: WireProtocol) {
45 let mut guard = self
46 .0
47 .lock()
48 .unwrap_or_else(std::sync::PoisonError::into_inner);
49 if guard.is_none() {
50 *guard = Some(protocol);
51 }
52 }
53}
54
55pub type TransportWriter<Role, W> =
56 FramedWrite<W, HybridJsonRpcMessageCodec<TxJsonRpcMessage<Role>>>;
57
58pub struct HybridStdioTransport<Role: ServiceRole, R: AsyncRead, W: AsyncWrite> {
59 read: FramedRead<R, HybridJsonRpcMessageCodec<RxJsonRpcMessage<Role>>>,
60 write: Arc<AsyncMutex<Option<TransportWriter<Role, W>>>>,
61}
62
63impl<Role: ServiceRole, R, W> HybridStdioTransport<Role, R, W>
64where
65 R: Send + AsyncRead + Unpin,
66 W: Send + AsyncWrite + Unpin + 'static,
67{
68 pub fn new(read: R, write: W) -> Self {
69 let protocol = SharedProtocol::new();
70 let read = FramedRead::new(
71 read,
72 HybridJsonRpcMessageCodec::<RxJsonRpcMessage<Role>>::new(protocol.clone()),
73 );
74 let write = Arc::new(AsyncMutex::new(Some(FramedWrite::new(
75 write,
76 HybridJsonRpcMessageCodec::<TxJsonRpcMessage<Role>>::new(protocol),
77 ))));
78 Self { read, write }
79 }
80}
81
82impl<R, W> HybridStdioTransport<RoleServer, R, W>
83where
84 R: Send + AsyncRead + Unpin,
85 W: Send + AsyncWrite + Unpin + 'static,
86{
87 pub fn new_server(read: R, write: W) -> Self {
88 Self::new(read, write)
89 }
90}
91
92impl<Role: ServiceRole, R, W> Transport<Role> for HybridStdioTransport<Role, R, W>
93where
94 R: Send + AsyncRead + Unpin,
95 W: Send + AsyncWrite + Unpin + 'static,
96{
97 type Error = std::io::Error;
98
99 fn send(
100 &mut self,
101 item: TxJsonRpcMessage<Role>,
102 ) -> impl Future<Output = Result<(), Self::Error>> + Send + 'static {
103 let lock = self.write.clone();
104 async move {
105 let mut write = lock.lock().await;
106 if let Some(ref mut write) = *write {
107 write.send(item).await.map_err(Into::into)
108 } else {
109 Err(std::io::Error::new(
110 std::io::ErrorKind::NotConnected,
111 "Transport is closed",
112 ))
113 }
114 }
115 }
116
117 fn receive(&mut self) -> impl Future<Output = Option<RxJsonRpcMessage<Role>>> + Send {
118 let next = self.read.next();
119 async {
120 next.await.and_then(|result| {
121 result
122 .inspect_err(|error| {
123 tracing::error!("Error reading from stream: {}", error);
124 })
125 .ok()
126 })
127 }
128 }
129
130 async fn close(&mut self) -> Result<(), Self::Error> {
131 let mut write = self.write.lock().await;
132 drop(write.take());
133 Ok(())
134 }
135}
136
137#[derive(Debug, Clone)]
138pub struct HybridJsonRpcMessageCodec<T> {
139 _marker: PhantomData<fn() -> T>,
140 next_index: usize,
141 max_length: usize,
142 is_discarding: bool,
143 protocol: SharedProtocol,
144}
145
146impl<T> HybridJsonRpcMessageCodec<T> {
147 fn new(protocol: SharedProtocol) -> Self {
148 Self {
149 _marker: PhantomData,
150 next_index: 0,
151 max_length: 32 * 1024 * 1024, is_discarding: false,
153 protocol,
154 }
155 }
156}
157
158fn without_carriage_return(s: &[u8]) -> &[u8] {
159 if let Some(&b'\r') = s.last() {
160 &s[..s.len() - 1]
161 } else {
162 s
163 }
164}
165
166fn is_standard_method(method: &str) -> bool {
167 matches!(
168 method,
169 "initialize"
170 | "ping"
171 | "prompts/get"
172 | "prompts/list"
173 | "resources/list"
174 | "resources/read"
175 | "resources/subscribe"
176 | "resources/unsubscribe"
177 | "resources/templates/list"
178 | "tools/call"
179 | "tools/list"
180 | "completion/complete"
181 | "logging/setLevel"
182 | "roots/list"
183 | "sampling/createMessage"
184 ) || is_standard_notification(method)
185}
186
187fn is_standard_notification(method: &str) -> bool {
188 matches!(
189 method,
190 "notifications/cancelled"
191 | "notifications/initialized"
192 | "notifications/message"
193 | "notifications/progress"
194 | "notifications/prompts/list_changed"
195 | "notifications/resources/list_changed"
196 | "notifications/resources/updated"
197 | "notifications/roots/list_changed"
198 | "notifications/tools/list_changed"
199 )
200}
201
202fn should_ignore_notification(json_value: &serde_json::Value, method: &str) -> bool {
203 let is_notification = json_value.get("id").is_none();
204 if is_notification && !is_standard_method(method) {
205 tracing::trace!(
206 "Ignoring non-MCP notification '{}' for compatibility",
207 method
208 );
209 return true;
210 }
211
212 matches!(
213 (
214 method.starts_with("notifications/"),
215 is_standard_notification(method)
216 ),
217 (true, false)
218 )
219}
220
221fn try_parse_with_compatibility<T: DeserializeOwned>(
222 payload: &[u8],
223 context: &str,
224) -> Result<Option<T>, HybridCodecError> {
225 if let Ok(line_str) = std::str::from_utf8(payload) {
226 match serde_json::from_slice(payload) {
227 Ok(item) => Ok(Some(item)),
228 Err(error) => {
229 if let Ok(json_value) = serde_json::from_str::<serde_json::Value>(line_str)
230 && let Some(method) =
231 json_value.get("method").and_then(serde_json::Value::as_str)
232 && should_ignore_notification(&json_value, method)
233 {
234 return Ok(None);
235 }
236
237 tracing::debug!(
238 "Failed to parse message {}: {} | Error: {}",
239 context,
240 line_str,
241 error
242 );
243 Err(HybridCodecError::Serde(error))
244 }
245 }
246 } else {
247 serde_json::from_slice(payload)
248 .map(Some)
249 .map_err(HybridCodecError::Serde)
250 }
251}
252
253#[derive(Debug, Error)]
254pub enum HybridCodecError {
255 #[error("max line length exceeded")]
256 MaxLineLengthExceeded,
257 #[error("missing Content-Length header")]
258 MissingContentLength,
259 #[error("invalid Content-Length value: {0}")]
260 InvalidContentLength(String),
261 #[error("invalid header frame: {0}")]
262 InvalidHeaderFrame(String),
263 #[error("serde error {0}")]
264 Serde(#[from] serde_json::Error),
265 #[error("io error {0}")]
266 Io(#[from] std::io::Error),
267}
268
269impl From<HybridCodecError> for std::io::Error {
270 fn from(value: HybridCodecError) -> Self {
271 match value {
272 HybridCodecError::MaxLineLengthExceeded
273 | HybridCodecError::MissingContentLength
274 | HybridCodecError::InvalidContentLength(_)
275 | HybridCodecError::InvalidHeaderFrame(_) => {
276 std::io::Error::new(std::io::ErrorKind::InvalidData, value)
277 }
278 HybridCodecError::Serde(error) => error.into(),
279 HybridCodecError::Io(error) => error,
280 }
281 }
282}
283
284fn looks_like_content_length_frame(buf: &BytesMut) -> bool {
285 let prefix = &buf[..buf.len().min(32)];
286 prefix
287 .windows(b"content-length".len())
288 .next()
289 .is_some_and(|candidate| candidate.eq_ignore_ascii_case(b"content-length"))
290}
291
292fn find_header_terminator(buf: &BytesMut) -> Option<(usize, usize)> {
293 if let Some(index) = buf.windows(4).position(|window| window == b"\r\n\r\n") {
294 return Some((index, 4));
295 }
296 buf.windows(2)
297 .position(|window| window == b"\n\n")
298 .map(|index| (index, 2))
299}
300
301fn parse_content_length(header: &str) -> Result<usize, HybridCodecError> {
302 for raw_line in header.lines() {
303 let line = raw_line.trim_end_matches('\r');
304 let Some((name, value)) = line.split_once(':') else {
305 continue;
306 };
307 if name.trim().eq_ignore_ascii_case("content-length") {
308 return value
309 .trim()
310 .parse::<usize>()
311 .map_err(|_| HybridCodecError::InvalidContentLength(value.trim().to_string()));
312 }
313 }
314
315 Err(HybridCodecError::MissingContentLength)
316}
317
318impl<T: DeserializeOwned> HybridJsonRpcMessageCodec<T> {
319 fn decode_content_length(&mut self, buf: &mut BytesMut) -> Result<Option<T>, HybridCodecError> {
320 let Some((header_end, delimiter_len)) = find_header_terminator(buf) else {
321 return Ok(None);
322 };
323
324 let header = std::str::from_utf8(&buf[..header_end])
325 .map_err(|error| HybridCodecError::InvalidHeaderFrame(error.to_string()))?;
326 let content_length = parse_content_length(header)?;
327 if content_length > self.max_length {
328 return Err(HybridCodecError::MaxLineLengthExceeded);
329 }
330 let body_start = header_end + delimiter_len;
331 let frame_len = body_start
332 .checked_add(content_length)
333 .ok_or(HybridCodecError::MaxLineLengthExceeded)?;
334 if buf.len() < frame_len {
335 return Ok(None);
336 }
337
338 let frame = buf.split_to(frame_len);
339 let payload = &frame[body_start..];
340 self.protocol.set_if_unset(WireProtocol::ContentLength);
341
342 try_parse_with_compatibility(payload, "decode_content_length")
343 }
344
345 fn decode_json_line(&mut self, buf: &mut BytesMut) -> Result<Option<T>, HybridCodecError> {
346 loop {
347 let read_to = std::cmp::min(self.max_length.saturating_add(1), buf.len());
348 let newline_offset = buf[self.next_index..read_to]
349 .iter()
350 .position(|byte| *byte == b'\n');
351
352 match (self.is_discarding, newline_offset) {
353 (true, Some(offset)) => {
354 buf.advance(offset + self.next_index + 1);
355 self.is_discarding = false;
356 self.next_index = 0;
357 }
358 (true, None) => {
359 buf.advance(read_to);
360 self.next_index = 0;
361 if buf.is_empty() {
362 return Ok(None);
363 }
364 }
365 (false, Some(offset)) => {
366 let newline_index = offset + self.next_index;
367 self.next_index = 0;
368 let line = buf.split_to(newline_index + 1);
369 let line = &line[..line.len() - 1];
370 let payload = without_carriage_return(line);
371 self.protocol.set_if_unset(WireProtocol::JsonLine);
372
373 if let Some(item) = try_parse_with_compatibility(payload, "decode_json_line")? {
374 return Ok(Some(item));
375 }
376 }
377 (false, None) if buf.len() > self.max_length => {
378 self.is_discarding = true;
379 return Err(HybridCodecError::MaxLineLengthExceeded);
380 }
381 (false, None) => {
382 self.next_index = read_to;
383 return Ok(None);
384 }
385 }
386 }
387 }
388}
389
390impl<T: DeserializeOwned> Decoder for HybridJsonRpcMessageCodec<T> {
391 type Item = T;
392 type Error = HybridCodecError;
393
394 fn decode(&mut self, buf: &mut BytesMut) -> Result<Option<T>, HybridCodecError> {
395 match self.protocol.get() {
396 Some(WireProtocol::ContentLength) => self.decode_content_length(buf),
397 Some(WireProtocol::JsonLine) => self.decode_json_line(buf),
398 None => {
399 if looks_like_content_length_frame(buf) {
400 self.decode_content_length(buf)
401 } else {
402 self.decode_json_line(buf)
403 }
404 }
405 }
406 }
407
408 fn decode_eof(&mut self, buf: &mut BytesMut) -> Result<Option<T>, HybridCodecError> {
409 match self.protocol.get() {
410 Some(WireProtocol::ContentLength) if !buf.is_empty() => self.decode_content_length(buf),
411 _ => Ok(if let Some(frame) = self.decode(buf)? {
412 Some(frame)
413 } else {
414 self.next_index = 0;
415 if buf.is_empty() || buf == &b"\r"[..] {
416 None
417 } else {
418 let line = buf.split_to(buf.len());
419 let payload = without_carriage_return(&line);
420 try_parse_with_compatibility(payload, "decode_eof")?
421 }
422 }),
423 }
424 }
425}
426
427impl<T: Serialize> Encoder<T> for HybridJsonRpcMessageCodec<T> {
428 type Error = HybridCodecError;
429
430 fn encode(&mut self, item: T, buf: &mut BytesMut) -> Result<(), HybridCodecError> {
431 let payload = serde_json::to_vec(&item)?;
432
433 match self.protocol.get().unwrap_or(WireProtocol::ContentLength) {
434 WireProtocol::ContentLength => {
435 buf.extend_from_slice(
436 format!("Content-Length: {}\r\n\r\n", payload.len()).as_bytes(),
437 );
438 buf.extend_from_slice(&payload);
439 }
440 WireProtocol::JsonLine => {
441 buf.extend_from_slice(&payload);
442 buf.put_u8(b'\n');
443 }
444 }
445
446 Ok(())
447 }
448}
449
450#[cfg(test)]
451mod tests {
452 use super::*;
453
454 use tokio_util::bytes::BytesMut;
455
456 fn sample_message() -> serde_json::Value {
457 serde_json::json!({
458 "jsonrpc": "2.0",
459 "id": 1,
460 "method": "initialize",
461 "params": {
462 "protocolVersion": "2024-11-05",
463 "capabilities": {},
464 "clientInfo": {
465 "name": "probe",
466 "version": "0.0.0"
467 }
468 }
469 })
470 }
471
472 #[test]
473 fn decodes_json_line_and_marks_protocol() {
474 let protocol = SharedProtocol::new();
475 let mut codec = HybridJsonRpcMessageCodec::<serde_json::Value>::new(protocol.clone());
476 let payload = serde_json::to_vec(&sample_message()).unwrap();
477 let mut buf = BytesMut::from(&payload[..]);
478 buf.put_u8(b'\n');
479
480 let item = codec.decode(&mut buf).unwrap();
481 assert!(item.is_some());
482 assert_eq!(protocol.get(), Some(WireProtocol::JsonLine));
483 }
484
485 #[test]
486 fn decodes_content_length_and_marks_protocol() {
487 let protocol = SharedProtocol::new();
488 let mut codec = HybridJsonRpcMessageCodec::<serde_json::Value>::new(protocol.clone());
489 let payload = serde_json::to_vec(&sample_message()).unwrap();
490 let mut frame = BytesMut::new();
491 frame.extend_from_slice(format!("Content-Length: {}\r\n\r\n", payload.len()).as_bytes());
492 frame.extend_from_slice(&payload);
493
494 let item = codec.decode(&mut frame).unwrap();
495 assert!(item.is_some());
496 assert_eq!(protocol.get(), Some(WireProtocol::ContentLength));
497 }
498
499 #[test]
500 fn encodes_using_content_length_when_protocol_is_detected() {
501 let protocol = SharedProtocol::new();
502 protocol.set_if_unset(WireProtocol::ContentLength);
503 let mut codec = HybridJsonRpcMessageCodec::<serde_json::Value>::new(protocol);
504 let mut buf = BytesMut::new();
505 codec
506 .encode(
507 serde_json::json!({"jsonrpc":"2.0","id":1,"result":{"ok":true}}),
508 &mut buf,
509 )
510 .unwrap();
511
512 assert!(
513 std::str::from_utf8(&buf)
514 .unwrap()
515 .starts_with("Content-Length: ")
516 );
517 }
518}