Skip to content

Commit 7a143c7

Browse files
committed
Docs: timeout_seconds description no longer cites Read-Host as the use-0 case
Since 1.12 host prompts return control immediately as awaiting_input regardless of the timeout, so the old advice was stale. Timeout 0 remains the right tool for native CLIs blocking on stdin (cmd /c pause, ssh, npm login), which host-prompt detection cannot see.
1 parent 7b9a132 commit 7a143c7

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

PowerShell.MCP.Proxy/Tools/PowerShellTools.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ public static async Task<string> ExecuteCommand(
351351
IPipeDiscoveryService pipeDiscoveryService,
352352
[Description("The PowerShell command or pipeline to execute. Multi-line commands (if, loops, try-catch, etc.) are supported.")]
353353
string pipeline,
354-
[Description("Timeout in seconds (0-170, default: 170). On timeout, execution continues in background and result is cached for retrieval on next tool call. Use 0 for commands requiring user interaction (e.g., pause, Read-Host).")]
354+
[Description("Timeout in seconds (0-170, default: 170). On timeout, execution continues in background and result is cached for retrieval on next tool call. PowerShell host prompts (Read-Host, Get-Credential, a missing mandatory parameter) return control immediately as awaiting_input regardless of this value. Use 0 for native CLIs that wait on stdin (e.g., cmd /c pause, ssh, npm login) so the call returns at once instead of waiting out the timeout.")]
355355
int timeout_seconds = 170,
356356
[Description("Literal string value injected as $var1 in the pipeline, bypassing the PowerShell parser.")]
357357
string? var1 = null,

0 commit comments

Comments
 (0)