rs-utcp 0.3.2

Rust implementation of the Universal Tool Calling Protocol (UTCP).
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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
// CLI Transport - executes command-line tools
use anyhow::{anyhow, Result};
use async_trait::async_trait;
use serde_json::Value;
use std::collections::HashMap;
use std::time::Duration;
use tokio::io::AsyncWriteExt;
use tokio::process::Command;

use crate::providers::base::Provider;
use crate::providers::cli::CliProvider;
use crate::tools::Tool;
use crate::transports::{stream::StreamResult, ClientTransport};

/// Transport that shells out to a CLI binary which exposes UTCP-compatible commands.
pub struct CliTransport;

impl CliTransport {
    /// Create a CLI transport.
    pub fn new() -> Self {
        Self
    }

    fn parse_command(&self, command_name: &str) -> Result<(String, Vec<String>)> {
        let parts: Vec<String> = command_name
            .split_whitespace()
            .map(|s| s.to_string())
            .collect();

        if parts.is_empty() {
            return Err(anyhow!("Empty command name"));
        }

        Ok((parts[0].clone(), parts[1..].to_vec()))
    }

    async fn execute_command(
        &self,
        cmd_path: &str,
        args: &[String],
        env_vars: &Option<HashMap<String, String>>,
        working_dir: &Option<String>,
        stdin_input: Option<&str>,
    ) -> Result<(String, String, i32)> {
        let mut cmd = Command::new(cmd_path);
        cmd.args(args);

        // Set environment variables
        if let Some(env) = env_vars {
            for (k, v) in env {
                cmd.env(k, v);
            }
        }

        // Set working directory
        if let Some(dir) = working_dir {
            cmd.current_dir(dir);
        }

        // Configure stdin/stdout/stderr
        cmd.stdin(if stdin_input.is_some() {
            std::process::Stdio::piped()
        } else {
            std::process::Stdio::null()
        });
        cmd.stdout(std::process::Stdio::piped());
        cmd.stderr(std::process::Stdio::piped());

        let mut child = cmd.spawn()?;

        // Write stdin if provided
        if let Some(input) = stdin_input {
            if let Some(mut stdin) = child.stdin.take() {
                stdin.write_all(input.as_bytes()).await?;
                drop(stdin); // Close stdin
            }
        }

        // Wait for completion with timeout
        let output =
            tokio::time::timeout(Duration::from_secs(30), child.wait_with_output()).await??;

        let stdout = String::from_utf8_lossy(&output.stdout).to_string();
        let stderr = String::from_utf8_lossy(&output.stderr).to_string();
        let exit_code = output.status.code().unwrap_or(1);

        Ok((stdout, stderr, exit_code))
    }

    fn format_arguments(&self, args: &HashMap<String, Value>) -> Vec<String> {
        let mut result = Vec::new();
        let mut keys: Vec<_> = args.keys().collect();
        keys.sort(); // Deterministic ordering

        for key in keys {
            if let Some(value) = args.get(key) {
                match value {
                    Value::Bool(true) => {
                        result.push(format!("--{}", key));
                    }
                    Value::Bool(false) => {
                        // Skip false booleans
                    }
                    Value::Array(arr) => {
                        for item in arr {
                            result.push(format!("--{}", key));
                            result.push(item.to_string());
                        }
                    }
                    _ => {
                        result.push(format!("--{}", key));
                        result.push(value.to_string().trim_matches('"').to_string());
                    }
                }
            }
        }

        result
    }

    fn extract_tools_from_output(&self, output: &str) -> Vec<Tool> {
        // Try to parse as UTCP manifest
        if let Ok(manifest) = serde_json::from_str::<Value>(output) {
            if let Some(tools_array) = manifest.get("tools").and_then(|v| v.as_array()) {
                let mut tools = Vec::new();
                for tool_value in tools_array {
                    if let Ok(tool) = serde_json::from_value::<Tool>(tool_value.clone()) {
                        tools.push(tool);
                    }
                }
                return tools;
            }
        }

        // Try line-by-line parsing
        let mut tools = Vec::new();
        for line in output.lines() {
            let line = line.trim();
            if line.starts_with('{') && line.ends_with('}') {
                if let Ok(tool) = serde_json::from_str::<Tool>(line) {
                    tools.push(tool);
                }
            }
        }

        tools
    }
}

#[async_trait]
impl ClientTransport for CliTransport {
    async fn register_tool_provider(&self, prov: &dyn Provider) -> Result<Vec<Tool>> {
        let cli_prov = prov
            .as_any()
            .downcast_ref::<CliProvider>()
            .ok_or_else(|| anyhow!("Provider is not a CliProvider"))?;

        // Parse command name into command and args
        let (cmd_path, cmd_args) = self.parse_command(&cli_prov.command_name)?;

        // Execute discovery command
        let (stdout, stderr, exit_code) = self
            .execute_command(
                &cmd_path,
                &cmd_args,
                &cli_prov.env_vars,
                &cli_prov.working_dir,
                None,
            )
            .await?;

        let output = if exit_code == 0 { stdout } else { stderr };

        if output.trim().is_empty() {
            return Ok(vec![]);
        }

        Ok(self.extract_tools_from_output(&output))
    }

    async fn deregister_tool_provider(&self, _prov: &dyn Provider) -> Result<()> {
        // CLI transport is stateless
        Ok(())
    }

    async fn call_tool(
        &self,
        tool_name: &str,
        args: HashMap<String, Value>,
        prov: &dyn Provider,
    ) -> Result<Value> {
        let cli_prov = prov
            .as_any()
            .downcast_ref::<CliProvider>()
            .ok_or_else(|| anyhow!("Provider is not a CliProvider"))?;

        // Parse command name
        let (cmd_path, mut cmd_args) = self.parse_command(&cli_prov.command_name)?;

        // Build command: <cmd> call <provider> <tool> [--flags]
        cmd_args.extend([
            "call".to_string(),
            cli_prov.base.name.clone(),
            tool_name.to_string(),
        ]);
        cmd_args.extend(self.format_arguments(&args));

        // Prepare JSON input
        let input_json = serde_json::to_string(&args)?;

        // Execute command
        let (stdout, stderr, exit_code) = self
            .execute_command(
                &cmd_path,
                &cmd_args,
                &cli_prov.env_vars,
                &cli_prov.working_dir,
                Some(&input_json),
            )
            .await?;

        let output = if exit_code == 0 { stdout } else { stderr };

        if output.trim().is_empty() {
            return Ok(Value::String(String::new()));
        }

        // Try to parse as JSON
        if let Ok(result) = serde_json::from_str::<Value>(&output) {
            Ok(result)
        } else {
            // Return as string if not JSON
            Ok(Value::String(output.trim().to_string()))
        }
    }

    async fn call_tool_stream(
        &self,
        _tool_name: &str,
        _args: HashMap<String, Value>,
        _prov: &dyn Provider,
    ) -> Result<Box<dyn StreamResult>> {
        Err(anyhow!("Streaming not supported by CliTransport"))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::providers::base::{BaseProvider, ProviderType};
    use crate::providers::cli::CliProvider;
    use serde_json::json;
    use std::fs;
    use tempfile::tempdir;

    #[test]
    fn format_arguments_handles_types_and_ordering() {
        let transport = CliTransport::new();
        let mut args = HashMap::new();
        args.insert("message".to_string(), Value::String("hello".to_string()));
        args.insert("count".to_string(), Value::Number(2.into()));
        args.insert("enabled".to_string(), Value::Bool(true));
        args.insert("skip".to_string(), Value::Bool(false));
        args.insert(
            "ids".to_string(),
            Value::Array(vec![Value::Number(1.into()), Value::Number(2.into())]),
        );

        let formatted = transport.format_arguments(&args);
        assert_eq!(
            formatted,
            vec![
                "--count",
                "2",
                "--enabled",
                "--ids",
                "1",
                "--ids",
                "2",
                "--message",
                "hello"
            ]
        );
    }

    #[test]
    fn extract_tools_from_output_parses_manifest() {
        let transport = CliTransport::new();
        let output = json!({
            "tools": [{
                "name": "example",
                "description": "example tool",
                "inputs": { "type": "object" },
                "outputs": { "type": "object" },
                "tags": []
            }]
        })
        .to_string();

        let tools = transport.extract_tools_from_output(&output);
        assert_eq!(tools.len(), 1);
        assert_eq!(tools[0].name, "example");
        assert_eq!(tools[0].description, "example tool");
    }

    fn write_mock_cli(dir: &std::path::Path) -> std::path::PathBuf {
        let script_path = dir.join("mock_cli.js");
        let script = r#"#!/usr/bin/env node
const [,, mode, provider, tool, ...flags] = process.argv;
if (!mode) {
  console.log(JSON.stringify({
    tools: [{
      name: "echo",
      description: "echo tool",
      inputs: { "type": "object" },
      outputs: { "type": "object" },
      tags: []
    }]
  }));
  process.exit(0);
}

if (mode === "call") {
  let body = "";
  process.stdin.on("data", chunk => body += chunk.toString());
  process.stdin.on("end", () => {
    const args = body ? JSON.parse(body) : {};
    console.log(JSON.stringify({ provider, tool, args, flags }));
  });
}
"#;
        fs::write(&script_path, script).unwrap();
        #[cfg(unix)]
        {
            use std::os::unix::fs::PermissionsExt;
            let mut perms = fs::metadata(&script_path).unwrap().permissions();
            perms.set_mode(0o755);
            fs::set_permissions(&script_path, perms).unwrap();
        }
        script_path
    }

    fn write_cli_requiring_mode_flag(dir: &std::path::Path) -> std::path::PathBuf {
        let script_path = dir.join("mock_cli_mode_flag.js");
        let script = r#"#!/usr/bin/env node
const argv = process.argv.slice(2);
const hasFlag = argv.shift() === "--cli-mode";
if (!hasFlag) {
  console.error("missing --cli-mode");
  process.exit(2);
}

const [mode, provider, tool, ...flags] = argv;
if (!mode) {
  console.log(JSON.stringify({
    tools: [{
      name: "echo",
      description: "echo tool",
      inputs: { "type": "object" },
      outputs: { "type": "object" },
      tags: []
    }]
  }));
  process.exit(0);
}

if (mode === "call") {
  let body = "";
  process.stdin.on("data", chunk => body += chunk.toString());
  process.stdin.on("end", () => {
    const args = body ? JSON.parse(body) : {};
    console.log(JSON.stringify({ provider, tool, args, flags, hadFlag: hasFlag }));
  });
}
"#;
        fs::write(&script_path, script).unwrap();
        #[cfg(unix)]
        {
            use std::os::unix::fs::PermissionsExt;
            let mut perms = fs::metadata(&script_path).unwrap().permissions();
            perms.set_mode(0o755);
            fs::set_permissions(&script_path, perms).unwrap();
        }
        script_path
    }

    fn cli_provider(command: &str) -> CliProvider {
        CliProvider {
            base: BaseProvider {
                name: "cli".to_string(),
                provider_type: ProviderType::Cli,
                auth: None,
                allowed_communication_protocols: None,
            },
            command_name: command.to_string(),
            working_dir: None,
            env_vars: None,
        }
    }

    #[tokio::test]
    async fn register_and_call_tool_via_cli_transport() {
        let dir = tempdir().unwrap();
        let script_path = write_mock_cli(dir.path());
        let command = script_path.display().to_string();

        let transport = CliTransport::new();
        let provider = cli_provider(&command);

        let tools = transport
            .register_tool_provider(&provider)
            .await
            .expect("register tools");
        assert_eq!(tools.len(), 1);
        assert_eq!(tools[0].name, "echo");

        let mut args = HashMap::new();
        args.insert("name".into(), Value::String("world".into()));
        let result = transport
            .call_tool("echo", args.clone(), &provider)
            .await
            .expect("call tool");

        assert!(
            result.get("provider").is_some(),
            "result missing provider: {}",
            result
        );
        assert_eq!(result["provider"], "cli");
        assert_eq!(result["tool"], "echo");
        assert_eq!(result["args"], json!(args));
    }

    #[tokio::test]
    async fn call_tool_respects_base_command_args() {
        let dir = tempdir().unwrap();
        let script_path = write_cli_requiring_mode_flag(dir.path());
        let command = format!("{} --cli-mode", script_path.display());

        let transport = CliTransport::new();
        let provider = cli_provider(&command);

        let tools = transport
            .register_tool_provider(&provider)
            .await
            .expect("register tools");
        assert_eq!(tools.len(), 1);

        let result = transport
            .call_tool("echo", HashMap::new(), &provider)
            .await
            .expect("call tool");

        assert_eq!(result["hadFlag"], json!(true));
    }

    #[tokio::test]
    async fn call_tool_stream_not_supported() {
        let dir = tempdir().unwrap();
        let script_path = write_mock_cli(dir.path());
        let command = format!("node {}", script_path.display());
        let transport = CliTransport::new();
        let provider = cli_provider(&command);

        let err = transport
            .call_tool_stream("echo", HashMap::new(), &provider)
            .await
            .err()
            .expect("expected streaming error");
        assert!(err.to_string().contains("Streaming not supported"));
    }
}