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