adk-runner 1.0.0

Agent execution runtime for Rust Agent Development Kit (ADK-Rust) agents
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
//! Sandbox tool implementations for shell and filesystem capabilities.
//!
//! This module provides the tool structs that are bound to the agent when
//! sandbox capabilities are enabled:
//!
//! - [`ExecCommandTool`] — executes shell commands in the sandbox workspace
//! - [`ReadFileTool`] — reads files from the sandbox workspace
//! - [`WriteFileTool`] — writes files to the sandbox workspace
//! - [`ListDirTool`] — lists directory entries in the sandbox workspace
//! - [`ApplyPatchTool`] — applies unified diff patches to the sandbox workspace
//!
//! All tools return errors as JSON in the response (not as Rust `Result::Err`)
//! so the LLM can reason about failures and self-correct.

use adk_core::Tool;
use adk_sandbox::workspace::SandboxSession;
use async_trait::async_trait;
use serde_json::Value;
use std::sync::Arc;
use std::time::Duration;

/// Tool that executes shell commands in the sandbox workspace.
///
/// Bound to the agent when [`Capability::Shell`](adk_sandbox::workspace::Capability::Shell)
/// is enabled. Returns JSON with `stdout`, `stderr`, `exit_code`, and `timed_out` fields.
pub struct ExecCommandTool {
    /// The live sandbox session to execute commands against.
    pub(crate) session: Arc<dyn SandboxSession>,
    /// Maximum duration for command execution.
    pub(crate) timeout: Duration,
}

impl ExecCommandTool {
    /// Creates a new `ExecCommandTool` bound to the given session.
    pub fn new(session: Arc<dyn SandboxSession>, timeout: Duration) -> Self {
        Self { session, timeout }
    }
}

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

    fn description(&self) -> &str {
        "Execute a shell command in the sandbox workspace"
    }

    fn parameters_schema(&self) -> Option<Value> {
        Some(serde_json::json!({
            "type": "object",
            "properties": {
                "command": {
                    "type": "string",
                    "description": "Shell command to execute"
                },
                "working_dir": {
                    "type": "string",
                    "description": "Optional working directory relative to workspace root"
                }
            },
            "required": ["command"]
        }))
    }

    async fn execute(
        &self,
        _ctx: Arc<dyn adk_core::ToolContext>,
        args: Value,
    ) -> adk_core::Result<Value> {
        let command = match args.get("command").and_then(|v| v.as_str()) {
            Some(cmd) => cmd,
            None => {
                return Ok(serde_json::json!({
                    "error": "invalid_arguments",
                    "message": "Missing required parameter 'command'"
                }));
            }
        };

        let working_dir = args.get("working_dir").and_then(|v| v.as_str());

        // Use tokio timeout to enforce command timeout
        let result =
            tokio::time::timeout(self.timeout, self.session.exec_command(command, working_dir))
                .await;

        match result {
            Ok(Ok(output)) => Ok(serde_json::json!({
                "stdout": output.stdout,
                "stderr": output.stderr,
                "exit_code": output.exit_code,
                "timed_out": output.timed_out
            })),
            Ok(Err(e)) => {
                // Return error as JSON for LLM self-correction
                let error_type = match &e {
                    adk_sandbox::SandboxError::PathTraversal { .. } => "path_traversal",
                    _ => "execution_error",
                };
                Ok(serde_json::json!({
                    "error": error_type,
                    "message": e.to_string()
                }))
            }
            Err(_elapsed) => {
                // Timeout — return as JSON, not as Rust error
                Ok(serde_json::json!({
                    "stdout": "",
                    "stderr": "",
                    "exit_code": -1,
                    "timed_out": true
                }))
            }
        }
    }
}

/// Tool that reads files from the sandbox workspace.
///
/// Bound to the agent when [`Capability::Filesystem`](adk_sandbox::workspace::Capability::Filesystem)
/// is enabled.
pub struct ReadFileTool {
    /// The live sandbox session to read files from.
    pub(crate) session: Arc<dyn SandboxSession>,
}

impl ReadFileTool {
    /// Creates a new `ReadFileTool` bound to the given session.
    pub fn new(session: Arc<dyn SandboxSession>) -> Self {
        Self { session }
    }
}

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

    fn description(&self) -> &str {
        "Read a file from the sandbox workspace"
    }

    fn parameters_schema(&self) -> Option<Value> {
        Some(serde_json::json!({
            "type": "object",
            "properties": {
                "path": {
                    "type": "string",
                    "description": "File path relative to workspace root"
                }
            },
            "required": ["path"]
        }))
    }

    async fn execute(
        &self,
        _ctx: Arc<dyn adk_core::ToolContext>,
        args: Value,
    ) -> adk_core::Result<Value> {
        let path = match args.get("path").and_then(|v| v.as_str()) {
            Some(p) => p,
            None => {
                return Ok(serde_json::json!({
                    "error": "invalid_arguments",
                    "message": "Missing required parameter 'path'"
                }));
            }
        };

        match self.session.read_file(path).await {
            Ok(content) => {
                // Return file contents as a string
                let text = String::from_utf8_lossy(&content);
                Ok(serde_json::json!({
                    "content": text
                }))
            }
            Err(e) => {
                let error_type = match &e {
                    adk_sandbox::SandboxError::PathTraversal { .. } => "path_traversal",
                    adk_sandbox::SandboxError::ExecutionFailed(msg)
                        if msg.contains("not found")
                            || msg.contains("No such file")
                            || msg.contains("does not exist") =>
                    {
                        "not_found"
                    }
                    _ => "read_error",
                };
                Ok(serde_json::json!({
                    "error": error_type,
                    "message": e.to_string(),
                    "path": path
                }))
            }
        }
    }
}

/// Tool that writes files to the sandbox workspace.
///
/// Bound to the agent when [`Capability::Filesystem`](adk_sandbox::workspace::Capability::Filesystem)
/// is enabled.
pub struct WriteFileTool {
    /// The live sandbox session to write files to.
    pub(crate) session: Arc<dyn SandboxSession>,
}

impl WriteFileTool {
    /// Creates a new `WriteFileTool` bound to the given session.
    pub fn new(session: Arc<dyn SandboxSession>) -> Self {
        Self { session }
    }
}

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

    fn description(&self) -> &str {
        "Write content to a file in the sandbox workspace"
    }

    fn parameters_schema(&self) -> Option<Value> {
        Some(serde_json::json!({
            "type": "object",
            "properties": {
                "path": {
                    "type": "string",
                    "description": "File path relative to workspace root"
                },
                "content": {
                    "type": "string",
                    "description": "Content to write to the file"
                }
            },
            "required": ["path", "content"]
        }))
    }

    async fn execute(
        &self,
        _ctx: Arc<dyn adk_core::ToolContext>,
        args: Value,
    ) -> adk_core::Result<Value> {
        let path = match args.get("path").and_then(|v| v.as_str()) {
            Some(p) => p,
            None => {
                return Ok(serde_json::json!({
                    "error": "invalid_arguments",
                    "message": "Missing required parameter 'path'"
                }));
            }
        };

        let content = match args.get("content").and_then(|v| v.as_str()) {
            Some(c) => c,
            None => {
                return Ok(serde_json::json!({
                    "error": "invalid_arguments",
                    "message": "Missing required parameter 'content'"
                }));
            }
        };

        match self.session.write_file(path, content.as_bytes()).await {
            Ok(()) => Ok(serde_json::json!({
                "success": true,
                "path": path,
                "message": format!("Successfully wrote {} bytes to '{path}'", content.len())
            })),
            Err(e) => {
                let error_type = match &e {
                    adk_sandbox::SandboxError::PathTraversal { .. } => "path_traversal",
                    _ => "write_error",
                };
                Ok(serde_json::json!({
                    "error": error_type,
                    "message": e.to_string(),
                    "path": path
                }))
            }
        }
    }
}

/// Tool that lists directory entries in the sandbox workspace.
///
/// Bound to the agent when [`Capability::Filesystem`](adk_sandbox::workspace::Capability::Filesystem)
/// is enabled.
pub struct ListDirTool {
    /// The live sandbox session to list directories from.
    pub(crate) session: Arc<dyn SandboxSession>,
}

impl ListDirTool {
    /// Creates a new `ListDirTool` bound to the given session.
    pub fn new(session: Arc<dyn SandboxSession>) -> Self {
        Self { session }
    }
}

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

    fn description(&self) -> &str {
        "List entries in a directory within the sandbox workspace"
    }

    fn parameters_schema(&self) -> Option<Value> {
        Some(serde_json::json!({
            "type": "object",
            "properties": {
                "path": {
                    "type": "string",
                    "description": "Directory path relative to workspace root"
                }
            },
            "required": ["path"]
        }))
    }

    async fn execute(
        &self,
        _ctx: Arc<dyn adk_core::ToolContext>,
        args: Value,
    ) -> adk_core::Result<Value> {
        let path = match args.get("path").and_then(|v| v.as_str()) {
            Some(p) => p,
            None => {
                return Ok(serde_json::json!({
                    "error": "invalid_arguments",
                    "message": "Missing required parameter 'path'"
                }));
            }
        };

        match self.session.list_dir(path).await {
            Ok(entries) => {
                // Serialize entries as JSON array of {name, type}
                let entries_json: Vec<Value> = entries
                    .iter()
                    .map(|entry| {
                        serde_json::json!({
                            "name": entry.name,
                            "type": serde_json::to_value(entry.entry_type)
                                .unwrap_or(Value::String("unknown".to_string()))
                        })
                    })
                    .collect();
                Ok(Value::Array(entries_json))
            }
            Err(e) => {
                let error_type = match &e {
                    adk_sandbox::SandboxError::PathTraversal { .. } => "path_traversal",
                    _ => "list_error",
                };
                Ok(serde_json::json!({
                    "error": error_type,
                    "message": e.to_string(),
                    "path": path
                }))
            }
        }
    }
}

/// Tool that applies unified diff patches to the sandbox workspace.
///
/// Bound to the agent when [`Capability::Filesystem`](adk_sandbox::workspace::Capability::Filesystem)
/// is enabled.
pub struct ApplyPatchTool {
    /// The live sandbox session to apply patches to.
    pub(crate) session: Arc<dyn SandboxSession>,
}

impl ApplyPatchTool {
    /// Creates a new `ApplyPatchTool` bound to the given session.
    pub fn new(session: Arc<dyn SandboxSession>) -> Self {
        Self { session }
    }
}

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

    fn description(&self) -> &str {
        "Apply a unified diff patch to the sandbox workspace"
    }

    fn parameters_schema(&self) -> Option<Value> {
        Some(serde_json::json!({
            "type": "object",
            "properties": {
                "patch": {
                    "type": "string",
                    "description": "Unified diff patch content to apply"
                }
            },
            "required": ["patch"]
        }))
    }

    async fn execute(
        &self,
        _ctx: Arc<dyn adk_core::ToolContext>,
        args: Value,
    ) -> adk_core::Result<Value> {
        let patch = match args.get("patch").and_then(|v| v.as_str()) {
            Some(p) => p,
            None => {
                return Ok(serde_json::json!({
                    "error": "invalid_arguments",
                    "message": "Missing required parameter 'patch'"
                }));
            }
        };

        match self.session.apply_patch(patch).await {
            Ok(()) => Ok(serde_json::json!({
                "success": true,
                "message": "Patch applied successfully"
            })),
            Err(e) => {
                let error_type = match &e {
                    adk_sandbox::SandboxError::PathTraversal { .. } => "path_traversal",
                    _ => "patch_error",
                };
                Ok(serde_json::json!({
                    "error": error_type,
                    "message": e.to_string()
                }))
            }
        }
    }
}