Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

sp4rk

package module

Go to main page

Versions in this module

v0

v0.15.0

Sep 11, 2026

v0.14.0

Sep 2, 2026

v0.13.0

Sep 1, 2026

v0.12.0

Sep 1, 2026

v0.11.0

Aug 30, 2026

v0.10.0

Aug 21, 2026

v0.9.0

Aug 5, 2026

v0.8.0

Aug 3, 2026

v0.7.0

Aug 2, 2026

v0.6.0

Aug 1, 2026

v0.5.0

Jul 31, 2026

v0.4.0

Jul 21, 2026

v0.3.0

Jul 21, 2026

v0.2.0

Jul 18, 2026

v0.1.0

Jul 18, 2026

Changes in this version

+ func AllBuiltinTools() []tools.Tool

+ func Anthropic(apiKey string, models ...string) llm.ProviderEntry

+ func CodeTools() []tools.Tool

+ func DefaultPromptSet() planner.PromptSet

+ func DefaultReflectorPrompt() string

+ func FileTools() []tools.Tool

+ func FinishTool() []tools.Tool

+ func MCPHTTP(name, url string) (string, mcp.ServerEntry)

+ func MCPStdio(name, command string, args ...string) (string, mcp.ServerEntry)

+ func MemoryTools() []tools.Tool

+ func OpenAI(apiKey string, models ...string) llm.ProviderEntry

+ func OpenAICompatible(name, baseURL, apiKey string, models ...string) llm.ProviderEntry

+ func Tools(ts ...tools.Tool) []tools.Tool

+ type CompactionConfig struct

+ EmergencyPercent int

+ PredictivePercent int

+ Strategy string

+ WarningPercent int

+ type Config struct

+ Checkpointer orchestration.Checkpointer

+ Compaction CompactionConfig

+ ConfirmFunc tools.ConfirmFunc

+ Execution ExecutionConfig

+ HITL agent.HITLHandler

+ LLM LLMConfig

+ Logger *slog.Logger

+ MCP *MCPConfig

+ OnBlackboardChanged func(changeType string)

+ type ExecutionConfig struct

+ CircuitBreaker agent.CircuitBreakerConfig

+ MaxDependencyContextChars int

+ MaxRetries int

+ MaxSteps int

+ PreWarningPercent int

+ SafetyMarginPercent int

+ ToolCacheTTLSeconds int

+ ToolResultBudget agent.ToolResultBudget

+ type Framework struct

+ func New(cfg Config) (*Framework, error)

+ func (fw *Framework) ContextFactory() orchestration.ContextManagerFactory

+ func (fw *Framework) Execute(ctx context.Context, systemPrompt orchestration.SystemPromptFactory, ...) (*orchestration.ExecutionResult, error)

+ func (fw *Framework) LLMRouter() *llm.Router

+ func (fw *Framework) NewConductor(systemPrompt orchestration.SystemPromptFactory) (*orchestration.Conductor, error)

+ func (fw *Framework) RestoreBlackboard(ctx context.Context, id string) (*orchestration.CheckpointedBlackboard, error)

+ func (fw *Framework) RunF(ctx context.Context) *RunBuilder

+ func (fw *Framework) Shutdown() error

+ func (fw *Framework) TaskF(ctx context.Context, task string) *TaskBuilder

+ func (fw *Framework) ToolRegistry() *tools.ToolRegistry

+ type FrameworkBuilder struct

+ func NewF() *FrameworkBuilder

+ func (b *FrameworkBuilder) AllBuiltinTools() *FrameworkBuilder

+ func (b *FrameworkBuilder) Anthropic(apiKey string, models ...string) *FrameworkBuilder

+ func (b *FrameworkBuilder) AutoApprove() *FrameworkBuilder

+ func (b *FrameworkBuilder) Build() (*Framework, error)

+ func (b *FrameworkBuilder) CodeTools() *FrameworkBuilder

+ func (b *FrameworkBuilder) Config(cfg Config) *FrameworkBuilder

+ func (b *FrameworkBuilder) ConfirmFunc(fn tools.ConfirmFunc) *FrameworkBuilder

+ func (b *FrameworkBuilder) DefaultModel(model string) *FrameworkBuilder

+ func (b *FrameworkBuilder) FileTools() *FrameworkBuilder

+ func (b *FrameworkBuilder) HITL(h agent.HITLHandler) *FrameworkBuilder

+ func (b *FrameworkBuilder) Logger(l *slog.Logger) *FrameworkBuilder

+ func (b *FrameworkBuilder) MCPHTTP(name, url string) *FrameworkBuilder

+ func (b *FrameworkBuilder) MCPServer(name string, entry mcp.ServerEntry) *FrameworkBuilder

+ func (b *FrameworkBuilder) MCPStdio(name, command string, args ...string) *FrameworkBuilder

+ func (b *FrameworkBuilder) MCPWorkDir(dir string) *FrameworkBuilder

+ func (b *FrameworkBuilder) MaxSteps(n int) *FrameworkBuilder

+ func (b *FrameworkBuilder) MemoryTools() *FrameworkBuilder

+ func (b *FrameworkBuilder) NoAutoFinish() *FrameworkBuilder

+ func (b *FrameworkBuilder) OpenAI(apiKey string, models ...string) *FrameworkBuilder

+ func (b *FrameworkBuilder) OpenAICompatible(name, baseURL, apiKey string, models ...string) *FrameworkBuilder

+ func (b *FrameworkBuilder) Options(opts ...Option) *FrameworkBuilder

+ func (b *FrameworkBuilder) Provider(p llm.ProviderEntry) *FrameworkBuilder

+ func (b *FrameworkBuilder) Providers(ps ...llm.ProviderEntry) *FrameworkBuilder

+ func (b *FrameworkBuilder) Run(ctx context.Context) *RunBuilder

+ func (b *FrameworkBuilder) Task(ctx context.Context, task string) *TaskBuilder

+ func (b *FrameworkBuilder) Tools(ts ...tools.Tool) *FrameworkBuilder

+ type LLMConfig struct

+ DefaultModel string

+ InitialBackoff string

+ MaxBackoff string

+ MaxRetries int

+ OutputTokenReserve int

+ Providers []llm.ProviderEntry

+ type MCPConfig struct

+ DefaultWorkDir string

+ Servers map[string]mcp.ServerEntry

+ type Option interface

+ func WithAutoApprove() Option

+ func WithConfig(cfg Config) Option

+ func WithConfirmFunc(fn tools.ConfirmFunc) Option

+ func WithDefaultModel(model string) Option

+ func WithHITL(h agent.HITLHandler) Option

+ func WithLogger(l *slog.Logger) Option

+ func WithMCPServer(name string, entry mcp.ServerEntry) Option

+ func WithMCPWorkDir(dir string) Option

+ func WithMaxSteps(n int) Option

+ func WithProvider(p llm.ProviderEntry) Option

+ func WithProviders(ps ...llm.ProviderEntry) Option

+ func WithTools(ts ...tools.Tool) Option

+ func WithoutAutoFinish() Option

+ type RunBuilder struct

+ func (b *RunBuilder) Ask(message string) (*orchestration.ExecutionResult, error)

+ func (b *RunBuilder) Events(e agent.Events) *RunBuilder

+ func (b *RunBuilder) System(prompt string) *RunBuilder

+ func (b *RunBuilder) SystemFactory(fn orchestration.SystemPromptFactory) *RunBuilder

+ type TaskBuilder struct

+ func (b *TaskBuilder) Compaction(strategy string) *TaskBuilder

+ func (b *TaskBuilder) Events(e orchestration.Events) *TaskBuilder

+ func (b *TaskBuilder) Execute() (*orchestration.ExecutionResult, error)

+ func (b *TaskBuilder) MaxRetries(n int) *TaskBuilder

+ func (b *TaskBuilder) Models(planModel, execModel string) *TaskBuilder

+ func (b *TaskBuilder) Plan() *TaskBuilder

+ func (b *TaskBuilder) Planner(p *planner.Planner) *TaskBuilder

+ func (b *TaskBuilder) Reflect() *TaskBuilder

+ func (b *TaskBuilder) Reflector(r *reflector.Reflector) *TaskBuilder

+ func (b *TaskBuilder) Skills(s []skills.SkillDescriptor) *TaskBuilder

+ func (b *TaskBuilder) System(prompt string) *TaskBuilder

+ func (b *TaskBuilder) SystemFactory(fn orchestration.SystemPromptFactory) *TaskBuilder

+ func (b *TaskBuilder) Workspace(dir string) *TaskBuilder