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