bote 0.92.0

MCP core service — JSON-RPC 2.0 protocol, tool registry, audit integration, and TypeScript bridge
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
//! WebSocket transport — bidirectional JSON-RPC over WebSocket.

use std::collections::HashMap;
use std::future::Future;
use std::net::SocketAddr;
use std::sync::Arc;

use futures_util::{SinkExt, StreamExt};
use tokio::net::TcpListener;
use tokio::sync::mpsc as tokio_mpsc;
use tokio_tungstenite::tungstenite::Message;

use crate::dispatch::{DispatchOutcome, Dispatcher};
use crate::protocol::{JsonRpcRequest, JsonRpcResponse};
use crate::stream::CancellationToken;
use crate::transport::codec;

/// Configuration for the WebSocket transport.
#[non_exhaustive]
pub struct WsConfig {
    pub addr: SocketAddr,
}

impl WsConfig {
    #[must_use]
    pub fn new(addr: SocketAddr) -> Self {
        Self { addr }
    }
}

/// Start a WebSocket server that accepts JSON-RPC messages.
///
/// Spawns a task per connection. Runs until the `shutdown` future resolves,
/// then stops accepting new connections and returns `Ok(())`.
pub async fn serve(
    dispatcher: Arc<Dispatcher>,
    config: WsConfig,
    shutdown: impl Future<Output = ()> + Send + 'static,
) -> crate::Result<()> {
    let listener = TcpListener::bind(config.addr)
        .await
        .map_err(|e| crate::BoteError::BindFailed(e.to_string()))?;

    tracing::info!(addr = %config.addr, "ws transport listening");

    tokio::pin!(shutdown);

    loop {
        tokio::select! {
            result = listener.accept() => {
                let (stream, peer) = result?;
                let dispatcher = Arc::clone(&dispatcher);

                tokio::spawn(async move {
                    if let Err(e) = handle_connection(dispatcher, stream).await {
                        tracing::warn!(peer = %peer, error = %e, "ws connection error");
                    }
                });
            }
            _ = &mut shutdown => break,
        }
    }

    tracing::info!("ws transport shut down");
    Ok(())
}

async fn handle_connection(
    dispatcher: Arc<Dispatcher>,
    stream: tokio::net::TcpStream,
) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let ws_stream = tokio_tungstenite::accept_async(stream).await?;
    let (ws_write, mut ws_read) = ws_stream.split();

    // Outgoing message channel — all tasks send here, writer drains to WS.
    let (out_tx, mut out_rx) = tokio_mpsc::unbounded_channel::<String>();

    // Active streaming requests for cancellation.
    let active: Arc<std::sync::Mutex<HashMap<String, CancellationToken>>> =
        Arc::new(std::sync::Mutex::new(HashMap::new()));

    // Writer task.
    let writer_handle = tokio::spawn(async move {
        let mut ws_write = ws_write;
        while let Some(msg) = out_rx.recv().await {
            if ws_write.send(Message::Text(msg.into())).await.is_err() {
                break;
            }
        }
    });

    // Reader loop.
    while let Some(msg) = ws_read.next().await {
        let msg = msg?;

        let text = match msg {
            Message::Text(t) => t,
            Message::Close(_) => break,
            _ => continue,
        };

        if let Ok(req) = serde_json::from_str::<JsonRpcRequest>(&text) {
            // Check for cancellation request.
            if req.method == "$/cancelRequest" {
                if let Some(target_id) = req.params.get("id").and_then(|v| v.as_str())
                    && let Some(token) = active
                        .lock()
                        .unwrap_or_else(|e| e.into_inner())
                        .get(target_id)
                {
                    token.cancel();
                }
                continue;
            }

            // Check for streaming tool.
            if req.method == "tools/call"
                && let Some(tool_name) = req.params.get("name").and_then(|v| v.as_str())
                && dispatcher.is_streaming_tool(tool_name)
            {
                let d = Arc::clone(&dispatcher);
                let tx = out_tx.clone();
                let active_map = Arc::clone(&active);

                tokio::spawn(async move {
                    handle_streaming_call(d, &req, tx, active_map).await;
                });
                continue;
            }
        }

        // Non-streaming: use process_message.
        let d = Arc::clone(&dispatcher);
        let tx = out_tx.clone();
        let text_owned = text.to_string();
        tokio::task::spawn_blocking(move || {
            if let Some(out) = codec::process_message(&text_owned, &d)
                && tx.send(out).is_err()
            {
                tracing::trace!("outbound channel closed, client disconnected");
            }
        });
    }

    drop(out_tx);
    let _ = writer_handle.await;
    Ok(())
}

async fn handle_streaming_call(
    dispatcher: Arc<Dispatcher>,
    request: &JsonRpcRequest,
    out_tx: tokio_mpsc::UnboundedSender<String>,
    active: Arc<std::sync::Mutex<HashMap<String, CancellationToken>>>,
) {
    let request_id = request.id.clone().unwrap_or(serde_json::Value::Null);
    let id_str = request_id.to_string();
    let tool_name = request
        .params
        .get("name")
        .and_then(|v| v.as_str())
        .unwrap_or("")
        .to_string();

    match dispatcher.dispatch_streaming(request) {
        DispatchOutcome::Streaming {
            request_id: req_id,
            progress_rx,
            ctx,
            handler,
            arguments,
        } => {
            let start = std::time::Instant::now();

            // Track for cancellation.
            active
                .lock()
                .unwrap_or_else(|e| e.into_inner())
                .insert(id_str.clone(), ctx.cancellation.clone());

            // Spawn handler on blocking thread.
            let handler_handle = tokio::task::spawn_blocking(move || handler(arguments, ctx));

            // Drain progress in background.
            let progress_tx = out_tx.clone();
            let progress_req_id = req_id.clone();
            let progress_handle = tokio::task::spawn_blocking(move || {
                while let Ok(update) = progress_rx.recv() {
                    let notification =
                        crate::stream::progress_notification(&progress_req_id, &update);
                    if let Ok(json) = serde_json::to_string(&notification) {
                        let _ = progress_tx.send(json);
                    }
                }
            });

            // Wait for both to complete.
            let _ = progress_handle.await;
            let (response, success, error) = match handler_handle.await {
                Ok(result) => (JsonRpcResponse::success(req_id, result), true, None),
                Err(e) if e.is_cancelled() => {
                    tracing::info!("streaming handler cancelled");
                    (
                        JsonRpcResponse::error(req_id, -32800, "request cancelled"),
                        false,
                        Some("request cancelled".to_string()),
                    )
                }
                Err(_) => {
                    tracing::error!("streaming handler panicked");
                    (
                        JsonRpcResponse::error(req_id, -32603, "internal error: handler panicked"),
                        false,
                        Some("handler panicked".to_string()),
                    )
                }
            };

            let duration_ms = start.elapsed().as_millis() as u64;
            dispatcher.log_tool_call(&crate::audit::ToolCallEvent {
                tool_name,
                duration_ms,
                success,
                error,
                caller_id: None,
            });

            let _ =
                out_tx.send(serde_json::to_string(&response).expect("BUG: response serialization"));

            // Remove from active.
            active
                .lock()
                .unwrap_or_else(|e| e.into_inner())
                .remove(&id_str);
        }
        DispatchOutcome::Immediate(Some(resp)) => {
            let _ = out_tx.send(serde_json::to_string(&resp).expect("BUG: response serialization"));
        }
        DispatchOutcome::Immediate(None) => {}
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::registry::{ToolDef, ToolRegistry, ToolSchema};
    use std::collections::HashMap;
    use std::time::Duration;

    fn make_dispatcher() -> Arc<Dispatcher> {
        let mut reg = ToolRegistry::new();
        reg.register(ToolDef {
            name: "echo".into(),
            description: "Echo".into(),
            input_schema: ToolSchema {
                schema_type: "object".into(),
                properties: HashMap::new(),
                required: vec![],
            },
            version: None,
            deprecated: None,
            annotations: None,
        });
        let mut d = Dispatcher::new(reg);
        d.handle(
            "echo",
            Arc::new(|params| {
                serde_json::json!({ "content": [{ "type": "text", "text": params.to_string() }] })
            }),
        );
        Arc::new(d)
    }

    fn make_streaming_dispatcher() -> Arc<Dispatcher> {
        let mut reg = ToolRegistry::new();
        reg.register(ToolDef {
            name: "echo".into(),
            description: "Echo".into(),
            input_schema: ToolSchema {
                schema_type: "object".into(),
                properties: HashMap::new(),
                required: vec![],
            },
            version: None,
            deprecated: None,
            annotations: None,
        });
        reg.register(ToolDef {
            name: "slow".into(),
            description: "Slow streaming".into(),
            input_schema: ToolSchema {
                schema_type: "object".into(),
                properties: HashMap::new(),
                required: vec![],
            },
            version: None,
            deprecated: None,
            annotations: None,
        });
        let mut d = Dispatcher::new(reg);
        d.handle("echo", Arc::new(|p| serde_json::json!({"echoed": p})));
        d.handle_streaming(
            "slow",
            Arc::new(|_params, ctx| {
                for i in 1..=3 {
                    if ctx.cancellation.is_cancelled() {
                        return serde_json::json!({"cancelled": true});
                    }
                    ctx.progress.report(i, 3);
                    std::thread::sleep(Duration::from_millis(5));
                }
                serde_json::json!({"content": [{"type": "text", "text": "done"}]})
            }),
        );
        Arc::new(d)
    }

    async fn start_server(
        dispatcher: Arc<Dispatcher>,
    ) -> (SocketAddr, tokio::sync::oneshot::Sender<()>) {
        let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
        let addr = listener.local_addr().unwrap();
        drop(listener);

        let (tx, rx) = tokio::sync::oneshot::channel::<()>();
        let config = WsConfig { addr };
        tokio::spawn(serve(dispatcher, config, async {
            rx.await.ok();
        }));

        for _ in 0..200 {
            if tokio::net::TcpStream::connect(addr).await.is_ok() {
                return (addr, tx);
            }
            tokio::time::sleep(Duration::from_millis(1)).await;
        }
        panic!("ws server failed to start on {addr}");
    }

    #[tokio::test]
    async fn ws_initialize() {
        let (addr, _tx) = start_server(make_dispatcher()).await;
        let url = format!("ws://{addr}");
        let (mut ws, _) = tokio_tungstenite::connect_async(&url).await.unwrap();

        let req = r#"{"jsonrpc":"2.0","id":1,"method":"initialize"}"#;
        ws.send(Message::Text(req.into())).await.unwrap();

        let resp_msg = ws.next().await.unwrap().unwrap();
        let resp: JsonRpcResponse = serde_json::from_str(&resp_msg.into_text().unwrap()).unwrap();
        assert!(resp.result.is_some());
        assert!(resp.result.unwrap()["serverInfo"]["name"] == "bote");
    }

    #[tokio::test]
    async fn ws_tool_call() {
        let (addr, _tx) = start_server(make_dispatcher()).await;
        let url = format!("ws://{addr}");
        let (mut ws, _) = tokio_tungstenite::connect_async(&url).await.unwrap();

        let req = r#"{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"echo","arguments":{"msg":"hello"}}}"#;
        ws.send(Message::Text(req.into())).await.unwrap();

        let resp_msg = ws.next().await.unwrap().unwrap();
        let resp: JsonRpcResponse = serde_json::from_str(&resp_msg.into_text().unwrap()).unwrap();
        assert!(resp.result.is_some());
        assert!(resp.error.is_none());
    }

    #[tokio::test]
    async fn ws_multiple_messages() {
        let (addr, _tx) = start_server(make_dispatcher()).await;
        let url = format!("ws://{addr}");
        let (mut ws, _) = tokio_tungstenite::connect_async(&url).await.unwrap();

        let req1 = r#"{"jsonrpc":"2.0","id":1,"method":"tools/list"}"#;
        let req2 = r#"{"jsonrpc":"2.0","id":2,"method":"initialize"}"#;
        ws.send(Message::Text(req1.into())).await.unwrap();
        ws.send(Message::Text(req2.into())).await.unwrap();

        let resp1: JsonRpcResponse =
            serde_json::from_str(&ws.next().await.unwrap().unwrap().into_text().unwrap()).unwrap();
        let resp2: JsonRpcResponse =
            serde_json::from_str(&ws.next().await.unwrap().unwrap().into_text().unwrap()).unwrap();

        assert_eq!(resp1.id, serde_json::json!(1));
        assert_eq!(resp2.id, serde_json::json!(2));
        assert!(resp1.result.is_some());
        assert!(resp2.result.is_some());
    }

    #[tokio::test]
    async fn ws_malformed_json() {
        let (addr, _tx) = start_server(make_dispatcher()).await;
        let url = format!("ws://{addr}");
        let (mut ws, _) = tokio_tungstenite::connect_async(&url).await.unwrap();

        ws.send(Message::Text("not json".into())).await.unwrap();

        let resp_msg = ws.next().await.unwrap().unwrap();
        let resp: JsonRpcResponse = serde_json::from_str(&resp_msg.into_text().unwrap()).unwrap();
        assert!(resp.error.is_some());
        assert_eq!(resp.error.unwrap().code, -32700);
    }

    #[tokio::test]
    async fn ws_graceful_shutdown() {
        let (addr, tx) = start_server(make_dispatcher()).await;

        let url = format!("ws://{addr}");
        let (mut ws, _) = tokio_tungstenite::connect_async(&url).await.unwrap();
        ws.send(Message::Text(
            r#"{"jsonrpc":"2.0","id":1,"method":"initialize"}"#.into(),
        ))
        .await
        .unwrap();
        let _ = ws.next().await.unwrap().unwrap();

        tx.send(()).unwrap();
    }

    #[tokio::test]
    async fn ws_streaming_tool_progress_and_result() {
        let (addr, _tx) = start_server(make_streaming_dispatcher()).await;
        let url = format!("ws://{addr}");
        let (mut ws, _) = tokio_tungstenite::connect_async(&url).await.unwrap();

        let req = r#"{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"slow","arguments":{}}}"#;
        ws.send(Message::Text(req.into())).await.unwrap();

        // Collect all messages until we get the final result.
        let mut progress_count = 0;
        let mut final_result = None;

        for _ in 0..10 {
            let msg = tokio::time::timeout(Duration::from_secs(2), ws.next())
                .await
                .expect("timeout waiting for message")
                .unwrap()
                .unwrap();
            let text = msg.into_text().unwrap();
            let v: serde_json::Value = serde_json::from_str(&text).unwrap();

            if v.get("method").and_then(|m| m.as_str()) == Some("notifications/progress") {
                progress_count += 1;
            } else if v.get("result").is_some() {
                final_result = Some(v);
                break;
            }
        }

        assert_eq!(progress_count, 3);
        let result = final_result.unwrap();
        assert_eq!(result["id"], 1);
        assert_eq!(result["result"]["content"][0]["text"], "done");
    }
}