1package config
  2
  3import (
  4	"cmp"
  5	"context"
  6	"errors"
  7	"fmt"
  8	"maps"
  9	"net/http"
 10	"net/url"
 11	"slices"
 12	"strings"
 13	"time"
 14
 15	"charm.land/catwalk/pkg/catwalk"
 16	"github.com/charmbracelet/crush/internal/csync"
 17	"github.com/charmbracelet/crush/internal/oauth"
 18	"github.com/charmbracelet/crush/internal/oauth/copilot"
 19	"github.com/invopop/jsonschema"
 20)
 21
 22const (
 23	appName              = "crush"
 24	defaultDataDirectory = ".crush"
 25	defaultInitializeAs  = "AGENTS.md"
 26)
 27
 28var defaultContextPaths = []string{
 29	".github/copilot-instructions.md",
 30	".cursorrules",
 31	".cursor/rules/",
 32	"CLAUDE.md",
 33	"CLAUDE.local.md",
 34	"GEMINI.md",
 35	"gemini.md",
 36	"crush.md",
 37	"crush.local.md",
 38	"Crush.md",
 39	"Crush.local.md",
 40	"CRUSH.md",
 41	"CRUSH.local.md",
 42	"AGENTS.md",
 43	"agents.md",
 44	"Agents.md",
 45}
 46
 47type SelectedModelType string
 48
 49// String returns the string representation of the [SelectedModelType].
 50func (s SelectedModelType) String() string {
 51	return string(s)
 52}
 53
 54const (
 55	SelectedModelTypeLarge SelectedModelType = "large"
 56	SelectedModelTypeSmall SelectedModelType = "small"
 57)
 58
 59const (
 60	AgentCoder string = "coder"
 61	AgentTask  string = "task"
 62)
 63
 64type SelectedModel struct {
 65	// The model id as used by the provider API.
 66	// Required.
 67	Model string `json:"model" jsonschema:"required,description=The model ID as used by the provider API,example=gpt-4o"`
 68	// The model provider, same as the key/id used in the providers config.
 69	// Required.
 70	Provider string `json:"provider" jsonschema:"required,description=The model provider ID that matches a key in the providers config,example=openai"`
 71
 72	// Only used by models that use the openai provider and need this set.
 73	ReasoningEffort string `json:"reasoning_effort,omitempty" jsonschema:"description=Reasoning effort level for OpenAI models that support it,enum=low,enum=medium,enum=high"`
 74
 75	// Used by anthropic models that can reason to indicate if the model should think.
 76	Think bool `json:"think,omitempty" jsonschema:"description=Enable thinking mode for Anthropic models that support reasoning"`
 77
 78	// Overrides the default model configuration.
 79	MaxTokens        int64    `json:"max_tokens,omitempty" jsonschema:"description=Maximum number of tokens for model responses,maximum=200000,example=4096"`
 80	Temperature      *float64 `json:"temperature,omitempty" jsonschema:"description=Sampling temperature,minimum=0,maximum=1,example=0.7"`
 81	TopP             *float64 `json:"top_p,omitempty" jsonschema:"description=Top-p (nucleus) sampling parameter,minimum=0,maximum=1,example=0.9"`
 82	TopK             *int64   `json:"top_k,omitempty" jsonschema:"description=Top-k sampling parameter"`
 83	FrequencyPenalty *float64 `json:"frequency_penalty,omitempty" jsonschema:"description=Frequency penalty to reduce repetition"`
 84	PresencePenalty  *float64 `json:"presence_penalty,omitempty" jsonschema:"description=Presence penalty to increase topic diversity"`
 85
 86	// Override provider specific options.
 87	ProviderOptions map[string]any `json:"provider_options,omitempty" jsonschema:"description=Additional provider-specific options for the model"`
 88}
 89
 90type ProviderConfig struct {
 91	// The provider's id.
 92	ID string `json:"id,omitempty" jsonschema:"description=Unique identifier for the provider,example=openai"`
 93	// The provider's name, used for display purposes.
 94	Name string `json:"name,omitempty" jsonschema:"description=Human-readable name for the provider,example=OpenAI"`
 95	// The provider's API endpoint.
 96	BaseURL string `json:"base_url,omitempty" jsonschema:"description=Base URL for the provider's API,format=uri,example=https://api.openai.com/v1"`
 97	// The provider type, e.g. "openai", "anthropic", etc. if empty it defaults to openai.
 98	Type catwalk.Type `json:"type,omitempty" jsonschema:"description=Provider type that determines the API format,enum=openai,enum=openai-compat,enum=anthropic,enum=gemini,enum=azure,enum=vertexai,default=openai"`
 99	// The provider's API key.
100	APIKey string `json:"api_key,omitempty" jsonschema:"description=API key for authentication with the provider,example=$OPENAI_API_KEY"`
101	// The original API key template before resolution (for re-resolution on auth errors).
102	APIKeyTemplate string `json:"-"`
103	// OAuthToken for providers that use OAuth2 authentication.
104	OAuthToken *oauth.Token `json:"oauth,omitempty" jsonschema:"description=OAuth2 token for authentication with the provider"`
105	// Marks the provider as disabled.
106	Disable bool `json:"disable,omitempty" jsonschema:"description=Whether this provider is disabled,default=false"`
107
108	// Custom system prompt prefix.
109	SystemPromptPrefix string `json:"system_prompt_prefix,omitempty" jsonschema:"description=Custom prefix to add to system prompts for this provider"`
110
111	// Extra headers to send with each request to the provider. Values
112	// run through shell expansion at config-load time, so $VAR and
113	// $(cmd) work the same way they do in MCP headers. A header whose
114	// value resolves to the empty string (unset bare $VAR under
115	// lenient nounset, $(echo), or literal "") is omitted from the
116	// outgoing request rather than sent as "Header:". See PLAN.md
117	// Phase 2 design decision #18.
118	ExtraHeaders map[string]string `json:"extra_headers,omitempty" jsonschema:"description=Additional HTTP headers to send with requests"`
119	// ExtraBody is merged verbatim into OpenAI-compatible request
120	// bodies. String values are NOT shell-expanded: this is a plain
121	// JSON passthrough so that arbitrary provider-extension fields
122	// (numbers, nested objects, booleans) round-trip without a
123	// recursive walker guessing at intent. If you need an env-var-
124	// driven value at request time, put it in extra_headers, or in
125	// the provider's top-level api_key / base_url, all of which do
126	// expand. See PLAN.md Phase 2 design decision #16.
127	ExtraBody map[string]any `json:"extra_body,omitempty" jsonschema:"description=Additional fields to include in request bodies\\, only works with openai-compatible providers"`
128
129	ProviderOptions map[string]any `json:"provider_options,omitempty" jsonschema:"description=Additional provider-specific options for this provider"`
130
131	// Used to pass extra parameters to the provider.
132	ExtraParams map[string]string `json:"-"`
133
134	// Skip cost accumulation for this provider when using subscription or flat rate billing.
135	FlatRate bool `json:"flat_rate,omitempty" jsonschema:"description=Flat-rate mode for this provider"`
136
137	// The provider models
138	Models []catwalk.Model `json:"models,omitempty" jsonschema:"description=List of models available from this provider"`
139}
140
141// ToProvider converts the [ProviderConfig] to a [catwalk.Provider].
142func (c *ProviderConfig) ToProvider() catwalk.Provider {
143	// Convert config provider to provider.Provider format
144	provider := catwalk.Provider{
145		Name:   c.Name,
146		ID:     catwalk.InferenceProvider(c.ID),
147		Models: make([]catwalk.Model, len(c.Models)),
148	}
149
150	// Convert models
151	for i, model := range c.Models {
152		provider.Models[i] = catwalk.Model{
153			ID:                     model.ID,
154			Name:                   model.Name,
155			CostPer1MIn:            model.CostPer1MIn,
156			CostPer1MOut:           model.CostPer1MOut,
157			CostPer1MInCached:      model.CostPer1MInCached,
158			CostPer1MOutCached:     model.CostPer1MOutCached,
159			ContextWindow:          model.ContextWindow,
160			DefaultMaxTokens:       model.DefaultMaxTokens,
161			CanReason:              model.CanReason,
162			ReasoningLevels:        model.ReasoningLevels,
163			DefaultReasoningEffort: model.DefaultReasoningEffort,
164			SupportsImages:         model.SupportsImages,
165		}
166	}
167
168	return provider
169}
170
171func (c *ProviderConfig) SetupGitHubCopilot() {
172	maps.Copy(c.ExtraHeaders, copilot.Headers())
173}
174
175type MCPType string
176
177const (
178	MCPStdio MCPType = "stdio"
179	MCPSSE   MCPType = "sse"
180	MCPHttp  MCPType = "http"
181)
182
183type MCPConfig struct {
184	Command       string            `json:"command,omitempty" jsonschema:"description=Command to execute for stdio MCP servers,example=npx"`
185	Env           map[string]string `json:"env,omitempty" jsonschema:"description=Environment variables to set for the MCP server"`
186	Args          []string          `json:"args,omitempty" jsonschema:"description=Arguments to pass to the MCP server command"`
187	Type          MCPType           `json:"type" jsonschema:"required,description=Type of MCP connection,enum=stdio,enum=sse,enum=http,default=stdio"`
188	URL           string            `json:"url,omitempty" jsonschema:"description=URL for HTTP or SSE MCP servers,format=uri,example=http://localhost:3000/mcp"`
189	Disabled      bool              `json:"disabled,omitempty" jsonschema:"description=Whether this MCP server is disabled,default=false"`
190	DisabledTools []string          `json:"disabled_tools,omitempty" jsonschema:"description=List of tools from this MCP server to disable,example=get-library-doc"`
191	EnabledTools  []string          `json:"enabled_tools,omitempty" jsonschema:"description=Allow list of tools from this MCP server,example=get-library-doc"`
192	Timeout       int               `json:"timeout,omitempty" jsonschema:"description=Timeout in seconds for MCP server connections,default=15,example=30,example=60,example=120"`
193
194	// Headers are HTTP headers for HTTP/SSE MCP servers. Values run
195	// through shell expansion at MCP startup, so $VAR and $(cmd)
196	// work. A header whose value resolves to the empty string (unset
197	// bare $VAR under lenient nounset, $(echo), or literal "") is
198	// omitted from the outgoing request rather than sent as
199	// "Header:". See PLAN.md Phase 2 design decision #18.
200	Headers map[string]string `json:"headers,omitempty" jsonschema:"description=HTTP headers for HTTP/SSE MCP servers"`
201}
202
203type LSPConfig struct {
204	Disabled    bool              `json:"disabled,omitempty" jsonschema:"description=Whether this LSP server is disabled,default=false"`
205	Command     string            `json:"command,omitempty" jsonschema:"description=Command to execute for the LSP server,example=gopls"`
206	Args        []string          `json:"args,omitempty" jsonschema:"description=Arguments to pass to the LSP server command"`
207	Env         map[string]string `json:"env,omitempty" jsonschema:"description=Environment variables to set to the LSP server command"`
208	FileTypes   []string          `json:"filetypes,omitempty" jsonschema:"description=File types this LSP server handles,example=go,example=mod,example=rs,example=c,example=js,example=ts"`
209	RootMarkers []string          `json:"root_markers,omitempty" jsonschema:"description=Files or directories that indicate the project root,example=go.mod,example=package.json,example=Cargo.toml"`
210	InitOptions map[string]any    `json:"init_options,omitempty" jsonschema:"description=Initialization options passed to the LSP server during initialize request"`
211	Options     map[string]any    `json:"options,omitempty" jsonschema:"description=LSP server-specific settings passed during initialization"`
212	Timeout     int               `json:"timeout,omitempty" jsonschema:"description=Timeout in seconds for LSP server initialization,default=30,example=60,example=120"`
213}
214
215type TUIOptions struct {
216	CompactMode bool   `json:"compact_mode,omitempty" jsonschema:"description=Enable compact mode for the TUI interface,default=false"`
217	DiffMode    string `json:"diff_mode,omitempty" jsonschema:"description=Diff mode for the TUI interface,enum=unified,enum=split"`
218	// Here we can add themes later or any TUI related options
219	//
220
221	Completions Completions `json:"completions,omitzero" jsonschema:"description=Completions UI options"`
222	Transparent *bool       `json:"transparent,omitempty" jsonschema:"description=Enable transparent background for the TUI interface,default=false"`
223}
224
225// Completions defines options for the completions UI.
226type Completions struct {
227	MaxDepth *int `json:"max_depth,omitempty" jsonschema:"description=Maximum depth for the ls tool,default=0,example=10"`
228	MaxItems *int `json:"max_items,omitempty" jsonschema:"description=Maximum number of items to return for the ls tool,default=1000,example=100"`
229}
230
231func (c Completions) Limits() (depth, items int) {
232	return ptrValOr(c.MaxDepth, 0), ptrValOr(c.MaxItems, 0)
233}
234
235type Permissions struct {
236	AllowedTools []string `json:"allowed_tools,omitempty" jsonschema:"description=List of tools that don't require permission prompts,example=bash,example=view"`
237}
238
239type TrailerStyle string
240
241const (
242	TrailerStyleNone         TrailerStyle = "none"
243	TrailerStyleCoAuthoredBy TrailerStyle = "co-authored-by"
244	TrailerStyleAssistedBy   TrailerStyle = "assisted-by"
245)
246
247type Attribution struct {
248	TrailerStyle  TrailerStyle `json:"trailer_style,omitempty" jsonschema:"description=Style of attribution trailer to add to commits,enum=none,enum=co-authored-by,enum=assisted-by,default=assisted-by"`
249	CoAuthoredBy  *bool        `json:"co_authored_by,omitempty" jsonschema:"description=Deprecated: use trailer_style instead"`
250	GeneratedWith bool         `json:"generated_with,omitempty" jsonschema:"description=Add Generated with Crush line to commit messages and issues and PRs,default=true"`
251}
252
253// JSONSchemaExtend marks the co_authored_by field as deprecated in the schema.
254func (Attribution) JSONSchemaExtend(schema *jsonschema.Schema) {
255	if schema.Properties != nil {
256		if prop, ok := schema.Properties.Get("co_authored_by"); ok {
257			prop.Deprecated = true
258		}
259	}
260}
261
262type Options struct {
263	ContextPaths         []string    `json:"context_paths,omitempty" jsonschema:"description=Paths to files containing context information for the AI,example=.cursorrules,example=CRUSH.md"`
264	SkillsPaths          []string    `json:"skills_paths,omitempty" jsonschema:"description=Paths to directories containing Agent Skills (folders with SKILL.md files),example=~/.config/crush/skills,example=./skills"`
265	TUI                  *TUIOptions `json:"tui,omitempty" jsonschema:"description=Terminal user interface options"`
266	Debug                bool        `json:"debug,omitempty" jsonschema:"description=Enable debug logging,default=false"`
267	DebugLSP             bool        `json:"debug_lsp,omitempty" jsonschema:"description=Enable debug logging for LSP servers,default=false"`
268	DisableAutoSummarize bool        `json:"disable_auto_summarize,omitempty" jsonschema:"description=Disable automatic conversation summarization,default=false"`
269	// DataDirectory is where Crush keeps per-project state such as
270	// the SQLite database and workspace overrides. Relative paths are
271	// resolved against the working directory; absolute paths are used
272	// verbatim. After defaulting the stored value is always absolute.
273	DataDirectory             string       `json:"data_directory,omitempty" jsonschema:"description=Directory for storing application data. Relative paths are resolved against the working directory; absolute paths are used as-is.,default=.crush,example=.crush"`
274	DisabledTools             []string     `json:"disabled_tools,omitempty" jsonschema:"description=List of built-in tools to disable and hide from the agent,example=bash,example=sourcegraph"`
275	DisableProviderAutoUpdate bool         `json:"disable_provider_auto_update,omitempty" jsonschema:"description=Disable providers auto-update,default=false"`
276	DisableDefaultProviders   bool         `json:"disable_default_providers,omitempty" jsonschema:"description=Ignore all default/embedded providers. When enabled\\, providers must be fully specified in the config file with base_url\\, models\\, and api_key - no merging with defaults occurs,default=false"`
277	Attribution               *Attribution `json:"attribution,omitempty" jsonschema:"description=Attribution settings for generated content"`
278	DisableMetrics            bool         `json:"disable_metrics,omitempty" jsonschema:"description=Disable sending metrics,default=false"`
279	InitializeAs              string       `json:"initialize_as,omitempty" jsonschema:"description=Name of the context file to create/update during project initialization,default=AGENTS.md,example=AGENTS.md,example=CRUSH.md,example=CLAUDE.md,example=docs/LLMs.md"`
280	AutoLSP                   *bool        `json:"auto_lsp,omitempty" jsonschema:"description=Automatically setup LSPs based on root markers,default=true"`
281	Progress                  *bool        `json:"progress,omitempty" jsonschema:"description=Show indeterminate progress updates during long operations,default=true"`
282	DisableNotifications      bool         `json:"disable_notifications,omitempty" jsonschema:"description=Disable desktop notifications,default=false"`
283	DisabledSkills            []string     `json:"disabled_skills,omitempty" jsonschema:"description=List of skill names to disable and hide from the agent,example=crush-config"`
284}
285
286type MCPs map[string]MCPConfig
287
288type MCP struct {
289	Name string    `json:"name"`
290	MCP  MCPConfig `json:"mcp"`
291}
292
293func (m MCPs) Sorted() []MCP {
294	sorted := make([]MCP, 0, len(m))
295	for k, v := range m {
296		sorted = append(sorted, MCP{
297			Name: k,
298			MCP:  v,
299		})
300	}
301	slices.SortFunc(sorted, func(a, b MCP) int {
302		return strings.Compare(a.Name, b.Name)
303	})
304	return sorted
305}
306
307type LSPs map[string]LSPConfig
308
309type LSP struct {
310	Name string    `json:"name"`
311	LSP  LSPConfig `json:"lsp"`
312}
313
314func (l LSPs) Sorted() []LSP {
315	sorted := make([]LSP, 0, len(l))
316	for k, v := range l {
317		sorted = append(sorted, LSP{
318			Name: k,
319			LSP:  v,
320		})
321	}
322	slices.SortFunc(sorted, func(a, b LSP) int {
323		return strings.Compare(a.Name, b.Name)
324	})
325	return sorted
326}
327
328// ResolvedEnv returns m.Env with every value expanded through the
329// given resolver. The returned slice is of the form "KEY=value" sorted
330// by key so callers get deterministic output; the receiver's Env map is
331// not mutated. On the first resolution failure it returns nil and an
332// error that identifies the offending key; the inner resolver error is
333// already sanitized by ResolveValue and is wrapped with %w so
334// errors.Is/As continues to work. Callers are expected to surface it
335// (for MCP, via StateError on the status card) rather than silently
336// spawn the server with an empty credential.
337//
338// The resolver choice matters: in server mode pass the shell resolver
339// so $VAR / $(cmd) expand; in client mode pass IdentityResolver so the
340// template is forwarded verbatim and expansion happens on the server.
341func (m MCPConfig) ResolvedEnv(r VariableResolver) ([]string, error) {
342	return resolveEnvs(m.Env, r)
343}
344
345// ResolvedArgs returns m.Args with every element expanded through the
346// given resolver. A fresh slice is allocated; m.Args is never mutated.
347// On the first resolution failure it returns nil and an error
348// identifying the offending positional index; the inner resolver error
349// is already sanitized by ResolveValue and is wrapped with %w so
350// errors.Is/As continues to work.
351//
352// See ResolvedEnv for guidance on picking a resolver.
353func (m MCPConfig) ResolvedArgs(r VariableResolver) ([]string, error) {
354	if len(m.Args) == 0 {
355		return nil, nil
356	}
357	out := make([]string, len(m.Args))
358	for i, a := range m.Args {
359		v, err := r.ResolveValue(a)
360		if err != nil {
361			return nil, fmt.Errorf("arg %d: %w", i, err)
362		}
363		out[i] = v
364	}
365	return out, nil
366}
367
368// ResolvedURL returns m.URL expanded through the given resolver. The
369// receiver is not mutated. Errors from the resolver are already
370// sanitized by ResolveValue and are wrapped with %w for errors.Is/As.
371//
372// URLs run through the same shell-expansion pipeline as the other
373// fields, so a literal '$' (e.g. OData query strings containing
374// $filter/$select) must be escaped as '\$' or '${DOLLAR:-$}' to avoid
375// being interpreted as a variable reference. Same constraint already
376// applies to command, args, env, and headers.
377//
378// See ResolvedEnv for guidance on picking a resolver.
379func (m MCPConfig) ResolvedURL(r VariableResolver) (string, error) {
380	if m.URL == "" {
381		return "", nil
382	}
383	v, err := r.ResolveValue(m.URL)
384	if err != nil {
385		return "", fmt.Errorf("url: %w", err)
386	}
387	return v, nil
388}
389
390// ResolvedHeaders returns m.Headers with every value expanded through
391// the given resolver. A fresh map is allocated; m.Headers is never
392// mutated. On the first resolution failure it returns nil and an error
393// identifying the offending header name; the inner resolver error is
394// already sanitized by ResolveValue and is wrapped with %w so
395// errors.Is/As continues to work.
396//
397// A header whose value resolves to the empty string (unset bare $VAR
398// under lenient nounset, $(echo), or literal "") is omitted from the
399// returned map — sending "X-Auth:" with an empty value is rejected by
400// some providers and the user's intent in "optional, env-gated
401// header" is clearly "absent when the var isn't set." See PLAN.md
402// Phase 2 design decision #18.
403//
404// See ResolvedEnv for guidance on picking a resolver.
405func (m MCPConfig) ResolvedHeaders(r VariableResolver) (map[string]string, error) {
406	if len(m.Headers) == 0 {
407		return map[string]string{}, nil
408	}
409	out := make(map[string]string, len(m.Headers))
410	// Sort keys so failures are reported deterministically when more
411	// than one header would fail.
412	keys := make([]string, 0, len(m.Headers))
413	for k := range m.Headers {
414		keys = append(keys, k)
415	}
416	slices.Sort(keys)
417	for _, k := range keys {
418		v, err := r.ResolveValue(m.Headers[k])
419		if err != nil {
420			return nil, fmt.Errorf("header %s: %w", k, err)
421		}
422		if v == "" {
423			continue
424		}
425		out[k] = v
426	}
427	return out, nil
428}
429
430// ResolvedArgs returns l.Args with every element expanded through the
431// given resolver. A fresh slice is allocated; l.Args is never mutated.
432// On the first resolution failure it returns nil and an error
433// identifying the offending positional index; the inner resolver error
434// is already sanitized by ResolveValue and is wrapped with %w so
435// errors.Is/As continues to work.
436//
437// Empty resolved values are kept (a deliberate "empty positional arg"
438// like --flag "" is sometimes valid), matching MCPConfig.ResolvedArgs;
439// see PLAN.md Phase 2 design decision #18.
440//
441// The resolver choice matters: in server mode pass the shell resolver
442// so $VAR / $(cmd) expand; in client mode pass IdentityResolver so the
443// template is forwarded verbatim. See PLAN.md Phase 2 design decision
444// #13.
445func (l LSPConfig) ResolvedArgs(r VariableResolver) ([]string, error) {
446	if len(l.Args) == 0 {
447		return nil, nil
448	}
449	out := make([]string, len(l.Args))
450	for i, a := range l.Args {
451		v, err := r.ResolveValue(a)
452		if err != nil {
453			return nil, fmt.Errorf("arg %d: %w", i, err)
454		}
455		out[i] = v
456	}
457	return out, nil
458}
459
460// ResolvedEnv returns l.Env with every value expanded through the
461// given resolver. A fresh map is allocated; l.Env is never mutated.
462// On the first resolution failure it returns nil and an error that
463// identifies the offending key; the inner resolver error is already
464// sanitized by ResolveValue and is wrapped with %w so errors.Is/As
465// continues to work.
466//
467// Empty resolved values are kept ("FOO=" is a legitimate request;
468// opt out via ${VAR:+...}), matching MCPConfig.ResolvedEnv; see
469// PLAN.md Phase 2 design decision #18.
470//
471// Shape note: this returns map[string]string rather than the []string
472// shape MCPConfig.ResolvedEnv uses because the consumer
473// (powernap.ClientConfig.Environment in internal/lsp/client.go) takes
474// a map directly — returning a []string here would only force a
475// round-trip back to a map at the call site. See PLAN.md Phase 2
476// design decision #13.
477//
478// See ResolvedArgs for guidance on picking a resolver.
479func (l LSPConfig) ResolvedEnv(r VariableResolver) (map[string]string, error) {
480	if len(l.Env) == 0 {
481		return map[string]string{}, nil
482	}
483	out := make(map[string]string, len(l.Env))
484	// Sort keys so failures are reported deterministically when more
485	// than one value would fail.
486	keys := make([]string, 0, len(l.Env))
487	for k := range l.Env {
488		keys = append(keys, k)
489	}
490	slices.Sort(keys)
491	for _, k := range keys {
492		v, err := r.ResolveValue(l.Env[k])
493		if err != nil {
494			return nil, fmt.Errorf("env %q: %w", k, err)
495		}
496		out[k] = v
497	}
498	return out, nil
499}
500
501type Agent struct {
502	ID          string `json:"id,omitempty"`
503	Name        string `json:"name,omitempty"`
504	Description string `json:"description,omitempty"`
505	// This is the id of the system prompt used by the agent
506	Disabled bool `json:"disabled,omitempty"`
507
508	Model SelectedModelType `json:"model" jsonschema:"required,description=The model type to use for this agent,enum=large,enum=small,default=large"`
509
510	// The available tools for the agent
511	//  if this is nil, all tools are available
512	AllowedTools []string `json:"allowed_tools,omitempty"`
513
514	// this tells us which MCPs are available for this agent
515	//  if this is empty all mcps are available
516	//  the string array is the list of tools from the AllowedMCP the agent has available
517	//  if the string array is nil, all tools from the AllowedMCP are available
518	AllowedMCP map[string][]string `json:"allowed_mcp,omitempty"`
519
520	// Overrides the context paths for this agent
521	ContextPaths []string `json:"context_paths,omitempty"`
522}
523
524type Tools struct {
525	Ls   ToolLs   `json:"ls,omitzero"`
526	Grep ToolGrep `json:"grep,omitzero"`
527}
528
529type ToolLs struct {
530	MaxDepth *int `json:"max_depth,omitempty" jsonschema:"description=Maximum depth for the ls tool,default=0,example=10"`
531	MaxItems *int `json:"max_items,omitempty" jsonschema:"description=Maximum number of items to return for the ls tool,default=1000,example=100"`
532}
533
534// Limits returns the user-defined max-depth and max-items, or their defaults.
535func (t ToolLs) Limits() (depth, items int) {
536	return ptrValOr(t.MaxDepth, 0), ptrValOr(t.MaxItems, 0)
537}
538
539type ToolGrep struct {
540	Timeout *time.Duration `json:"timeout,omitempty" jsonschema:"description=Timeout for the grep tool call,default=5s,example=10s"`
541}
542
543// GetTimeout returns the user-defined timeout or the default.
544func (t ToolGrep) GetTimeout() time.Duration {
545	return ptrValOr(t.Timeout, 5*time.Second)
546}
547
548// HookConfig defines a user-configured shell command that fires on a hook
549// event (e.g. PreToolUse). This is a pure-data struct: matcher compilation
550// is owned by hooks.Runner so a JSON round-trip, merge, or reload can't
551// silently drop compiled state.
552type HookConfig struct {
553	// Regex pattern tested against the tool name. Empty means match all.
554	Matcher string `json:"matcher,omitempty" jsonschema:"description=Regex pattern tested against the tool name. Empty means match all tools."`
555	// Shell command to execute.
556	Command string `json:"command" jsonschema:"required,description=Shell command to execute when the hook fires"`
557	// Timeout in seconds. Default 30.
558	Timeout int `json:"timeout,omitempty" jsonschema:"description=Timeout in seconds for the hook command,default=30"`
559}
560
561// TimeoutDuration returns the hook timeout as a time.Duration, defaulting
562// to 30s.
563func (h *HookConfig) TimeoutDuration() time.Duration {
564	if h.Timeout <= 0 {
565		return 30 * time.Second
566	}
567	return time.Duration(h.Timeout) * time.Second
568}
569
570// Config holds the configuration for crush.
571type Config struct {
572	Schema string `json:"$schema,omitempty"`
573
574	// We currently only support large/small as values here.
575	Models map[SelectedModelType]SelectedModel `json:"models,omitempty" jsonschema:"description=Model configurations for different model types,example={\"large\":{\"model\":\"gpt-4o\",\"provider\":\"openai\"}}"`
576
577	// Recently used models stored in the data directory config.
578	RecentModels map[SelectedModelType][]SelectedModel `json:"recent_models,omitempty" jsonschema:"-"`
579
580	// The providers that are configured
581	Providers *csync.Map[string, ProviderConfig] `json:"providers,omitempty" jsonschema:"description=AI provider configurations"`
582
583	MCP MCPs `json:"mcp,omitempty" jsonschema:"description=Model Context Protocol server configurations"`
584
585	LSP LSPs `json:"lsp,omitempty" jsonschema:"description=Language Server Protocol configurations"`
586
587	Options *Options `json:"options,omitempty" jsonschema:"description=General application options"`
588
589	Permissions *Permissions `json:"permissions,omitempty" jsonschema:"description=Permission settings for tool usage"`
590
591	Tools Tools `json:"tools,omitzero" jsonschema:"description=Tool configurations"`
592
593	Hooks map[string][]HookConfig `json:"hooks,omitempty" jsonschema:"description=User-defined shell commands that fire on hook events (e.g. PreToolUse)"`
594
595	Agents map[string]Agent `json:"-"`
596}
597
598func (c *Config) EnabledProviders() []ProviderConfig {
599	var enabled []ProviderConfig
600	for p := range c.Providers.Seq() {
601		if !p.Disable {
602			enabled = append(enabled, p)
603		}
604	}
605	return enabled
606}
607
608// IsConfigured  return true if at least one provider is configured
609func (c *Config) IsConfigured() bool {
610	return len(c.EnabledProviders()) > 0
611}
612
613func (c *Config) GetModel(provider, model string) *catwalk.Model {
614	if providerConfig, ok := c.Providers.Get(provider); ok {
615		for _, m := range providerConfig.Models {
616			if m.ID == model {
617				return &m
618			}
619		}
620	}
621	return nil
622}
623
624func (c *Config) GetProviderForModel(modelType SelectedModelType) *ProviderConfig {
625	model, ok := c.Models[modelType]
626	if !ok {
627		return nil
628	}
629	if providerConfig, ok := c.Providers.Get(model.Provider); ok {
630		return &providerConfig
631	}
632	return nil
633}
634
635func (c *Config) GetModelByType(modelType SelectedModelType) *catwalk.Model {
636	model, ok := c.Models[modelType]
637	if !ok {
638		return nil
639	}
640	return c.GetModel(model.Provider, model.Model)
641}
642
643func (c *Config) LargeModel() *catwalk.Model {
644	model, ok := c.Models[SelectedModelTypeLarge]
645	if !ok {
646		return nil
647	}
648	return c.GetModel(model.Provider, model.Model)
649}
650
651func (c *Config) SmallModel() *catwalk.Model {
652	model, ok := c.Models[SelectedModelTypeSmall]
653	if !ok {
654		return nil
655	}
656	return c.GetModel(model.Provider, model.Model)
657}
658
659const maxRecentModelsPerType = 5
660
661func allToolNames() []string {
662	return []string{
663		"agent",
664		"bash",
665		"crush_info",
666		"crush_logs",
667		"job_output",
668		"job_kill",
669		"download",
670		"edit",
671		"multiedit",
672		"lsp_diagnostics",
673		"lsp_references",
674		"lsp_restart",
675		"fetch",
676		"agentic_fetch",
677		"glob",
678		"grep",
679		"ls",
680		"sourcegraph",
681		"todos",
682		"view",
683		"write",
684		"list_mcp_resources",
685		"read_mcp_resource",
686	}
687}
688
689func resolveAllowedTools(allTools []string, disabledTools []string) []string {
690	if disabledTools == nil {
691		return allTools
692	}
693	// filter out disabled tools (exclude mode)
694	return filterSlice(allTools, disabledTools, false)
695}
696
697func resolveReadOnlyTools(tools []string) []string {
698	readOnlyTools := []string{"glob", "grep", "ls", "sourcegraph", "view"}
699	// filter to only include tools that are in allowedtools (include mode)
700	return filterSlice(tools, readOnlyTools, true)
701}
702
703func filterSlice(data []string, mask []string, include bool) []string {
704	var filtered []string
705	for _, s := range data {
706		// if include is true, we include items that ARE in the mask
707		// if include is false, we include items that are NOT in the mask
708		if include == slices.Contains(mask, s) {
709			filtered = append(filtered, s)
710		}
711	}
712	return filtered
713}
714
715func (c *Config) SetupAgents() {
716	allowedTools := resolveAllowedTools(allToolNames(), c.Options.DisabledTools)
717
718	agents := map[string]Agent{
719		AgentCoder: {
720			ID:           AgentCoder,
721			Name:         "Coder",
722			Description:  "An agent that helps with executing coding tasks.",
723			Model:        SelectedModelTypeLarge,
724			ContextPaths: c.Options.ContextPaths,
725			AllowedTools: allowedTools,
726		},
727
728		AgentTask: {
729			ID:           AgentTask,
730			Name:         "Task",
731			Description:  "An agent that helps with searching for context and finding implementation details.",
732			Model:        SelectedModelTypeLarge,
733			ContextPaths: c.Options.ContextPaths,
734			AllowedTools: resolveReadOnlyTools(allowedTools),
735			// NO MCPs or LSPs by default
736			AllowedMCP: map[string][]string{},
737		},
738	}
739	c.Agents = agents
740}
741
742func (c *ProviderConfig) TestConnection(resolver VariableResolver) error {
743	var (
744		providerID = catwalk.InferenceProvider(c.ID)
745		testURL    = ""
746		headers    = make(map[string]string)
747		apiKey, _  = resolver.ResolveValue(c.APIKey)
748	)
749
750	switch providerID {
751	case catwalk.InferenceProviderMiniMax, catwalk.InferenceProviderMiniMaxChina:
752		// NOTE: MiniMax has no good endpoint we can use to validate the API key.
753		return nil
754	}
755
756	switch c.Type {
757	case catwalk.TypeOpenAI, catwalk.TypeOpenAICompat, catwalk.TypeOpenRouter:
758		baseURL, _ := resolver.ResolveValue(c.BaseURL)
759		baseURL = cmp.Or(baseURL, "https://api.openai.com/v1")
760
761		switch providerID {
762		case catwalk.InferenceProviderOpenRouter:
763			testURL = baseURL + "/credits"
764		case catwalk.InferenceProviderOpenCodeGo:
765			testURL = strings.Replace(baseURL, "/go", "", 1) + "/models"
766		default:
767			testURL = baseURL + "/models"
768		}
769
770		headers["Authorization"] = "Bearer " + apiKey
771	case catwalk.TypeAnthropic:
772		baseURL, _ := resolver.ResolveValue(c.BaseURL)
773		baseURL = cmp.Or(baseURL, "https://api.anthropic.com/v1")
774
775		switch providerID {
776		case catwalk.InferenceKimiCoding:
777			testURL = baseURL + "/v1/models"
778		default:
779			testURL = baseURL + "/models"
780		}
781
782		headers["x-api-key"] = apiKey
783		headers["anthropic-version"] = "2023-06-01"
784	case catwalk.TypeGoogle:
785		baseURL, _ := resolver.ResolveValue(c.BaseURL)
786		baseURL = cmp.Or(baseURL, "https://generativelanguage.googleapis.com")
787		testURL = baseURL + "/v1beta/models?key=" + url.QueryEscape(apiKey)
788	case catwalk.TypeBedrock:
789		// NOTE: Bedrock has a `/foundation-models` endpoint that we could in
790		// theory use, but apparently the authorization is region-specific,
791		// so it's not so trivial.
792		if strings.HasPrefix(apiKey, "ABSK") { // Bedrock API keys
793			return nil
794		}
795		return errors.New("not a valid bedrock api key")
796	case catwalk.TypeVercel:
797		// NOTE: Vercel does not validate API keys on the `/models` endpoint.
798		if strings.HasPrefix(apiKey, "vck_") { // Vercel API keys
799			return nil
800		}
801		return errors.New("not a valid vercel api key")
802	}
803
804	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
805	defer cancel()
806
807	client := &http.Client{}
808	req, err := http.NewRequestWithContext(ctx, "GET", testURL, nil)
809	if err != nil {
810		return fmt.Errorf("failed to create request for provider %s: %w", c.ID, err)
811	}
812	for k, v := range headers {
813		req.Header.Set(k, v)
814	}
815	for k, v := range c.ExtraHeaders {
816		req.Header.Set(k, v)
817	}
818
819	resp, err := client.Do(req)
820	if err != nil {
821		return fmt.Errorf("failed to create request for provider %s: %w", c.ID, err)
822	}
823	defer resp.Body.Close()
824
825	switch providerID {
826	case catwalk.InferenceProviderZAI:
827		if resp.StatusCode == http.StatusUnauthorized {
828			return fmt.Errorf("failed to connect to provider %s: %s", c.ID, resp.Status)
829		}
830	default:
831		if resp.StatusCode != http.StatusOK {
832			return fmt.Errorf("failed to connect to provider %s: %s", c.ID, resp.Status)
833		}
834	}
835	return nil
836}
837
838// resolveEnvs expands every value in envs through the given resolver
839// and returns a fresh "KEY=value" slice sorted by key. The input map is
840// not mutated. On the first resolution failure it returns nil and an
841// error identifying the offending variable; the inner resolver error is
842// already sanitized by ResolveValue and is wrapped with %w.
843func resolveEnvs(envs map[string]string, r VariableResolver) ([]string, error) {
844	if len(envs) == 0 {
845		return nil, nil
846	}
847	keys := make([]string, 0, len(envs))
848	for k := range envs {
849		keys = append(keys, k)
850	}
851	slices.Sort(keys)
852	res := make([]string, 0, len(envs))
853	for _, k := range keys {
854		v, err := r.ResolveValue(envs[k])
855		if err != nil {
856			return nil, fmt.Errorf("env %s: %w", k, err)
857		}
858		res = append(res, fmt.Sprintf("%s=%s", k, v))
859	}
860	return res, nil
861}
862
863func ptrValOr[T any](t *T, el T) T {
864	if t == nil {
865		return el
866	}
867	return *t
868}