vtcode 0.146.4

A Rust-based terminal coding agent with modular architecture supporting multiple LLM providers
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
use std::path::{Path, PathBuf};

use anyhow::{Context, Result, anyhow, bail};
use vtcode_core::config::loader::VTCodeConfig;
use vtcode_core::config::validator::ConfigValidator;
use vtcode_core::llm::factory::get_factory;
use vtcode_core::prompts::system::measure_system_prompt_size;
use vtcode_core::utils::path::canonicalize_workspace;

pub(super) fn apply_cli_permission_overrides(
    config: &mut VTCodeConfig,
    allowed_tools: &[String],
    disallowed_tools: &[String],
) {
    for entry in iter_permission_entries(allowed_tools) {
        push_unique_permission_entry(&mut config.permissions.allow, entry);
    }

    for entry in iter_permission_entries(disallowed_tools) {
        push_unique_permission_entry(&mut config.permissions.deny, entry);
    }
}

fn iter_permission_entries(entries: &[String]) -> impl Iterator<Item = &str> {
    entries
        .iter()
        .flat_map(|value| value.split(','))
        .map(str::trim)
        .filter(|value| !value.is_empty())
}

fn push_unique_permission_entry(target: &mut Vec<String>, entry: &str) {
    if !target.iter().any(|existing| existing == entry) {
        target.push(entry.to_string());
    }
}

pub(super) fn parse_cli_config_entries(entries: &[String]) -> (Option<PathBuf>, Vec<(String, String)>) {
    let mut config_path: Option<PathBuf> = None;
    let mut overrides = Vec::new();

    for entry in entries {
        let trimmed = entry.trim();
        if trimmed.is_empty() {
            continue;
        }

        if let Some((key, value)) = trimmed.split_once('=') {
            let key = key.trim();
            if key.is_empty() {
                continue;
            }
            overrides.push((key.to_owned(), value.trim().to_owned()));
        } else if config_path.is_none() {
            config_path = Some(PathBuf::from(trimmed));
        }
    }

    (config_path, overrides)
}

fn expand_tilde(path: &Path) -> PathBuf {
    let s = path.to_string_lossy();
    if !s.starts_with('~') {
        return path.to_path_buf();
    }
    if s == "~" {
        return dirs::home_dir().unwrap_or_else(|| path.to_path_buf());
    }
    if let Some(rest) = s.strip_prefix("~/") {
        if let Some(home) = dirs::home_dir() {
            return home.join(rest);
        }
    }
    path.to_path_buf()
}

pub(super) fn resolve_config_path(workspace: &Path, candidate: &Path) -> PathBuf {
    let candidate = expand_tilde(candidate);
    if candidate.is_absolute() {
        return candidate;
    }

    let workspace_candidate = workspace.join(&candidate);
    if workspace_candidate.exists() {
        return workspace_candidate;
    }

    let cwd = std::env::current_dir().unwrap_or_else(|_| workspace.to_path_buf());
    let cwd_candidate = cwd.join(&candidate);
    if cwd_candidate.exists() {
        cwd_candidate
    } else {
        workspace_candidate
    }
}

pub(super) fn validate_full_auto_configuration(config: &VTCodeConfig, workspace: &Path) -> Result<()> {
    let automation_cfg = &config.automation.full_auto;
    if !automation_cfg.enabled {
        bail!("Full-auto permission review is disabled in configuration. Enable it under [automation.full_auto].");
    }

    if automation_cfg.require_profile_ack {
        let profile_path = automation_cfg.profile_path.clone().ok_or_else(|| {
            anyhow!(
                "Full-auto permission review requires 'profile_path' in [automation.full_auto] when require_profile_ack = true."
            )
        })?;
        let resolved_profile = if profile_path.is_absolute() {
            profile_path
        } else {
            workspace.join(profile_path)
        };

        if !resolved_profile.exists() {
            bail!(
                "Full-auto profile '{}' not found. Create the acknowledgement file before using --full-auto.",
                resolved_profile.display()
            );
        }
    }

    Ok(())
}

/// Fail fast with a clear, actionable error when the resolved LLM provider is
/// not a known built-in or configured custom provider. Without this, an invalid
/// `--provider` value (or broken `[agent].provider` config) only surfaces deep
/// inside session setup as an opaque "Failed to initialize provider client"
/// report, after the terminal probe has already started.
pub(super) fn validate_runtime_provider(config: &VTCodeConfig, provider: &str) -> Result<()> {
    let provider_key = provider.trim();
    if provider_key.is_empty() {
        return Ok(());
    }

    let mut known: Vec<String> = {
        let factory = get_factory()
            .lock()
            .map_err(|err| anyhow!("LLM factory lock poisoned while validating provider: {err}"))?;
        factory.list_providers()
    };
    for custom in &config.custom_providers {
        known.push(custom.name.trim().to_string());
    }
    for key in config.provider_overrides.keys() {
        known.push(key.trim().to_string());
    }
    known.push(crate::codex_app_server::CODEX_PROVIDER.to_string());

    if !known.iter().any(|candidate| candidate.eq_ignore_ascii_case(provider_key)) {
        let mut available = known.iter().map(|candidate| candidate.to_ascii_lowercase()).collect::<Vec<_>>();
        available.sort();
        available.dedup();
        bail!("Unknown provider '{provider_key}'. Available providers: {}", available.join(", "));
    }
    Ok(())
}

pub(super) fn resolve_workspace_path(workspace_arg: Option<PathBuf>) -> Result<PathBuf> {
    let cwd = std::env::current_dir().context("Failed to determine current working directory")?;
    let resolved = match workspace_arg {
        Some(path) if path.is_absolute() => path,
        Some(path) => cwd.join(path),
        None => cwd,
    };

    Ok(canonicalize_workspace(&resolved))
}

pub(super) async fn validate_startup_configuration(
    config: &VTCodeConfig,
    workspace: &Path,
    quiet: bool,
    defer_system_prompt_size_check: bool,
) -> Result<()> {
    // Ripgrep availability is checked lazily when search tools are actually
    // needed (session setup, first-run, `vtcode dependencies`).  Checking it
    // here would fork a subprocess (`rg --version`) on every startup for
    // purely informational logging — not worth the 50-200ms cost.

    let validator = ConfigValidator::generated();
    match validator.validate(config) {
        Ok(result) if !result.errors.is_empty() => {
            if !quiet {
                // Tracing is not yet initialized at this point in startup, so
                // use eprintln to ensure the user sees deprecation advice.
                // Wording is "warning" (not "error") because startup remains
                // non-fatal — the runtime provider validator catches truly
                // invalid models when a request is actually made.
                for error in &result.errors {
                    eprintln!("Configuration warning: {error}");
                }
            }
            // Non-fatal: log but don't abort startup for config validation errors.
            // The model-exists check is advisory — the user may have a custom
            // setup. The runtime validation in the LLM provider will catch
            // truly invalid models when a request is made.
        }
        Ok(_) => {}
        Err(e) if !quiet => {
            eprintln!("could not validate configured model catalog: {e}");
        }
        Err(_) => {}
    }

    if !quiet {
        for warning in collect_token_overhead_warnings(config) {
            tracing::warn!("{warning}");
        }
        if !defer_system_prompt_size_check {
            check_system_prompt_size(config, workspace).await;
        }
    }

    Ok(())
}

/// Returns non-fatal warnings describing configuration choices that are likely
/// to inflate the per-request token cost:
///
/// - many configured MCP servers (schema tax on every request),
/// - client-local tool deferral disabled while MCP servers are configured,
/// - heavy `system_prompt_mode` / `tool_documentation_mode`,
/// - disabled tool-result clearing (unbounded context growth),
/// - disabled auto-compaction (unbounded history growth),
/// - very low `max_system_prompt_tokens` (likely aggressive trimming).
///
/// Kept pure (no logging side effects) so it can be unit-tested in isolation.
fn collect_token_overhead_warnings(config: &VTCodeConfig) -> Vec<String> {
    use vtcode_core::config::{SystemPromptMode, ToolDocumentationMode};

    const MCP_SERVER_OVERHEAD_WARN_THRESHOLD: usize = 8;
    const LOW_SYSTEM_PROMPT_BUDGET_WARN_THRESHOLD: u64 = 4_000;

    let mut warnings = Vec::new();

    let mcp_servers = config.mcp.providers.len();
    if mcp_servers > MCP_SERVER_OVERHEAD_WARN_THRESHOLD {
        warnings.push(format!(
            "configured {mcp_servers} MCP servers (threshold {MCP_SERVER_OVERHEAD_WARN_THRESHOLD}); each server's tool schemas are sent on every request unless deferred. Consider reducing the count or relying on deferred tool loading (tools.client_tool_search defaults to true) to lower token cost."
        ));
    }

    if !config.tools.client_tool_search && !config.mcp.providers.is_empty() {
        warnings.push(
            "tools.client_tool_search is disabled but MCP servers are configured; all MCP tool schemas are sent eagerly on every request. Enable tools.client_tool_search to defer large schemas until needed.".to_string(),
        );
    }

    if matches!(config.agent.system_prompt_mode, SystemPromptMode::Specialized) {
        warnings.push(
            "agent.system_prompt_mode = 'specialized' sends a larger base system prompt on every request. Prefer 'minimal' or 'lightweight' (default) to reduce token cost.".to_string(),
        );
    }

    if matches!(config.agent.tool_documentation_mode, ToolDocumentationMode::Full) {
        warnings.push(
            "agent.tool_documentation_mode = 'full' sends complete tool documentation on every request. Prefer 'progressive' (default) to keep tool schemas small.".to_string(),
        );
    }

    if !config.agent.harness.tool_result_clearing.enabled {
        warnings.push(
            "agent.harness.tool_result_clearing is disabled; old tool results accumulate in context and raise per-turn token cost. Enable it (the default) to bound context growth.".to_string(),
        );
    }

    if !config.agent.harness.auto_compaction_enabled {
        warnings.push(
            "agent.harness.auto_compaction_enabled is disabled; normal conversation history can grow without bound. Enable it (the default) to compact context when token pressure rises. A bounded post-tool recovery compaction remains available after provider failure.".to_string(),
        );
    }

    if config.agent.max_system_prompt_tokens < LOW_SYSTEM_PROMPT_BUDGET_WARN_THRESHOLD {
        warnings.push(format!(
            "agent.max_system_prompt_tokens = {} is very low; the base system prompt alone may exceed this and trigger aggressive trimming. Consider raising it to at least {}.",
            config.agent.max_system_prompt_tokens,
            LOW_SYSTEM_PROMPT_BUDGET_WARN_THRESHOLD,
        ));
    }

    warnings
}

/// Checks the actual composed system prompt size at startup and warns if it
/// exceeds `agent.max_system_prompt_tokens`. This is a one-time cost: the
/// static prompt layers are cached after the first read.
pub(super) async fn check_system_prompt_size(config: &VTCodeConfig, workspace: &Path) {
    if !config.agent.system_prompt_budget_warning {
        return;
    }

    let report = measure_system_prompt_size(workspace, config).await;
    if report.over_budget {
        tracing::warn!(
            token_estimate = report.token_estimate,
            max_system_prompt_tokens = config.agent.max_system_prompt_tokens,
            "System prompt exceeds configured token budget at startup"
        );
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use assert_fs::TempDir;
    use std::env;
    use vtcode_commons::canonicalize;
    use vtcode_commons::env_lock;
    use vtcode_config::McpProviderConfig;
    use vtcode_core::config::loader::ConfigBuilder;

    #[test]
    fn runtime_provider_validation_rejects_unknown_provider() {
        let config = VTCodeConfig::default();
        let error = validate_runtime_provider(&config, "merge-api").expect_err("unknown provider should fail");

        let message = error.to_string();
        assert!(message.contains("Unknown provider 'merge-api'"), "{message}");
        assert!(message.contains("Available providers:"), "{message}");
        assert!(message.contains("merge-gateway"), "{message}");
        assert!(message.contains("openai"), "{message}");
    }

    #[test]
    fn runtime_provider_validation_accepts_builtin_and_codex() {
        let config = VTCodeConfig::default();
        for provider in ["openai", "Merge-Gateway", "codex", "COPILOT"] {
            validate_runtime_provider(&config, provider).expect("known provider should be accepted");
        }
    }

    #[test]
    fn runtime_provider_validation_accepts_configured_custom_provider() {
        let mut config = VTCodeConfig::default();
        config.custom_providers.push(vtcode_config::core::CustomProviderConfig {
            name: "mycorp".to_string(),
            display_name: "MyCorp".to_string(),
            base_url: "https://llm.example/v1".to_string(),
            context_window: None,
            api_key_env: "MYCORP_API_KEY".to_string(),
            auth: None,
            model: "corp-model".to_string(),
            models: Vec::new(),
            ..vtcode_config::core::CustomProviderConfig::default()
        });

        validate_runtime_provider(&config, "mycorp").expect("configured custom provider should be accepted");
    }

    #[test]
    fn runtime_provider_validation_accepts_provider_override_key() {
        let mut config = VTCodeConfig::default();
        config
            .provider_overrides
            .insert("corp-gateway".to_string(), vtcode_config::core::ProviderOverrideConfig::default());

        validate_runtime_provider(&config, "corp-gateway").expect("override key should be accepted");
    }

    #[test]
    fn runtime_provider_validation_accepts_blank_provider() {
        validate_runtime_provider(&VTCodeConfig::default(), "  ").expect("blank provider should be a no-op");
    }

    #[test]
    #[expect(clippy::panic_in_result_fn, reason = "test function, assertions are OK")]
    fn resolves_current_dir_when_none() -> Result<()> {
        let _env = env_lock::lock();
        let original_cwd = env::current_dir()?;
        let temp_dir = TempDir::new()?;
        env::set_current_dir(temp_dir.path())?;

        let resolved = resolve_workspace_path(None)?;
        assert_eq!(resolved, canonicalize(temp_dir.path())?);

        env::set_current_dir(original_cwd)?;
        Ok(())
    }

    #[test]
    fn resolves_relative_workspace_path() -> Result<()> {
        let _env = env_lock::lock();
        let original_cwd = env::current_dir()?;
        let temp_dir = TempDir::new()?;
        let workspace_dir = temp_dir.path().join("project");
        std::fs::create_dir(&workspace_dir)?;
        env::set_current_dir(temp_dir.path())?;

        let resolved = resolve_workspace_path(Some(PathBuf::from("project")))?;
        assert_eq!(resolved, canonicalize(workspace_dir)?);

        env::set_current_dir(original_cwd)?;
        Ok(())
    }

    #[test]
    fn parses_cli_config_entries_with_overrides() {
        let entries = vec![
            "agent.provider=openai".to_owned(),
            "custom-config/vtcode.toml".to_owned(),
        ];

        let (path, overrides) = parse_cli_config_entries(&entries);

        assert_eq!(path, Some(PathBuf::from("custom-config/vtcode.toml")));
        assert_eq!(overrides, vec![("agent.provider".to_owned(), "openai".to_owned())]);
    }

    #[test]
    fn cli_permission_overrides_append_unique_entries() {
        let mut config = VTCodeConfig::default();
        config.permissions.allow = vec!["exec_command".to_string()];

        apply_cli_permission_overrides(
            &mut config,
            &["exec_command,code_search".to_string(), "write_stdin".to_string()],
            &["apply_patch".to_string(), "exec_command".to_string()],
        );

        assert_eq!(
            config.permissions.allow,
            vec![
                "exec_command".to_string(),
                "code_search".to_string(),
                "write_stdin".to_string()
            ]
        );
        assert_eq!(config.permissions.deny, vec!["apply_patch".to_string(), "exec_command".to_string()]);
    }

    #[test]
    fn cli_permission_overrides_preserve_rule_shaped_entries() {
        let mut config = VTCodeConfig::default();

        apply_cli_permission_overrides(
            &mut config,
            &["Read(/docs/**)".to_string(), "Bash(cargo check)".to_string()],
            &["Edit(/.git/**)".to_string()],
        );

        assert_eq!(config.permissions.allow, vec!["Read(/docs/**)".to_string(), "Bash(cargo check)".to_string()]);
        assert_eq!(config.permissions.deny, vec!["Edit(/.git/**)".to_string()]);
    }

    #[test]
    fn applies_inline_overrides_to_config() -> Result<()> {
        let env_guard = env_lock::lock();
        let temp_dir = TempDir::new()?;
        std::fs::write(temp_dir.path().join("vtcode.toml"), "[workspace]\nuse_root_config = true\n")?;
        let previous_config_dir = env::var_os("VTCODE_CONFIG");
        env_guard.set_var("VTCODE_CONFIG", temp_dir.path());

        let overrides = vec![("agent.provider".to_owned(), "\"openai\"".to_owned())];

        let manager = ConfigBuilder::new()
            .workspace(temp_dir.path().to_path_buf())
            .cli_overrides(&overrides)
            .build()?;
        let config = manager.config();

        assert_eq!(config.agent.provider, "openai");

        env_guard.restore_var("VTCODE_CONFIG", previous_config_dir);
        Ok(())
    }

    #[test]
    fn token_overhead_warnings_empty_for_default_config() {
        let config = VTCodeConfig::default();
        assert!(
            collect_token_overhead_warnings(&config).is_empty(),
            "default config should not trigger token-overhead warnings"
        );
    }

    #[test]
    fn token_overhead_warns_on_specialized_prompt_mode() {
        let mut config = VTCodeConfig::default();
        config.agent.system_prompt_mode = vtcode_core::config::SystemPromptMode::Specialized;
        let warnings = collect_token_overhead_warnings(&config);
        assert!(
            warnings.iter().any(|w| w.contains("system_prompt_mode = 'specialized'")),
            "expected a warning for specialized system prompt mode: {warnings:?}"
        );
    }

    #[test]
    fn token_overhead_warns_on_full_tool_docs() {
        let mut config = VTCodeConfig::default();
        config.agent.tool_documentation_mode = vtcode_core::config::ToolDocumentationMode::Full;
        let warnings = collect_token_overhead_warnings(&config);
        assert!(
            warnings.iter().any(|w| w.contains("tool_documentation_mode = 'full'")),
            "expected a warning for full tool documentation mode: {warnings:?}"
        );
    }

    #[test]
    fn token_overhead_warns_on_disabled_tool_result_clearing() {
        let mut config = VTCodeConfig::default();
        config.agent.harness.tool_result_clearing.enabled = false;
        let warnings = collect_token_overhead_warnings(&config);
        assert!(
            warnings.iter().any(|w| w.contains("tool_result_clearing is disabled")),
            "expected a warning for disabled tool-result clearing: {warnings:?}"
        );
    }

    #[test]
    fn token_overhead_warns_on_many_mcp_servers() {
        let mut config = VTCodeConfig::default();
        for _ in 0..12 {
            config.mcp.providers.push(McpProviderConfig::default());
        }
        let warnings = collect_token_overhead_warnings(&config);
        assert!(
            warnings.iter().any(|w| w.contains("MCP servers")),
            "expected a warning for many MCP servers: {warnings:?}"
        );
    }

    #[test]
    fn token_overhead_warns_when_client_tool_search_disabled_with_mcp() {
        let mut config = VTCodeConfig::default();
        config.tools.client_tool_search = false;
        config.mcp.providers.push(McpProviderConfig::default());
        let warnings = collect_token_overhead_warnings(&config);
        assert!(
            warnings.iter().any(|w| w.contains("client_tool_search is disabled")),
            "expected a warning for disabled client tool search with MCP: {warnings:?}"
        );
    }

    #[test]
    fn token_overhead_warns_when_auto_compaction_disabled() {
        let mut config = VTCodeConfig::default();
        config.agent.harness.auto_compaction_enabled = false;
        let warnings = collect_token_overhead_warnings(&config);
        assert!(
            warnings.iter().any(|w| w.contains("auto_compaction_enabled is disabled")),
            "expected a warning for disabled auto compaction: {warnings:?}"
        );
    }

    #[test]
    fn token_overhead_warns_on_low_system_prompt_budget() {
        let mut config = VTCodeConfig::default();
        config.agent.max_system_prompt_tokens = 100;
        let warnings = collect_token_overhead_warnings(&config);
        assert!(
            warnings
                .iter()
                .any(|w| w.contains("max_system_prompt_tokens") && w.contains("very low")),
            "expected a warning for low system prompt budget: {warnings:?}"
        );
    }
}