butterfly-bot 0.8.0

Butterfly Bot is an opinionated personal-ops AI assistant built for people who want results, not setup overhead.
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
use std::collections::HashMap;

use async_trait::async_trait;
use reqwest::header::{HeaderMap, HeaderName, HeaderValue};
use rmcp::model::{CallToolRequestParams, PaginatedRequestParams};
use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig;
use rmcp::transport::StreamableHttpClientTransport;
use rmcp::ServiceExt;
use serde_json::{json, Value};
use tokio::sync::RwLock;

use crate::error::{ButterflyBotError, Result};
use crate::interfaces::plugins::Tool;

#[derive(Clone, Debug)]
struct McpServerConfig {
    name: String,
    url: String,
    headers: HashMap<String, String>,
}

pub struct McpTool {
    servers: RwLock<Vec<McpServerConfig>>,
}

impl Default for McpTool {
    fn default() -> Self {
        Self::new()
    }
}

impl McpTool {
    pub fn new() -> Self {
        Self {
            servers: RwLock::new(Vec::new()),
        }
    }

    fn parse_servers(config: &Value) -> Result<Vec<McpServerConfig>> {
        let Some(servers) = config
            .get("tools")
            .and_then(|tools| tools.get("mcp"))
            .and_then(|mcp| mcp.get("servers"))
            .and_then(|servers| servers.as_array())
        else {
            return Ok(Vec::new());
        };

        let mut parsed = Vec::new();
        for server in servers {
            let name = server
                .get("name")
                .and_then(|v| v.as_str())
                .unwrap_or_default()
                .trim()
                .to_string();
            let url = server
                .get("url")
                .and_then(|v| v.as_str())
                .unwrap_or_default()
                .trim()
                .to_string();
            if name.is_empty() || url.is_empty() {
                return Err(ButterflyBotError::Config(
                    "MCP server entry requires name and url".to_string(),
                ));
            }
            let headers = server
                .get("headers")
                .and_then(|v| v.as_object())
                .map(|map| {
                    map.iter()
                        .filter_map(|(k, v)| v.as_str().map(|s| (k.clone(), s.to_string())))
                        .collect::<HashMap<_, _>>()
                })
                .unwrap_or_default();
            parsed.push(McpServerConfig { name, url, headers });
        }
        Ok(parsed)
    }

    async fn find_server(&self, name: Option<&str>) -> Result<McpServerConfig> {
        let servers = self.servers.read().await;
        if servers.is_empty() {
            return Err(ButterflyBotError::Runtime(
                "No MCP servers configured".to_string(),
            ));
        }
        if let Some(name) = name {
            let trimmed = name.trim();
            if !trimmed.is_empty() {
                if let Some(server) = servers.iter().find(|s| s.name == trimmed) {
                    return Ok(server.clone());
                }
                return Err(ButterflyBotError::Runtime(format!(
                    "Unknown MCP server '{trimmed}'"
                )));
            }
        }
        if servers.len() == 1 {
            Ok(servers[0].clone())
        } else {
            Err(ButterflyBotError::Runtime(
                "Multiple MCP servers configured; specify server name".to_string(),
            ))
        }
    }

    fn build_http_client(server: &McpServerConfig) -> Result<reqwest::Client> {
        let mut headers = HeaderMap::new();
        for (key, value) in &server.headers {
            let name = HeaderName::from_bytes(key.as_bytes()).map_err(|err| {
                ButterflyBotError::Config(format!("Invalid MCP header name '{}': {err}", key))
            })?;
            let value = HeaderValue::from_str(value).map_err(|err| {
                ButterflyBotError::Config(format!("Invalid MCP header value for '{}': {err}", key))
            })?;
            headers.insert(name, value);
        }

        reqwest::Client::builder()
            .default_headers(headers)
            .timeout(std::time::Duration::from_secs(60))
            .build()
            .map_err(|err| ButterflyBotError::Runtime(err.to_string()))
    }

    async fn with_client<T, F>(&self, server: &McpServerConfig, operation: F) -> Result<T>
    where
        F: for<'a> FnOnce(
            &'a rmcp::service::Peer<rmcp::RoleClient>,
        ) -> std::pin::Pin<
            Box<
                dyn std::future::Future<Output = std::result::Result<T, rmcp::ServiceError>>
                    + Send
                    + 'a,
            >,
        >,
    {
        let client = Self::build_http_client(server)?;
        let mut transport_config =
            StreamableHttpClientTransportConfig::with_uri(server.url.clone());
        transport_config.allow_stateless = true;
        let transport = StreamableHttpClientTransport::with_client(client, transport_config);
        let runtime = ()
            .serve(transport)
            .await
            .map_err(|err| ButterflyBotError::Runtime(err.to_string()))?;

        let result = operation(runtime.peer())
            .await
            .map_err(|err| ButterflyBotError::Runtime(err.to_string()));

        let shutdown = runtime
            .cancel()
            .await
            .map_err(|err| ButterflyBotError::Runtime(err.to_string()));
        shutdown?;

        result
    }

    async fn list_tools(&self, server: &McpServerConfig) -> Result<Value> {
        let list = self
            .with_client(server, |peer| {
                Box::pin(async move {
                    peer.list_tools(Some(PaginatedRequestParams {
                        meta: None,
                        cursor: None,
                    }))
                    .await
                })
            })
            .await?;
        serde_json::to_value(&list).map_err(|e| ButterflyBotError::Serialization(e.to_string()))
    }

    async fn call_tool(
        &self,
        server: &McpServerConfig,
        tool_name: &str,
        args: Option<Value>,
    ) -> Result<Value> {
        let args_map = args.and_then(|value| value.as_object().cloned());
        let tool_name = tool_name.to_string();
        let result = self
            .with_client(server, |peer| {
                Box::pin(async move {
                    peer.call_tool(CallToolRequestParams {
                        name: tool_name.into(),
                        arguments: args_map,
                        meta: None,
                        task: None,
                    })
                    .await
                })
            })
            .await?;
        serde_json::to_value(&result).map_err(|e| ButterflyBotError::Serialization(e.to_string()))
    }
}

#[async_trait]
impl Tool for McpTool {
    fn name(&self) -> &str {
        "mcp"
    }

    fn description(&self) -> &str {
        "Call tools on configured MCP servers (streamable HTTP)."
    }

    fn parameters(&self) -> Value {
        json!({
            "type": "object",
            "properties": {
                "action": {
                    "type": "string",
                    "enum": ["list_tools", "call_tool"]
                },
                "server": { "type": "string", "description": "MCP server name from config" },
                "tool": { "type": "string", "description": "Tool name to invoke on MCP server" },
                "arguments": { "type": "object", "description": "Arguments for the MCP tool" }
            },
            "required": ["action"]
        })
    }

    fn configure(&self, config: &Value) -> Result<()> {
        let servers = Self::parse_servers(config)?;
        let mut guard = self
            .servers
            .try_write()
            .map_err(|_| ButterflyBotError::Runtime("MCP tool lock busy".to_string()))?;
        *guard = servers;
        Ok(())
    }

    async fn execute(&self, params: Value) -> Result<Value> {
        let action = params
            .get("action")
            .and_then(|v| v.as_str())
            .unwrap_or("")
            .to_string();
        let server_name = params.get("server").and_then(|v| v.as_str());
        let server = self.find_server(server_name).await?;

        match action.as_str() {
            "list_tools" => {
                let list = self.list_tools(&server).await?;
                Ok(json!({"status": "ok", "server": server.name, "tools": list}))
            }
            "call_tool" => {
                let tool_name = params
                    .get("tool")
                    .and_then(|v| v.as_str())
                    .ok_or_else(|| ButterflyBotError::Runtime("Missing tool name".to_string()))?;
                let args = params.get("arguments").cloned();
                let result = self.call_tool(&server, tool_name, args).await?;
                Ok(json!({"status": "ok", "server": server.name, "result": result}))
            }
            _ => Err(ButterflyBotError::Runtime("Unsupported action".to_string())),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn runtime_message(err: ButterflyBotError) -> String {
        match err {
            ButterflyBotError::Runtime(msg) => msg,
            other => panic!("expected runtime error, got {other}"),
        }
    }

    #[test]
    fn parse_servers_handles_empty_and_invalid_entries() {
        let empty = McpTool::parse_servers(&json!({})).expect("empty config should parse");
        assert!(empty.is_empty());

        let err = McpTool::parse_servers(&json!({
            "tools": {"mcp": {"servers": [{"name": "only-name"}]}}
        }))
        .expect_err("server entry without url should fail");
        match err {
            ButterflyBotError::Config(msg) => assert!(msg.contains("requires name and url")),
            other => panic!("expected config error, got {other}"),
        }
    }

    #[test]
    fn parse_servers_keeps_string_headers_only() {
        let servers = McpTool::parse_servers(&json!({
            "tools": {
                "mcp": {
                    "servers": [
                        {
                            "name": "demo",
                            "url": "http://localhost:3001",
                            "headers": {
                                "x-api-key": "abc",
                                "x-bool": true,
                                "x-num": 42
                            }
                        }
                    ]
                }
            }
        }))
        .expect("valid server should parse");

        assert_eq!(servers.len(), 1);
        assert_eq!(servers[0].name, "demo");
        assert_eq!(servers[0].url, "http://localhost:3001");
        assert_eq!(servers[0].headers.len(), 1);
        assert_eq!(
            servers[0].headers.get("x-api-key"),
            Some(&"abc".to_string())
        );
    }

    #[tokio::test]
    async fn find_server_routes_single_and_named_servers() {
        let tool = McpTool::new();
        tool.configure(&json!({
            "tools": {
                "mcp": {
                    "servers": [
                        {"name": "primary", "url": "http://localhost:3001"}
                    ]
                }
            }
        }))
        .expect("configure single server");

        let auto = tool
            .find_server(None)
            .await
            .expect("single server auto selection");
        assert_eq!(auto.name, "primary");

        let named = tool
            .find_server(Some("primary"))
            .await
            .expect("named server lookup");
        assert_eq!(named.url, "http://localhost:3001");

        let err = tool
            .find_server(Some("missing"))
            .await
            .expect_err("unknown server should fail");
        assert!(runtime_message(err).contains("Unknown MCP server"));
    }

    #[tokio::test]
    async fn find_server_requires_name_when_multiple() {
        let tool = McpTool::new();
        tool.configure(&json!({
            "tools": {
                "mcp": {
                    "servers": [
                        {"name": "a", "url": "http://localhost:3001"},
                        {"name": "b", "url": "http://localhost:3002"}
                    ]
                }
            }
        }))
        .expect("configure multiple servers");

        let err = tool
            .find_server(Some("   "))
            .await
            .expect_err("blank server should fail with multiple configured");
        assert!(runtime_message(err).contains("Multiple MCP servers configured"));
    }

    #[test]
    fn build_http_client_validates_headers() {
        let valid_server = McpServerConfig {
            name: "ok".to_string(),
            url: "http://localhost:3001".to_string(),
            headers: HashMap::from([("x-token".to_string(), "abc".to_string())]),
        };
        McpTool::build_http_client(&valid_server).expect("valid headers should build client");

        let invalid_server = McpServerConfig {
            name: "bad".to_string(),
            url: "http://localhost:3001".to_string(),
            headers: HashMap::from([("bad header".to_string(), "abc".to_string())]),
        };
        let err = McpTool::build_http_client(&invalid_server).expect_err("invalid header");
        match err {
            ButterflyBotError::Config(msg) => assert!(msg.contains("Invalid MCP header name")),
            other => panic!("expected config error, got {other}"),
        }
    }

    #[test]
    fn parameters_schema_includes_actions() {
        let schema = McpTool::new().parameters();
        assert_eq!(schema["required"], json!(["action"]));
        let actions = schema["properties"]["action"]["enum"]
            .as_array()
            .expect("action enum");
        assert!(actions.iter().any(|v| v == "list_tools"));
        assert!(actions.iter().any(|v| v == "call_tool"));
    }
}