ai_agent/tools/powershell/

prompt.rs

// Source: /data/home/swei/claudecode/openclaudecode/src/tools/PowerShellTool/prompt.rs
//! PowerShell tool prompt

use crate::constants::env::ai;
use crate::utils::env_utils::is_env_truthy;

/// Get default timeout in milliseconds
pub fn get_default_timeout_ms() -> u64 {
    // Match BashTool's default timeout
    120000 // 2 minutes
}

/// Get maximum timeout in milliseconds
pub fn get_max_timeout_ms() -> u64 {
    // Match BashTool's max timeout
    600000 // 10 minutes
}

/// Check if background tasks are disabled
pub fn is_background_tasks_disabled() -> bool {
    is_env_truthy(std::env::var(ai::DISABLE_BACKGROUND_TASKS).ok().as_deref())
}

/// Get background usage note
fn get_background_usage_note() -> Option<&'static str> {
    if is_background_tasks_disabled() {
        return None;
    }
    Some("  - You can use the `run_in_background` parameter to run the command in the background. Only use this if you don't need the result immediately and are OK being notified when the command completes later.")
}

/// Get sleep guidance
fn get_sleep_guidance() -> Option<&'static str> {
    if is_background_tasks_disabled() {
        return None;
    }
    Some(r#"  - Avoid unnecessary `Start-Sleep` commands:
    - Do not sleep between commands that can run immediately — just run them.
    - If your command is long running and you would like to be notified when it finishes — simply run your command using `run_in_background`. There is no need to sleep in this case.
    - Do not retry failing commands in a sleep loop — diagnose the root cause or consider an alternative approach.
    - If waiting for a background task you started with `run_in_background`, you will be notified when it completes — do not poll.
    - If you must poll an external process, use a check command rather than sleeping first.
    - If you must sleep, keep the duration short (1-5 seconds) to avoid blocking the user."#)
}

/// PowerShell edition
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum PowerShellEdition {
    Desktop, // Windows PowerShell 5.1
    Core,    // PowerShell 7+
}

/// Get edition-specific section
fn get_edition_section(edition: Option<PowerShellEdition>) -> String {
    match edition {
        Some(PowerShellEdition::Desktop) => {
            "PowerShell edition: Windows PowerShell 5.1 (powershell.exe)
   - Pipeline chain operators `&&` and `||` are NOT available — they cause a parser error. To run B only if A succeeds: `A; if ($?) { B }`. To chain unconditionally: `A; B`.
   - Ternary (`?:`), null-coalescing (`??`), and null-conditional (`?.`) operators are NOT available. Use `if/else` and explicit `$null -eq` checks instead.
   - Avoid `2>&1` on native executables. In 5.1, redirecting a native command's stderr inside PowerShell wraps each line in an ErrorRecord (NativeCommandError) and sets `$?` to `$false` even when the exe returned exit code 0. stderr is already captured for you — don't redirect it.
   - Default file encoding is UTF-16 LE (with BOM). When writing files other tools will read, pass `-Encoding utf8` to `Out-File`/`Set-Content`.
   - `ConvertFrom-Json` returns a PSCustomObject, not a hashtable. `-AsHashtable` is not available.".to_string()
        }
        Some(PowerShellEdition::Core) => {
            "PowerShell edition: PowerShell 7+ (pwsh)
   - Pipeline chain operators `&&` and `||` ARE available and work like bash. Prefer `cmd1 && cmd2` over `cmd1; cmd2` when cmd2 should only run if cmd1 succeeds.
   - Ternary (`$cond ? $a : $b`), null-coalescing (`??`), and null-conditional (`?.`) operators are available.
   - Default file encoding is UTF-8 without BOM.".to_string()
        }
        None => {
            "PowerShell edition: unknown — assume Windows PowerShell 5.1 for compatibility
   - Do NOT use `&&`, `||`, ternary `?:`, null-coalescing `??`, or null-conditional `?.`. These are PowerShell 7+ only and parser-error on 5.1.
   - To chain commands conditionally: `A; if ($?) { B }`. Unconditionally: `A; B`.".to_string()
        }
    }
}

/// Get the full tool prompt
pub async fn get_prompt() -> String {
    let background_note = get_background_usage_note();
    let sleep_guidance = get_sleep_guidance();

    // Note: In Rust, we can't easily detect PowerShell edition at startup
    // We'll return the unknown edition guidance by default
    let edition_section = get_edition_section(None);

    let mut prompt = format!(
        r#"Executes a given PowerShell command with optional timeout. Working directory persists between commands; shell state (variables, functions) does not.

IMPORTANT: This tool is for terminal operations via PowerShell: git, npm, docker, and PS cmdlets. DO NOT use it for file operations (reading, writing, editing, searching, finding files) - use the specialized tools for this instead.

{}

Before executing the command, please follow these steps:

1. Directory Verification:
   - If the command will create new directories or files, first use `Get-ChildItem` (or `ls`) to verify the parent directory exists and is the correct location

2. Command Execution:
   - Always quote file paths that contain spaces with double quotes
   - Capture the output of the command.

PowerShell Syntax Notes:
   - Variables use $ prefix: $myVar = "value"
   - Escape character is backtick (`), not backslash
   - Use Verb-Noun cmdlet naming: Get-ChildItem, Set-Location, New-Item, Remove-Item
   - Common aliases: ls (Get-ChildItem), cd (Set-Location), cat (Get-Content), rm (Remove-Item)
   - Pipe operator | works similarly to bash but passes objects, not text
   - Use Select-Object, Where-Object, ForEach-Object for filtering and transformation
   - String interpolation: "Hello $name" or "Hello $($obj.Property)"
   - Registry access uses PSDrive prefixes: `HKLM:\SOFTWARE\...`, `HKCU:\...` — NOT raw `HKEY_LOCAL_MACHINE\...`
   - Environment variables: read with `$env:NAME`, set with `$env:NAME = "value"` (NOT `Set-Variable` or bash `export`)
   - Call native exe with spaces in path via call operator: `& "C:\Program Files\App\app.exe" arg1 arg2`

Interactive and blocking commands (will hang — this tool runs with -NonInteractive):
   - NEVER use `Read-Host`, `Get-Credential`, `Out-GridView`, `$Host.UI.PromptForChoice`, or `pause`
   - Destructive cmdlets (`Remove-Item`, `Stop-Process`, `Clear-Content`, etc.) may prompt for confirmation. Add `-Confirm:$false` when you intend the action to proceed. Use `-Force` for read-only/hidden items.
   - Never use `git rebase -i`, `git add -i`, or other commands that open an interactive editor

Passing multiline strings (commit messages, file content) to native executables:
   - Use a single-quoted here-string so PowerShell does not expand `$` or backticks inside. The closing `'@` MUST be at column 0 (no leading whitespace) on its own line — indenting it is a parse error:
<example>
git commit -m @'
Commit message here.
Second line with $literal dollar signs.
'@
</example>
   - Use `@'...'@` (single-quoted, literal) not `@"..."@` (double-quoted, interpolated) unless you need variable expansion
   - For arguments containing `-`, `@`, or other characters PowerShell parses as operators, use the stop-parsing token: `git log --% --format=%H`

Usage notes:
  - The command argument is required.
  - You can specify an optional timeout in milliseconds (up to {}ms / {} minutes). If not specified, commands will timeout after {}ms ({} minutes).
  - It is very helpful if you write a clear, concise description of what this command does.
  - If the output exceeds 30000 characters, output will be truncated before being returned to you.
"#,
        edition_section,
        get_max_timeout_ms(),
        get_max_timeout_ms() / 60000,
        get_default_timeout_ms(),
        get_default_timeout_ms() / 60000
    );

    if let Some(note) = background_note {
        prompt.push_str(note);
        prompt.push('\n');
    }

    prompt.push_str(
        r#"  - Avoid using PowerShell to run commands that have dedicated tools, unless explicitly instructed:
    - File search: Use Glob (NOT Get-ChildItem -Recurse)
    - Content search: Use Grep (NOT Select-String)
    - Read files: Use FileRead (NOT Get-Content)
    - Edit files: Use FileEdit
    - Write files: Use FileWrite (NOT Set-Content/Out-File)
    - Communication: Output text directly (NOT Write-Output/Write-Host)
  - When issuing multiple commands:
    - If the commands are independent and can run in parallel, make multiple PowerShell tool calls in a single message.
    - If the commands depend on each other and must run sequentially, chain them in a single PowerShell call (see edition-specific chaining syntax above).
    - Use `;` only when you need to run commands sequentially but don't care if earlier commands fail.
    - DO NOT use newlines to separate commands (newlines are ok in quoted strings and here-strings)
  - Do NOT prefix commands with `cd` or `Set-Location` -- the working directory is already set to the correct project directory automatically.
"#,
    );

    if let Some(guidance) = sleep_guidance {
        prompt.push_str(guidance);
        prompt.push('\n');
    }

    prompt.push_str(
        "  - For git commands:\n\
         - Prefer to create a new commit rather than amending an existing commit.\n\
         - Before running destructive operations (e.g., git reset --hard, git push --force, git checkout --), consider whether there is a safer alternative that achieves the same goal. Only use destructive operations when they are truly the best approach.\n\
         - Never skip hooks (--no-verify) or bypass signing (--no-gpg-sign, -c commit.gpgsign=false) unless the user has explicitly asked for it. If a hook fails, investigate and fix the underlying issue."
    );

    prompt
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_get_default_timeout_ms() {
        let timeout = get_default_timeout_ms();
        assert!(timeout > 0);
        assert!(timeout <= get_max_timeout_ms());
    }

    #[test]
    fn test_get_max_timeout_ms() {
        let max = get_max_timeout_ms();
        assert!(max > 0);
    }

    #[test]
    fn test_default_less_than_max_timeout() {
        assert!(get_default_timeout_ms() <= get_max_timeout_ms());
    }

    #[test]
    fn test_default_timeout_reasonable() {
        // Default should be between 30s and 5 minutes
        let default = get_default_timeout_ms();
        assert!(default >= 30_000);
        assert!(default <= 300_000);
    }

    #[test]
    fn test_max_timeout_reasonable() {
        // Max should be at least 1 minute
        let max = get_max_timeout_ms();
        assert!(max >= 60_000);
    }
}