AGENTS.md

1# Core Tool Architecture
2 
3This folder owns Core's one local tool representation, process and Location registration, effective lookup, and settlement.
4 
5## Representations
6 
7- `tool.ts` defines the opaque canonical `Tool.make({ description, input, output, execute, toModelOutput })` value. Application tools and shipped built-ins use the same type.
8- `application-tools.ts` stores process-scoped application registrations.
9- `tools.ts` exposes the registration-only `Tools.Service` view used by Location producers.
10- `registry.ts` stores only canonical tools, overlays Location registrations over application registrations, derives definitions, invokes tools, and applies generic output bounding.
11 
12Do not add a second executable entry type, registry-owned executor, authorization callback, output-path callback, or legacy normalization path.
13 
14## Construction
15 
16Tool schemas and projection use `input` and `output` terminology. A tool value is opaque: its codecs, executor, definition derivation, and catalog permission declaration are private runtime details.
17 
18Location-scoped built-in layers acquire `PermissionV2.Service` and every other required Location service while the layer is constructed. The executor captures those services. Permission sources are always constructed from the canonical invocation context:
19 
20```ts
21const source = {
22  type: "tool" as const,
23  messageID: context.assistantMessageID,
24  callID: context.toolCallID,
25}
26```
27 
28Leaves own resolution, permission, and side-effect ordering. Translate only expected typed errors into `ToolFailure`; do not use `catchCause`, because interruption and defects must survive.
29 
30## Registration
31 
32Built-ins register through `Tools.Service.register({ [name]: tool })`. Application tools register through `ApplicationTools.Service.register(...)`, exposed publicly as `opencode.tools.register(...)`.
33 
34Both are scoped:
35 
36- The latest active same-placement registration wins.
37- Closing any registration removes only that registration and reveals the next active one.
38- Location registrations take precedence over application registrations.
39- An invocation captures the effective tool once settlement starts.
40 
41`ApplicationTools.Service` is process-scoped and shared by all Locations. `ToolRegistry.Service` is Location-scoped. Do not make the registry process-global or construct a separate application-tool service for each Location.
42 
43## Permissions
44 
45The registry has no `PermissionV2.Service` dependency and performs no execution authorization. An internal built-in-only operation attaches a permission action solely to preserve whole-tool definition filtering; it is not part of public `Tool.make`. Most tools default to their registered name; `edit`, `write`, and `apply_patch` declare the shared `edit` action.
46 
47Definition filtering is catalog visibility, not execution authorization. A call still executes the captured leaf policy if it reaches settlement.
48 
49## Output
50 
51Built-ins return complete validated domain output. `ToolRegistry.Materialization.settle` is the only execution and generic model-output bounding boundary and owns managed retention paths.
52 
53Producer capture limits are separate. For example, Bash keeps `AppProcess.maxOutputBytes` and accurately reports stdout/stderr capture loss, but it does not run model-output truncation or return a managed `outputPath`.
54 
55## Current Gaps
56 
57- Plugin boot has not been redesigned to register canonical tools through `Tools.Service`; do not redesign it as part of leaf migrations.
58- MCP and future Session-scoped registrations still need an explicit canonical registration design.
59- The public Session result shape currently exposes managed `outputPaths`; full storage encapsulation requires a future opaque managed-output reference design.
60