Struct BackendTool 

pub struct BackendTool { /* private fields */ }

A tool a plugin’s backend serves ("run": "backend"): each call is a tool request.

Implementations

impl BackendTool

pub fn new( name: String, plugin: PluginRef, decl: ManifestTool, backend: Arc<Backend>, ) -> Self

pub fn with_cards(self, cards: Vec<(String, bool)>) -> Self

The card views its plugin declares (views with "site": "card"): (id, web view).

pub fn with_types(self, types: ArtifactTypes) -> Self

Save the artifact versions its results carry with these types (the chat’s).

pub fn with_timeout(self, timeout: Duration) -> Self

pub fn declared(&self) -> &ManifestTool

Trait Implementations

impl Tool for BackendTool

fn spec(&self) -> ToolSpec

fn title(&self, args: &Value) -> String

Short human title for the finished call, e.g. “Wrote notes.md”. args is untrusted.

fn access(&self, _args: &Value) -> Access

What this call would do; drives the permission gate. Must not have side effects.

fn run(&self, args: &Value, ctx: &ToolContext<'_>) -> ToolOutput

Do it. args is untrusted model output: validate everything, never panic.

fn pending_title(&self, _args: &Value) -> String

Title for the call before and while it runs, and on approval cards, e.g. “Write notes.md”. Defaults to “Run ”.

fn preview(&self, args: &Value, _workspace: &Path) -> Option<Preview>

A readable account of what the call would do, for approval cards: e.g. a diff for a file write. Reads only, no side effects; bounded. Defaults to the key arguments.

fn always_ask(&self, _args: &Value) -> Option<String>

Some(warning) if this call must be approved by a person every time: no policy, “always allow” grant or --auto-approve lets it run (e.g. installing system-wide). The warning is shown on the approval card.

fn concurrent(&self) -> bool

Calls of this tool start before the other calls of the same round and run side by side, each on a thread of its own (results still go back in call order). For tools that mostly wait, like delegate.