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