Struct JavaScriptCodeTool 

pub struct JavaScriptCodeTool { /* private fields */ }

Available on crate features code and tools only.

Embedded JavaScript code execution tool.

Runs JavaScript snippets in-process via boa_engine. The code has access to an input variable containing the JSON input, and should return a value to produce structured output.

Requires the embedded-js feature on adk-code. Without it, the tool returns a descriptive error.

Required Scopes

Returns ["code:execute"]. No elevated scopes needed.

Example

use adk_tool::{JavaScriptCodeTool, Tool};

let tool = JavaScriptCodeTool::new();
assert_eq!(tool.name(), "javascript_code");
assert_eq!(tool.required_scopes(), &["code:execute"]);

Implementations

impl JavaScriptCodeTool

pub fn new() -> JavaScriptCodeTool

Create a new JavaScriptCodeTool.

Trait Implementations

impl Default for JavaScriptCodeTool

fn default() -> JavaScriptCodeTool

Returns the “default value” for a type.

impl Tool for JavaScriptCodeTool

fn name(&self) -> &str

Returns the unique name of this tool.

fn description(&self) -> &str

Returns a human-readable description of what this tool does.

fn required_scopes(&self) -> &[&str]

Returns the scopes required to execute this tool.

fn parameters_schema(&self) -> Option<Value>

Returns the JSON Schema for this tool’s parameters, if any.

fn execute<'life0, 'async_trait>( &'life0 self, _ctx: Arc<dyn ToolContext>, args: Value, ) -> Pin<Box<dyn Future<Output = Result<Value, AdkError>> + Send + 'async_trait>>

where 'life0: 'async_trait, JavaScriptCodeTool: 'async_trait,

Executes the tool with the given context and arguments.

fn declaration(&self) -> Value

Returns the tool declaration that should be exposed to model providers.

fn enhanced_description(&self) -> String

Returns an enhanced description that may include additional notes. For long-running tools, this includes a warning not to call the tool again if it has already returned a pending status. Default implementation returns the base description.

fn is_long_running(&self) -> bool

Indicates whether the tool is a long-running operation. Long-running tools typically return a task ID immediately and complete the operation asynchronously.

fn is_builtin(&self) -> bool

Indicates whether this tool is a built-in server-side tool (e.g., google_search, url_context).

fn response_schema(&self) -> Option<Value>

Returns the JSON Schema for this tool’s response, if any.

fn is_read_only(&self) -> bool

Indicates whether this tool performs no side effects.

fn is_concurrency_safe(&self) -> bool

Indicates whether this tool is safe for concurrent execution.