llm-coding-tools-rig 0.1.0

Lightweight, high-performance Rig framework Tool implementations for coding tools
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

//! Shell command execution tool.
//!
//! Provides cross-platform shell command execution with timeout support.

use llm_coding_tools_core::operations::execute_command;
use llm_coding_tools_core::tool_names;
use llm_coding_tools_core::{ToolContext, ToolError, ToolOutput};
use rig::completion::ToolDefinition;
use rig::tool::Tool;
use schemars::{schema_for, JsonSchema};
use serde::Deserialize;
use std::path::Path;
use std::time::Duration;

/// Default timeout: 2 minutes.
const DEFAULT_TIMEOUT_MS: u64 = 120_000;

fn default_timeout_ms() -> u64 {
    DEFAULT_TIMEOUT_MS
}

/// Arguments for the bash tool.
#[derive(Debug, Clone, Deserialize, JsonSchema)]
pub struct BashArgs {
    /// The shell command to execute.
    pub command: String,
    /// Optional working directory (must be absolute path).
    pub workdir: Option<String>,
    /// Timeout in milliseconds (default: 120000).
    #[serde(default = "default_timeout_ms")]
    pub timeout_ms: u64,
}

/// Tool for executing shell commands.
///
/// Uses bash on Unix, cmd on Windows.
#[derive(Debug, Clone, Copy, Default)]
pub struct BashTool;

impl BashTool {
    /// Creates a new bash tool instance.
    #[inline]
    pub fn new() -> Self {
        Self
    }
}

impl Tool for BashTool {
    const NAME: &'static str = tool_names::BASH;

    type Error = ToolError;
    type Args = BashArgs;
    type Output = ToolOutput;

    async fn definition(&self, _prompt: String) -> ToolDefinition {
        ToolDefinition {
            name: <Self as Tool>::NAME.to_string(),
            description: "Execute a shell command with optional working directory and timeout."
                .to_string(),
            parameters: serde_json::to_value(schema_for!(BashArgs))
                .expect("schema serialization should never fail"),
        }
    }

    async fn call(&self, args: Self::Args) -> Result<Self::Output, Self::Error> {
        let workdir = args.workdir.as_ref().map(Path::new);
        let timeout = Duration::from_millis(args.timeout_ms);

        let result = execute_command(&args.command, workdir, timeout).await?;
        Ok(result.format_output())
    }
}

impl ToolContext for BashTool {
    const NAME: &'static str = tool_names::BASH;

    fn context(&self) -> &'static str {
        llm_coding_tools_core::context::BASH
    }
}

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

    #[tokio::test]
    async fn executes_echo() {
        let tool = BashTool::new();
        let args = BashArgs {
            command: "echo hello".to_string(),
            workdir: None,
            timeout_ms: 5000,
        };
        let result = tool.call(args).await.unwrap();
        assert!(result.content.contains("hello"));
    }

    #[tokio::test]
    async fn timeout_returns_error() {
        let tool = BashTool::new();
        let cmd = if cfg!(target_os = "windows") {
            "ping -n 10 127.0.0.1"
        } else {
            "sleep 10"
        };
        let args = BashArgs {
            command: cmd.to_string(),
            workdir: None,
            timeout_ms: 100,
        };
        let result = tool.call(args).await;
        assert!(matches!(result, Err(ToolError::Timeout(_))));
    }
}