agentapp

package
v0.2.0-alpha.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 23, 2026 License: Apache-2.0 Imports: 31 Imported by: 0

Documentation

Index

Constants

View Source
const AgentsMdFilename = "AGENTS.md"

AgentsMdFilename is the name of the workspace-level agent instructions file per the agents.md convention (https://agents.md/).

View Source
const DefaultSystemPrompt = `` /* 4627-byte string literal not displayed */

DefaultSystemPrompt is the default system message for the BuildMax CLI agent.

View Source
const MaxAdditionalSystemPromptChars = 8192

MaxAdditionalSystemPromptChars bounds the additional system prompt. It sits in the system prompt, which is re-sent in full on every call and has no trimming path, so it is bounded when it is resolved rather than degraded later.

Variables

View Source
var ErrTurnActive = errors.New("a turn is already running for this session")

ErrTurnActive reports that a session already has a running turn. Callers that can wait should queue behind the run (surfaces already do); nothing may run a second turn concurrently.

Functions

func BuildAgentTypes

func BuildAgentTypes(registry llm.ToolRegistry, userDefs []subagent.Def) map[string]tools.AgentTypeConfig

BuildAgentTypes merges built-in sub-agent definitions with caller-provided user defs into an AgentTypeConfig map ready for tools.NewTask.

func BuildEffectiveSystemPrompt

func BuildEffectiveSystemPrompt(workspaceDir, modelName, additionalSystemPrompt string, caps PromptCapabilities) string

BuildEffectiveSystemPrompt builds the agent system prompt for a workspace, an optional model name, and an optional additional system prompt.

The layers run from least to most specific, and every one of them is additive:

  1. the runtime prompt, which carries the tool-usage conventions
  2. ~/.buildmax/AGENTS.md — personal rules
  3. <ws>/AGENTS.md — project rules
  4. the additional system prompt — this run's user-authored identity and constraints

All four are stable for the life of a session, so together they form a cacheable prefix. The compaction summary changes, and RunLoop appends it after them; it is never added here.

Pass an empty modelName when it is not yet known, and empty additional text when the run has none.

func BuildSystemPromptWithLayers

func BuildSystemPromptWithLayers(workspaceDir, modelName, additionalSystemPrompt string, caps PromptCapabilities) (string, []agent.PromptLayer)

BuildSystemPromptWithLayers builds the prompt and reports which layers contributed to it. The layer list goes into the run trace, so a finished run can say what it was told before the conversation began rather than leaving it to be inferred from behaviour.

func DefaultModelName

func DefaultModelName(settings config.Settings) string

func DeleteSession

func DeleteSession(dir, id string) error

DeleteSession removes a session from the index file and deletes its data file.

func DeleteSessionsByWorkspace

func DeleteSessionsByWorkspace(dir, workspace string) ([]string, error)

func LoadSession

func LoadSession(dir, id string) (*session.Session, error)

LoadSession reads a single session file from dir without requiring an AgentApp instance.

func LoadSessionList

func LoadSessionList(dir string) ([]session.SessionItem, error)

LoadSessionList reads the session index from dir without requiring an AgentApp instance.

func NewConfiguredPolicy

func NewConfiguredPolicy(res config.PermissionResolution, fallback agent.ToolPolicy) agent.ToolPolicy

NewConfiguredPolicy layers settings.yaml rules over a surface policy. Invalid actions are logged once and skipped: one bad rule must not stop the agent.

func NewInteractivePolicy

func NewInteractivePolicy() agent.ToolPolicy

NewInteractivePolicy returns the policy for interactive surfaces (CLI TUI, Desktop). Tool-declared Ask actions will surface an approval prompt via the ApprovalHandler.

func NewNonInteractivePolicy

func NewNonInteractivePolicy() agent.ToolPolicy

NewNonInteractivePolicy returns the policy for non-interactive surfaces (worker, print mode, portal conversation). Tool-declared Ask actions collapse to Deny because no ApprovalHandler is set on these surfaces.

func ReadAgentsMd

func ReadAgentsMd(dir string) (string, error)

ReadAgentsMd reads AGENTS.md from the given directory. Returns ("", nil) when the file does not exist.

func RenameSession

func RenameSession(dir, id, title string) error

func ResolveAgentTypeTools

func ResolveAgentTypeTools(agentName string, toolNames []string, registry llm.ToolRegistry) []llm.Tool

ResolveAgentTypeTools resolves tool names from a registry; skips unknowns with a warning.

func SetSessionPinned

func SetSessionPinned(dir, id string, pinned bool) error

func UpsertSessionItem

func UpsertSessionItem(dir string, entry session.SessionItem) error

UpsertSessionItem adds or updates one entry in the session index at dir/sessions.json. Exported for test setup; production writes go through SessionManager.Save.

func ValidateAdditionalSystemPrompt

func ValidateAdditionalSystemPrompt(text string) error

ValidateAdditionalSystemPrompt rejects text that does not fit the budget. The error names the size and the limit so whoever supplied it — a flag, a file, or an agent record — can see what to cut.

Types

type AgentApp

type AgentApp struct {
	// contains filtered or unexported fields
}

func NewAgentApp

func NewAgentApp(cfg AppConfig) (*AgentApp, error)

func (*AgentApp) AgentDefs

func (a *AgentApp) AgentDefs() []subagent.Def

AgentDefs returns the user-defined sub-agent definitions for this workspace.

func (*AgentApp) Close

func (a *AgentApp) Close() error

func (*AgentApp) CloseSession

func (a *AgentApp) CloseSession(sess *SessionContext)

CloseSession fires the SessionEnd hook for a finished session. Sessions persist on disk; this is the explicit signal for hooks/audit that the caller is done with that session. Safe to call with a nil session.

func (*AgentApp) DefaultModelName

func (a *AgentApp) DefaultModelName() string

func (*AgentApp) EstimateRunStatus

func (a *AgentApp) EstimateRunStatus(sess *SessionContext) (RunStatus, error)

func (*AgentApp) GenerateSessionTitle

func (a *AgentApp) GenerateSessionTitle(ctx context.Context, sess *SessionContext) (string, cllm.Usage, error)

func (*AgentApp) Jobs

func (a *AgentApp) Jobs() *job.Manager

Jobs returns the app's background job manager, or nil where background jobs are disabled. One manager per AgentApp: jobs are process-scoped but owned by this workspace's runtime, and closing the app stops them.

func (*AgentApp) ListSessions

func (a *AgentApp) ListSessions() ([]session.SessionItem, error)

func (*AgentApp) MCPStatus

func (a *AgentApp) MCPStatus() MCPStatus

func (*AgentApp) ManagedServerURL

func (a *AgentApp) ManagedServerURL() string

ManagedServerURL is the deployment serving this app's models, or empty when they are called directly from this machine. It is the app's mode, and a surface names it wherever it tells the user where a prompt goes.

func (*AgentApp) ModelConfigs

func (a *AgentApp) ModelConfigs() []ModelConfig

func (*AgentApp) OpenOrCreateSession

func (a *AgentApp) OpenOrCreateSession(sessionID string) (*SessionContext, error)

OpenOrCreateSession loads sessionID when it has been persisted, or creates a new session with that ID. Remote task runs use this because the server assigns a session ID before the worker has written the first session file.

func (*AgentApp) OpenSession

func (a *AgentApp) OpenSession(sessionID string) (*SessionContext, error)

func (*AgentApp) PermissionIssues

func (a *AgentApp) PermissionIssues() []string

PermissionIssues returns rules that were ignored because their action was not recognised. A rule silently dropped looks exactly like one that is in force.

func (*AgentApp) PermissionRules

func (a *AgentApp) PermissionRules() []config.PermissionEntry

PermissionRules returns the configured rules in resolution order, for display alongside ToolEntries. Rules naming a dispatch target have no tool row of their own.

func (*AgentApp) Plugins

func (a *AgentApp) Plugins() PluginSnapshot

Plugins returns the plugin inventory this runtime was assembled with.

func (*AgentApp) RefreshMCP

func (a *AgentApp) RefreshMCP(ctx context.Context) (MCPStatus, error)

func (*AgentApp) RunBackgroundEvent

func (a *AgentApp) RunBackgroundEvent(ctx context.Context, sess *SessionContext, ev BackgroundEvent, opts RunPromptOpts) (RunResult, error)

RunBackgroundEvent runs one serialized turn caused by a background job event rather than a user prompt. The appended message carries the event's non-user Source and an envelope framing the payload as untrusted observation; UserPromptSubmit does not fire, because nothing here is a user prompt. Serialization against the session is the same as RunPrompt's.

func (*AgentApp) RunPrompt

func (a *AgentApp) RunPrompt(ctx context.Context, sess *SessionContext, prompt string, opts RunPromptOpts) (RunResult, error)

func (*AgentApp) Sandbox

func (a *AgentApp) Sandbox() agent.SandboxView

Sandbox returns the SandboxView the agent will run with. In Phase A this is always NoopSandbox; Phase B will install the OS-backed manager.

func (*AgentApp) SandboxResolution

func (a *AgentApp) SandboxResolution() config.SandboxResolution

SandboxResolution returns the resolved config plus the per-layer source chain. Surfaced by `buildmax sandbox status`.

func (*AgentApp) SandboxStatus

func (a *AgentApp) SandboxStatus() SandboxStatus

SandboxStatus returns the resolved sandbox config plus runtime state.

func (*AgentApp) SessionsDir

func (a *AgentApp) SessionsDir() string

func (*AgentApp) SetDefaultModel

func (a *AgentApp) SetDefaultModel(name string)

SetDefaultModel overrides the model used for new turns in this AgentApp.

func (*AgentApp) SkillEntries

func (a *AgentApp) SkillEntries() []tools.SkillEntry

func (*AgentApp) ToolEntries

func (a *AgentApp) ToolEntries() []ToolEntry

ToolEntries returns the name and description of every tool available to the agent. It reuses the cached tool registry when available; otherwise it builds one.

func (*AgentApp) WorkspaceRoot

func (a *AgentApp) WorkspaceRoot() string

type AppConfig

type AppConfig struct {
	WorkspaceDir string
	EnableMCP    bool
	// ModelEntries overrides settings.yaml models for this AgentApp. It is how a
	// surface in managed mode supplies what the deployment offers, and how a
	// worker receives the server's resolved model without writing credentials to
	// a run directory that is later persisted as an artifact.
	ModelEntries []config.ModelEntry
	// DefaultModel names the entry in ModelEntries a new session starts with.
	// Read only when ModelEntries is set; otherwise settings.yaml says.
	DefaultModel string
	// ManagedServerURL says these models are served by that deployment rather
	// than called from this machine. Empty means direct: the models are the ones
	// in settings.yaml and each carries its own provider credential.
	//
	// It is a property of the app rather than of an entry because a list has one
	// source. A surface is in one mode or the other, and the mode decides where
	// every prompt goes. See docs/design/client-modes.md section 4.
	ManagedServerURL string
	// Policy sets the tool permission policy for all runs in this AgentApp.
	// Nil defaults to AllowAllPolicy for backward compatibility.
	Policy agent.ToolPolicy
	// SandboxSurface picks the per-surface default sandbox baseline (see
	// config.SandboxSurfaceCLI / SandboxSurfaceWorker). Empty means
	// SandboxSurfaceCLI.
	SandboxSurface config.SandboxSurface
	// ManagedToken supplies the BuildMax credential for models configured with
	// transport "buildmax". Leaving it nil means this surface offers no managed
	// inference, and such an entry fails with a clear error instead of falling
	// back to a direct provider call.
	ManagedToken ManagedTokenFunc
	// ManagedTaskRunID makes managed calls from this app run-scoped: they go to
	// the worker route, carrying a run token instead of a login, and the server
	// derives user and team from it. Empty means managed calls are team-scoped,
	// which is what CLI, TUI, and Desktop do.
	ManagedTaskRunID string
	// Surface labels managed calls for correlation, e.g. "cli" or "desktop".
	Surface string
	// AdditionalSystemPrompt is free text appended to the system prompt as its last stable
	// layer: the user-authored identity and constraints for this run. It holds the prompt text
	// itself, not the name of anything. It is additive and never replaces the runtime prompt,
	// because replacing that would strip the tool-usage conventions the agent depends on and
	// the failure would look like a bad model rather than a bad configuration.
	//
	// Whoever assembles the run resolves it — a CLI flag, a named definition file, or the
	// agent record a task run names — and the last writer wins. It is bounded because it
	// lives in the system prompt, which is re-sent in full on every call and never trimmed.
	AdditionalSystemPrompt string
	// ArtifactPublisher gives this surface the artifact capability. Nil means it
	// has none — a session running straight against a model provider, with no
	// BuildMax server — and no artifact tool is registered at all.
	ArtifactPublisher tools.ArtifactPublisher
	// EnableBackgroundJobs turns on local background jobs: Bash gains
	// run_in_background and the Job tools are registered. Only interactive
	// surfaces (TUI, Desktop) set it — print mode has no host process to own
	// a job, and eval and workers have no unattended lifecycle for one, per
	// docs/design/local-background-jobs.md.
	EnableBackgroundJobs bool
}

type BackgroundEvent

type BackgroundEvent struct {
	// Source is one of the llm.MessageSource* values.
	Source string
	JobID  string
	// Title is the short human label — the command or the delegation
	// description.
	Title string
	// Payload is the observed text: result summary, reply, or line.
	Payload string
}

BackgroundEvent is one background-job fact delivered into a session as its own serialized turn: a finished command, a subagent's final reply, or a monitor line. It is not user input and never runs user-prompt hooks.

func CompletionEvent

func CompletionEvent(m *job.Manager, j job.Job) BackgroundEvent

CompletionEvent shapes a finished job's requested delivery: the terminal state plus the reply (subagent) or a recent-output tail (command). Both surfaces build deliveries here so they cannot drift apart.

func MonitorLineEvent

func MonitorLineEvent(ev job.Event) BackgroundEvent

MonitorLineEvent shapes one react-monitor line for delivery.

type HookManager

type HookManager struct {
	// contains filtered or unexported fields
}

HookManager owns the merged hooks configuration, the per-type driver registry, and the matcher cache. It is the single object the agent runtime interacts with (via agent.HookRunner). Driver polymorphism is invisible above this layer.

Concurrency: HookManager is safe to call from multiple goroutines. The matcher cache uses a mutex; per-call execution is otherwise stateless.

func NewHookManager

func NewHookManager(cfg corehook.Config, drivers map[string]hook.Driver) *HookManager

NewHookManager constructs a manager from the already-merged hooks config and a driver registry. A nil registry is treated as empty; entries whose resolved type has no driver are skipped with a warning at dispatch time (logged once per event invocation).

func (*HookManager) Refresh

func (m *HookManager) Refresh(cfg corehook.Config)

Refresh swaps the merged config without rebuilding driver instances. The matcher cache is preserved so previously compiled regexes are still hot. Drivers that watch their own dependencies (HTTP transport, MCP catalog) pick up changes via their Deps.

func (*HookManager) Run

Run implements agent.HookRunner. See docs/design/hook-system.md §8.2 for the dispatch flow. The first matching entry that returns a block decision wins for the gate; every other matching entry still executes so audit hooks see every event.

func (*HookManager) Status

func (m *HookManager) Status() HookStatus

Status returns a snapshot describing what the manager currently dispatches.

type HookStatus

type HookStatus struct {
	EventCounts map[string]int `json:"event_counts"`
	Types       []string       `json:"types"`
	TotalHooks  int            `json:"total_hooks"`
}

HookStatus describes the visible state of the manager — counts per event and which transport types are configured. Suitable for a future `buildmax hooks` inspector or desktop activity view.

type LLMClientCache

type LLMClientCache struct {
	// contains filtered or unexported fields
}

func (*LLMClientCache) Get

func (r *LLMClientCache) Get(modelName string) (cllm.LLMClient, error)

type LLMCompactor

type LLMCompactor struct {
	// contains filtered or unexported fields
}

LLMCompactor implements agent.ContextCompactor using the same LLM client as the agent run. It calls the model once with a summarize prompt over the messages to compact.

func NewLLMCompactor

func NewLLMCompactor(client llm.LLMClient) *LLMCompactor

NewLLMCompactor creates a compactor backed by the given LLM client.

func (*LLMCompactor) Compact

func (c *LLMCompactor) Compact(ctx context.Context, msgs []llm.Message) (string, llm.Usage, error)

Compact summarizes msgs into a short text suitable for injection into the system prompt.

type MCPManager

type MCPManager struct {
	// contains filtered or unexported fields
}

func NewMCPManager

func NewMCPManager(ctx context.Context, cfg *mcpcfg.ConfigRoot) (*MCPManager, error)

NewMCPManager performs an initial Refresh with the provided config. Config load failures are returned as errors; individual server connection failures are surfaced only via Status().

func (*MCPManager) Close

func (m *MCPManager) Close() error

func (*MCPManager) Refresh

func (m *MCPManager) Refresh(ctx context.Context, cfg *mcpcfg.ConfigRoot) error

Refresh reconnects to all servers in cfg. Individual server connection failures are non-fatal and are recorded in Status() instead.

func (*MCPManager) Registry

func (m *MCPManager) Registry() *mcp.Registry

func (*MCPManager) Status

func (m *MCPManager) Status() MCPStatus

type MCPStatus

type MCPStatus struct {
	LoadError string
	Servers   []mcp.MCPServerStatus
}

type ManagedTokenFunc

type ManagedTokenFunc func(serverURL string) (string, error)

ManagedTokenFunc returns the BuildMax credential to use for serverURL. It is expected to refuse when the stored login belongs to a different server.

type ModelConfig

type ModelConfig struct {
	Name          string
	ProviderModel string
	BaseURL       string
	APIKey        string
	ContextWindow int // 0 = no windowing; from settings.yaml model entry
	CallTimeout   int // seconds; 0 = uses DefaultCallTimeoutSecs
	MaxTokens     int // 0 = the adapter's own default
	// Reasoning is the effort level (config.Reasoning*); off means none.
	Reasoning string
	// CacheControl is the resolved prompt-cache policy: which calls ask the
	// provider to cache the stable prefix, and for how long. Resolved here
	// rather than in the client so one place folds the deprecated
	// prompt_cache shorthand.
	CacheControl config.CacheControl
	// Pricing is what this model charges. Zero means the entry configured no
	// prices, and a run against it reports its cost as unavailable rather than
	// as zero — BuildMax does not know what any provider charges.
	Pricing cllm.Pricing
	// PricingErr is why an entry's prices could not be read, empty when they
	// could. Carried rather than returned because a malformed price must not
	// stop a model from answering: the run still works, it just cannot be
	// costed, and the surface says so instead of failing the turn.
	PricingErr string
	// Integration names a qualified OpenAI-compatible gateway; empty is the
	// normal case.
	Integration string
	// Vision says this model accepts image input.
	Vision bool
	// KeepAlive is how long a local runtime keeps the model loaded between
	// calls. Only a local provider has one to keep.
	KeepAlive string
	// Provider is the wire protocol this model speaks. Empty means
	// config.LLMProviderOpenAICompatible. In managed mode it is ignored: the
	// operator's catalog decides which protocol serves the call.
	//
	// There is no transport here. Where a prompt goes is a property of the app's
	// mode, not of one model — see AppConfig.ManagedServerURL.
	Provider string
}

ModelConfig is one resolved model entry usable for client creation.

func DefaultModelConfig

func DefaultModelConfig(settings config.Settings) (ModelConfig, bool)

DefaultModelConfig is the model a new session starts with: the one default_model names, or the first entry when it names none.

A default_model matching nothing falls through to the first entry rather than failing here, because a model picker that returns nothing is worse than one that returns the wrong first choice. `buildmax doctor` reports the mismatch.

func FindModelConfig

func FindModelConfig(settings config.Settings, name string) (ModelConfig, bool)

func ModelConfigFromEntry

func ModelConfigFromEntry(entry config.ModelEntry) ModelConfig

ModelConfigFromEntry resolves one settings.yaml model entry. Surfaces use it to describe a model without building a client for it.

type NoteCheckpointer

type NoteCheckpointer struct {
	// contains filtered or unexported fields
}

NoteCheckpointer implements agent.StateCheckpointer. Before a compaction discards messages, it gives the model one bounded turn to move what matters into durable session state.

It is a separate model call rather than a job handed to the summarizer: the summarizer is answering "what happened", which is a different question from "what will I still need", and it answers it from a context that does not include the run's own notes.

func NewNoteCheckpointer

func NewNoteCheckpointer(client llm.LLMClient) *NoteCheckpointer

NewNoteCheckpointer creates a checkpointer backed by the given LLM client. Its tool set is deliberately just the two state-writing tools: with a file or shell tool in reach the model treats the checkpoint as a turn to keep working.

func (*NoteCheckpointer) Checkpoint

func (c *NoteCheckpointer) Checkpoint(ctx context.Context, discarded []llm.Message) error

Checkpoint runs the checkpoint turn. It is a no-op when the run keeps no durable state or when there is nothing to look at.

type PluginSnapshot

type PluginSnapshot struct {
	Discovery config.PluginDiscovery

	// Findings gathers every problem, from the directory scan and from
	// resolving each kind of content. A collision names the plugins involved,
	// so the messages stay meaningful once they are mixed together.
	Findings []plugin.Finding

	// Shadowed lists plugin definitions a higher layer replaced, so a plugin is
	// not shown as fully active when part of it never loads.
	Shadowed []plugin.Shadowed
	// contains filtered or unexported fields
}

PluginSnapshot is the plugin inventory one runtime resolved when it was assembled, together with everything resolving it noticed.

It is fixed for the life of the runtime. A clone, pull, install, update, disable, or removal while a run is in flight must not change what that run is doing: the CLI picks up the change on its next invocation, and Desktop rebuilds its runtime after a managed plugin action.

func (PluginSnapshot) HasErrors

func (s PluginSnapshot) HasErrors() bool

HasErrors reports whether anything in the plugin layer failed to load.

func (PluginSnapshot) Loadable

func (s PluginSnapshot) Loadable() []config.DiscoveredPlugin

Loadable returns the plugins that contributed to this runtime.

func (PluginSnapshot) Provenance

func (s PluginSnapshot) Provenance(ctx context.Context) []plugin.Provenance

Provenance is the inventory to record for one run.

A repository's commit and dirty flag are read here rather than reused from assembly: a working tree can change a file between the two, and saying which input was still mutable is the record's whole purpose. Everything else is already fixed. A read that fails leaves the entry without a commit rather than failing the run.

func (PluginSnapshot) ShadowedNames

func (s PluginSnapshot) ShadowedNames(name string) []string

ShadowedNames lists what a higher layer overrode for one plugin, so a surface can say a plugin is partly inactive without knowing how layering works.

type PromptCapabilities

type PromptCapabilities struct {
	// Artifacts is true when this surface registered the artifact tool.
	Artifacts bool
}

PromptCapabilities are runtime facts that change what the agent should be told, as distinct from text a person authored.

A capability the surface does not have contributes nothing, so a session with no server is never told about a tool it does not have.

type RunPromptOpts

type RunPromptOpts struct {
	// Stream receives content deltas. Nil runs the LLM in blocking mode.
	Stream cllm.StreamSink
	// Approval resolves tool calls the policy sends to "ask". Nil collapses ask
	// to deny, which is what a surface with nobody to ask should do.
	Approval agent.ApprovalHandler
	// EventSink receives runtime events. Nil disables the caller's leg only — the
	// durable trace records the run either way.
	EventSink func(agent.Event)
	// Pending carries messages the user submits while this run is working. They
	// are appended to the history at the next iteration boundary instead of
	// waiting for the run to finish. Nil disables mid-run injection, leaving the
	// surface to drain its own queue between runs.
	Pending agent.PendingInput
}

RunPromptOpts is the optional per-run wiring a surface supplies. The zero value is a valid non-interactive run: no streaming, no approvals, no events.

type RunResult

type RunResult struct {
	Reply                 string
	Duration              time.Duration
	ToolCalls             int
	PromptTokens          int
	CompletionTokens      int
	TotalPromptTokens     int
	TotalCompletionTokens int
	// Cache counts are the provider-reported cached parts of the prompt totals
	// beside them, not extra tokens. Zero means the provider reported none,
	// which is not the same fact as a cache miss.
	CacheReadTokens       int
	CacheWriteTokens      int
	TotalCacheReadTokens  int
	TotalCacheWriteTokens int
	// Cost is the session's estimated spend so far, nil when nothing in it
	// could be priced. It is the session total rather than this turn's,
	// because that is what the session file accumulates: a per-turn figure
	// would need rates that may have changed since the turn ran.
	Cost *cllm.Cost
	// CostIncomplete says part of the session could not be priced, so the
	// total above understates it.
	CostIncomplete bool
	ContextTokens  int
	ContextWindow  int
	SessionID      string
	Workspace      string
	ModelName      string
	// TraceID identifies the durable run trace written for this run, or "" when
	// tracing is disabled or failed to start. Points at
	// <DataDir>/traces/<session_id>/<trace_id>.jsonl.
	TraceID string
	// TracePath is that file's path on disk, or "" when no trace was written.
	// Callers that persist a reference to the trace use this instead of
	// rebuilding the layout from TraceID, so the stored path and the written
	// file cannot disagree.
	TracePath string
}

type RunStatus

type RunStatus struct {
	ContextTokens         int `json:"context_tokens"`
	ContextWindow         int `json:"context_window"`
	PromptTokens          int `json:"prompt_tokens"`
	CompletionTokens      int `json:"completion_tokens"`
	TotalPromptTokens     int `json:"total_prompt_tokens"`
	TotalCompletionTokens int `json:"total_completion_tokens"`
	// Cache counts break the prompt counts beside them down; summing them with
	// the prompt total counts the same tokens twice.
	CacheReadTokens       int `json:"cache_read_tokens"`
	CacheWriteTokens      int `json:"cache_write_tokens"`
	TotalCacheReadTokens  int `json:"total_cache_read_tokens"`
	TotalCacheWriteTokens int `json:"total_cache_write_tokens"`
	// Cost is the session's estimated spend, absent when nothing could be
	// priced. CostIncomplete says the figure is missing part of the session.
	Cost           *cllm.Cost `json:"cost,omitempty"`
	CostIncomplete bool       `json:"cost_incomplete,omitempty"`
}

type SandboxStatus

type SandboxStatus struct {
	Resolution   config.SandboxResolution
	Deps         sandbox.DepsReport
	Backend      string              // backend currently active ("bwrap", "seatbelt", "none")
	Enabled      bool                // SandboxView.Enabled() — false when backend unavailable
	Mode         string              // "auto_allow" | "regular" | "" when disabled
	ProxyAddress string              // in-process HTTP proxy address ("" when not running)
	ProxyAllows  uint64              // cumulative allow decisions since proxy start
	ProxyDenies  uint64              // cumulative deny decisions since proxy start
	Recent       []sandbox.Violation // latest entries from the violation store
}

SandboxStatus is the snapshot returned by AgentApp.SandboxStatus(), used by `buildmax sandbox status` / `deps`. Mirrors what is shown by Claude Code's /sandbox panel: resolved config, source chain, backend, deps.

type SessionContext

type SessionContext struct {
	*session.Session
	// contains filtered or unexported fields
}

SessionContext wraps a persisted session with runtime helpers.

func NewSessionContext

func NewSessionContext(sess *session.Session, defaultModel string) *SessionContext

func (*SessionContext) ModelName

func (s *SessionContext) ModelName(fallback string) string

ModelName returns the selected model for this session, or the provided fallback.

func (*SessionContext) SetModel

func (s *SessionContext) SetModel(name string)

SetModel updates the selected model for this session.

type SessionManager

type SessionManager struct {
	// contains filtered or unexported fields
}

SessionManager manages file-based session lifecycle for AgentApp.

func (*SessionManager) Create

func (s *SessionManager) Create(defaultModel string) *SessionContext

func (*SessionManager) Finalize

func (s *SessionManager) Finalize(ctx context.Context, client llm.LLMClient, sess *SessionContext, workspace string, stats agent.RunStats, pricing llm.Pricing) (TurnFinalizeResult, error)

Finalize runs the post-turn flow: accumulate token usage, persist the session, and generate a title via LLM if one is not yet set.

func (*SessionManager) GenerateTitle

func (s *SessionManager) GenerateTitle(ctx context.Context, client llm.LLMClient, sess *SessionContext) (string, llm.Usage, error)

func (*SessionManager) List

func (s *SessionManager) List() ([]session.SessionItem, error)

func (*SessionManager) Load

func (s *SessionManager) Load(id, defaultModel string) (*SessionContext, error)

func (*SessionManager) Save

func (s *SessionManager) Save(sess *SessionContext, workspace string) error

type SessionStats

type SessionStats struct {
	ID        string    `json:"id"`
	Title     string    `json:"title,omitempty"`
	Workspace string    `json:"workspace,omitempty"`
	CreatedAt time.Time `json:"created_at"`

	// Usage and Cost are the session's own accumulated totals.
	Usage llm.Usage `json:"usage"`
	Cost  *llm.Cost `json:"cost,omitempty"`
	// CostIncomplete says part of the session could not be priced, so Cost
	// understates it rather than covering it.
	CostIncomplete bool `json:"cost_incomplete,omitempty"`

	// Conversation is the shape of the stored history.
	Conversation session.ConversationStats `json:"conversation"`
	// Runs is the fold over this session's traces. Runs.Runs == 0 means no
	// trace was found, which is not the same as a session that never ran.
	Runs trace.SessionSummary `json:"runs"`
}

SessionStats is one session's statistics, assembled from the two records that hold them.

The session file is authoritative for tokens and money: it accumulated them turn by turn at the rates in force for each, and no later read can restate that. The traces are authoritative for everything time-shaped, and for the per-run detail the session file never kept — durations, denials, which model ran, how much a delegation did.

They are kept apart rather than merged into one flat number because they can legitimately disagree: a run that died before writing run_end is in the session's totals and missing from the trace fold, and a reader shown one blended figure would have no way to notice.

func LoadSessionStats

func LoadSessionStats(sessionsDir, tracesDir, id string) (SessionStats, error)

LoadSessionStats assembles one session's statistics. sessionsDir and tracesDir are the two roots; id names the session.

A missing trace directory is not an error — tracing is fail-open and nothing prunes it today, so its absence is a normal state that the returned Runs reports rather than a failure to load the session.

func NewSessionStats

func NewSessionStats(sess *session.Session, workspace, tracesDir string) (SessionStats, error)

NewSessionStats assembles statistics for a session already in memory.

A surface holding the live session uses this rather than LoadSessionStats: a session is persisted after each assistant reply, so reading it back from disk mid-turn answers about the turn before the one on screen.

func (SessionStats) CacheSaved

func (s SessionStats) CacheSaved() (int64, bool)

CacheSaved is what prompt caching is estimated to have saved this session, and ok=false when nothing here was priced or caching cost more than it saved. Reporting a saving on a session that only ever wrote cache entries would be the false claim the whole cost path avoids.

func (SessionStats) ContextPeakShare

func (s SessionStats) ContextPeakShare() (float64, bool)

ContextPeakShare is how close the session came to its context window, and ok=false when the traces recorded no window to compare against.

func (SessionStats) ModelTime

func (s SessionStats) ModelTime() (time.Duration, bool)

ModelTime is the part of a session's wall clock that was not a tool call: model latency plus the loop's own work. ok is false when the traces did not measure enough to answer — no completed run, or tool time exceeding the wall clock, which parallel tool execution makes possible and which would turn into a negative answer.

type SkillRegistry

type SkillRegistry struct {
	// contains filtered or unexported fields
}

func (*SkillRegistry) Entries

func (s *SkillRegistry) Entries() []tools.SkillEntry

func (*SkillRegistry) Load

func (s *SkillRegistry) Load(workspace string, plugins []config.DiscoveredPlugin) error

func (*SkillRegistry) NewTool

func (s *SkillRegistry) NewTool() *tools.SkillTool

type SubAgentRegistry

type SubAgentRegistry struct {
	// contains filtered or unexported fields
}

func (*SubAgentRegistry) Definitions

func (s *SubAgentRegistry) Definitions() []subagent.Def

func (*SubAgentRegistry) Load

func (s *SubAgentRegistry) Load(workspace string, plugins []config.DiscoveredPlugin) error

type ToolEntry

type ToolEntry struct {
	Name        string
	Description string
	// Access is what the tool says the call does: "read-only" or "write".
	Access string
	// Action is what the call resolves to with no arguments and a human
	// present: "allow", "ask", or "deny". Argument-dependent tools can resolve
	// differently for a real call — Bash asks only for a risky command — so
	// this is the category answer, not a promise about every invocation.
	Action string
	// Source names where Action came from: "settings" or "derived".
	Source string
}

ToolEntry is a name+description pair for a tool available to the agent.

type TurnFinalizeResult

type TurnFinalizeResult struct {
	Title            string
	PromptTokens     int
	CompletionTokens int
	CacheReadTokens  int
	CacheWriteTokens int
}

Directories

Path Synopsis
Package job owns the local background jobs of one AgentApp: identity, state, bounded output, stop, lifecycle events, and shutdown.
Package job owns the local background jobs of one AgentApp: identity, state, bounded output, stop, lifecycle events, and shutdown.
Package taskrun provides task-run execution.
Package taskrun provides task-run execution.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL