tool.go RawHistoryFolder
1// Package core implements the agent loop, tool runtime, and session
2// persistence. It is provider-agnostic: it talks to an LLM only through
3// the provider.Client interface.
4package core
5
6import (
7 "context"
8 "encoding/json"
9 "fmt"
10 "sort"
11
12 "github.com/bnema/zut/packages/provider"
13)
14
15// Tool is a capability the agent can invoke.
16type Tool interface {
17 // Name is the unique tool id shown to the LLM.
18 Name() string
19 // Description is a one-line summary shown to the LLM.
20 Description() string
21 // Schema is a JSON Schema object for Execute's args.
22 Schema() json.RawMessage
23 // Execute runs the tool. progress may be called any number of times
24 // with partial textual output (for UIs); it is not sent to the LLM.
25 Execute(ctx context.Context, args json.RawMessage, progress func(string)) (ToolResult, error)
26}
27
28// ToolPreviewer is optionally implemented by tools that can describe their
29// exact effect without applying it. Confirmation UIs use the preview before
30// allowing a side-effecting call to proceed.
31type ToolPreviewer interface {
32 Preview(ctx context.Context, args json.RawMessage) (ToolResult, error)
33}
34
35// ToolResult is the outcome of Tool.Execute.
36type ToolResult struct {
37 // Content is sent back to the LLM (text and/or images).
38 Content []provider.Content
39 // IsError marks this result as an error to the LLM.
40 IsError bool
41 // ActivateTools names previously deferred tools that become available
42 // after this result. Unknown names are ignored by the agent.
43 ActivateTools []string
44 // Details is arbitrary data for UIs and logs; not sent to the LLM.
45 Details any
46}
47
48// Registry is a name->Tool map.
49type Registry map[string]Tool
50
51// NewRegistry builds a Registry from a list of tools.
52func NewRegistry(tools ...Tool) Registry {
53 r := Registry{}
54 for _, t := range tools {
55 r[t.Name()] = t
56 }
57 return r
58}
59
60// Specs returns the tool definitions to advertise to the LLM.
61// Sorted by tool name so the order is stable across requests. This
62// is load-bearing for provider-side prompt caching: providers
63// prefix-match tool definitions, and Go's map iteration order is
64// randomized per call, which would otherwise bust the cache every
65// single turn.
66func (r Registry) Specs() []provider.Tool {
67 names := make([]string, 0, len(r))
68 for name := range r {
69 names = append(names, name)
70 }
71 sort.Strings(names)
72 out := make([]provider.Tool, 0, len(r))
73 for _, name := range names {
74 t := r[name]
75 deferred := false
76 if d, ok := t.(interface{ Deferred() bool }); ok {
77 deferred = d.Deferred()
78 }
79 out = append(out, provider.Tool{
80 Name: t.Name(),
81 Description: t.Description(),
82 Schema: t.Schema(),
83 Deferred: deferred,
84 })
85 }
86 return out
87}
88
89// Get looks up a tool by name.
90func (r Registry) Get(name string) (Tool, error) {
91 t, ok := r[name]
92 if !ok {
93 return nil, fmt.Errorf("unknown tool %q", name)
94 }
95 return t, nil
96}