tool

type Def ¶

type Def struct {
	Name        string
	Description string
	Binary      string
	Args        []string
	Docs        Docs
}

Def declares a tool the runtime should register with the LLM. The shape is intentionally split between "what the tool does" (Name, Description, Binary, Args) and "what extra reading material the model gets" (Docs). The agentfile executor populates Docs from the BIN image's `vnd.openotters.bin.*` annotations.

type Docs ¶

type Docs struct {
	// Usage is a USAGE.md-style long-form description. Appended to
	// the model-facing tool description under a "## Usage" section
	// at registration time.
	Usage string
}

Docs are documentation artefacts the executor materialised next to the binary. Each field is a path on the runtime's local filesystem; empty / missing files are tolerated silently so a BIN without docs degrades to "tool with short description only."

New annotation-driven artefacts (examples, schema, FAQ, …) plug in here as additional fields without breaking the runtime's agent.yaml schema.

type Input ¶

type Input struct {
	Args  []string `` /* 138-byte string literal not displayed */
	Stdin string   `` /* 174-byte string literal not displayed */
}

Input is the BIN tool call shape exposed to the LLM. Fantasy reflects this struct into a JSON schema, so the model sees `args` and `stdin` as named fields and picks whichever the tool needs.

Both fields are optional. Tools that take only argv use `args` and ignore `stdin`; tools whose meaningful input flows over stdin (`yaegi run -`, `pandoc`, `markitdown`, …) use `stdin` (often alongside a small `args` like `["run", "-"]`). At least one of them is required — empty calls are rejected so the model gets immediate feedback rather than the binary's own help text.

type JobIDInput ¶

type JobIDInput struct {
	JobID string `json:"job_id" jsonschema:"description=Job id returned by job_submit"`
}

JobIDInput is the shared schema for status / wait / cancel — they all take just a job id.

type ListJobsInput ¶

type ListJobsInput struct {
	AllSessions bool   `` /* 132-byte string literal not displayed */
	Status      string `` /* 131-byte string literal not displayed */
	Limit       int    `json:"limit,omitempty" jsonschema:"description=Maximum number of jobs to return (most recent first). Default 20, max 100."`
}

ListJobsInput controls the agent-side job_list scope. By default only jobs from the current chat session are returned (matching the io.openotters.session-id label that job_submit auto-stamps); flip AllSessions to see everything this agent has submitted across sessions. Status / Limit are additional narrowers. AgentID is never accepted — the daemon scopes by the agent's bound JWT, so the agent can never list another agent's jobs.

type SubmitJobInput ¶

type SubmitJobInput struct {
	Bin    string            `json:"bin" jsonschema:"description=BIN name as declared in this agent's Agentfile (sh, jq, kubectl, …)"`
	Args   []string          `json:"args,omitempty" jsonschema:"description=Positional arguments forwarded to the BIN"`
	Stdin  string            `json:"stdin,omitempty" jsonschema:"description=Optional stdin payload piped to the BIN"`
	Labels map[string]string `` /* 141-byte string literal not displayed */
}

SubmitJobInput is the model-facing schema for `job_submit`. The jsonschema tags drive what the model sees in its tool-list prompt — keep them tight so the model isn't tempted to pass irrelevant fields.