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