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