ApiTestTool class

A tool for testing API endpoints by sending HTTP requests.

Includes built-in SSRF protection via a configurable hostnameBlacklist and automatic body truncation to prevent prompt history bloat.

Inheritance

• Object
• VanturaTool<ApiTestArgs>
• ApiTestTool

Constructors

ApiTestTool({List<String> hostnameBlacklist = const ['localhost', '127.0.0.1', '0.0.0.0', 'metadata.google.internal']})

Properties

description → String

A description of what the tool does, for the agent's understanding.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

hostnameBlacklist → List<String>

Blacklist of sensitive hostnames to prevent SSRF.

final

name → String

The name of the tool, used for identification in tool calls.

no setter, override

parameters → Map<String, dynamic>

JSON Schema describing the parameters this tool accepts.

no setter, override

requiresConfirmation → bool

Whether this tool requires human confirmation before execution.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

timeout → Duration

Maximum time this tool is allowed to run before being cancelled. Defaults to 30 seconds.

no setter, inherited

Methods

execute(ApiTestArgs args) → Future<String>

Executes the tool with the given arguments.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

parseArgs(Map<String, dynamic> json) → ApiTestArgs

Parses the JSON arguments into the typed arguments object.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited