From 742ffe53a97328e7f3e80ebb087fc9a34ecad6be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Mayoral=20Vilches?= Date: Fri, 14 Nov 2025 07:32:02 +0100 Subject: [PATCH] Add CAI_TOOL_TIMEOUT to docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Víctor Mayoral Vilches --- docs/cai/getting-started/configuration.md | 1 + docs/environment_variables.md | 5 +++++ 2 files changed, 6 insertions(+) diff --git a/docs/cai/getting-started/configuration.md b/docs/cai/getting-started/configuration.md index 6da9eb84..494dc8a6 100644 --- a/docs/cai/getting-started/configuration.md +++ b/docs/cai/getting-started/configuration.md @@ -45,6 +45,7 @@ For a complete reference organized by use case, see [Environment Variables Refer | CAI_GUARDRAILS | Enable/disable security guardrails for agents. When set to "true", applies security guardrails to prevent potentially dangerous outputs and inputs | false | | CAI_GCTR_NITERATIONS | Number of tool interactions before triggering GCTR (Generative Cut-The-Rope) analysis in bug_bounter_gctr agent. Only applies when using gctr-enabled agents | 5 | | CAI_ACTIVE_CONTAINER | Docker container ID where commands should be executed. When set, shell commands and tools execute inside the specified container instead of the host. Automatically set when CTF challenges start (if CTF_INSIDE=true) or when switching containers via /virtualization command | - | +| CAI_TOOL_TIMEOUT | Override the default timeout for tool command executions in seconds. When set, this value overrides all default timeouts for shell commands and tool executions | varies (10s for interactive, 100s for regular) | ## Custom OpenAI Base URL Support diff --git a/docs/environment_variables.md b/docs/environment_variables.md index 61f9018d..c9201f20 100644 --- a/docs/environment_variables.md +++ b/docs/environment_variables.md @@ -35,6 +35,7 @@ This comprehensive guide documents all environment variables available in CAI, i | CAI_GUARDRAILS | Enable/disable security guardrails for agents. When set to "true", applies security guardrails to prevent potentially dangerous outputs and inputs | false | | CAI_GCTR_NITERATIONS | Number of tool interactions before triggering GCTR (Generative Cut-The-Rope) analysis in bug_bounter_gctr agent. Only applies when using gctr-enabled agents | 5 | | CAI_ACTIVE_CONTAINER | Docker container ID where commands should be executed. When set, shell commands and tools execute inside the specified container instead of the host. Automatically set when CTF challenges start (if CTF_INSIDE=true) or when switching containers via /virtualization command | - | +| CAI_TOOL_TIMEOUT | Override the default timeout for tool command executions in seconds. When set, this value overrides all default timeouts for shell commands and tool executions | varies (10s for interactive, 100s for regular) | --- @@ -154,6 +155,9 @@ CAI_STREAM="false" # Disable streaming for faster processing CAI_ENV_CONTEXT="true" # Include environment in context CAI_MAX_TURNS="50" # Limit conversation turns +# Tool execution timeout +CAI_TOOL_TIMEOUT="60" # Override default command timeouts (in seconds) + # Telemetry CAI_TELEMETRY="true" # Enable usage analytics ``` @@ -162,6 +166,7 @@ CAI_TELEMETRY="true" # Enable usage analytics - Enable `CAI_BRIEF` for concise outputs in automated workflows - Set `CAI_MAX_TURNS` to prevent infinite loops - Use `CAI_STREAM=false` when output display is not needed +- Set `CAI_TOOL_TIMEOUT` to control command execution timeouts (default: 10s for interactive, 100s for regular commands) ---