Documentation
¶
Overview ¶
Package agent provides the agent system for Sol, enabling multiple specialized agents with different capabilities and system prompts.
Index ¶
- Constants
- Variables
- func List() []string
- func MustRegister(name string, factory Factory)
- func Register(name string, factory Factory) error
- type Agent
- type Factory
- type HistoryPolicy
- type Registry
- func (r *Registry) Get(name, modelID string) (*Agent, bool)
- func (r *Registry) GetFactory(name string) (Factory, bool)
- func (r *Registry) List() []string
- func (r *Registry) MustGet(name, modelID string) *Agent
- func (r *Registry) MustRegister(name string, factory Factory)
- func (r *Registry) Register(name string, factory Factory) error
Constants ¶
const ( AgentBuild = "build" AgentPlan = "plan" AgentExplore = "explore" AgentGeneral = "general" AgentCompaction = "compaction" )
Built-in agent names.
Variables ¶
var DefaultRegistry = NewRegistry()
DefaultRegistry is the global agent registry.
Functions ¶
func MustRegister ¶
MustRegister adds a factory to the default registry, panicking on error.
Types ¶
type Agent ¶
type Agent struct {
// Name is the unique identifier for this agent (e.g., "build", "explore").
Name string
// Model is the full provider/model string (e.g., "anthropic/claude-sonnet-4-20250514").
// Parsed internally via provider.ParseModel().
Model string
// SystemPrompt is the base system prompt for this agent.
// Empty means use the model-specific default prompt.
SystemPrompt string
// EnvironmentPrompt is appended to the system prompt with environment context.
// If empty, Sol appends default environment info (workDir, platform, date).
// Set this to override with custom context (e.g. conversation ID, platform type).
EnvironmentPrompt string
// Tools is the exact set of tools this agent can use. No filtering.
Tools tool.Set
// MaxSteps limits how many steps this agent can take (0 = default 50).
MaxSteps int
// Temperature sets the model temperature for this agent (nil = provider default).
Temperature *float64
// HistoryPolicy controls which message parts from conversation history are
// included when building the LLM context. Zero value includes everything
// (matching opencode behavior).
HistoryPolicy HistoryPolicy
// Redactor strips sensitive substrings from any string before it
// leaves the agent toward the LLM. Applied to message content,
// system prompt, and environment prompt at the input boundary in
// runner.go. nil → no redaction. Closure over the live sensitive
// set in agentsdk; mutex-guarded by the caller. Best-effort:
// substring matching only — defense in depth, not a security
// guarantee. See agentsdk.IsLikelySecret for the value-eligibility
// heuristic.
Redactor func(string) string
}
Agent defines an agent configuration — what model, tools, and prompt to use.
func NewBuildAgent ¶
NewBuildAgent creates the default full-access agent for software engineering tasks. Uses the model-specific default prompt (SystemPrompt is empty).
func NewCompactionAgent ¶
NewCompactionAgent creates a hidden agent for context compaction.
func NewExploreAgent ¶
NewExploreAgent creates a specialized subagent for codebase exploration.
func NewGeneralAgent ¶
NewGeneralAgent creates a general-purpose subagent for delegated tasks.
func NewPlanAgent ¶
NewPlanAgent creates a read-only agent for planning and design.
type Factory ¶
Factory creates an Agent with tools appropriate for the given model ID.
func GetFactory ¶
GetFactory retrieves a factory from the default registry.
type HistoryPolicy ¶
type HistoryPolicy struct {
ExcludeReasoning bool // Strip ReasoningParts from assistant messages
ExcludeToolCalls bool // Strip ToolCallParts + skip tool-role messages
ExcludeFiles bool // Strip ImageParts/FileParts from all messages — stripped at PERSIST time, never reach history
// FilesRetainTurns keeps image/file parts in the N most recent user turns
// of history, then strips them when loading older messages. 0 disables
// (nothing stripped at load time). Only meaningful when ExcludeFiles=false
// — with ExcludeFiles=true files are already gone before they reach history.
FilesRetainTurns int
}
HistoryPolicy controls which message parts from conversation history are included when building the LLM context. Zero value includes everything.
type Registry ¶
type Registry struct {
// contains filtered or unexported fields
}
Registry manages available agent factories.
func (*Registry) GetFactory ¶
GetFactory retrieves the factory function for an agent by name.
func (*Registry) MustRegister ¶
MustRegister adds a factory to the registry, panicking on error.
Source Files