You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/docs/octopus-ai/claude-agent-step/getting-started.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,9 +30,9 @@ To add and configure the step:
30
30

31
31
:::
32
32
33
-
3. In **Prompt**, describe the task in plain language, the way you would prompt Claude Code. The prompt can use Octopus variables (for example `#{Octopus.Environment.Name}`), which are substituted before the agent runs. Be specific about what you want the agent to do and what "success" looks like.
33
+
3. In **Prompt**, describe the task in plain language, the way you would prompt Claude Code. The prompt can use Octopus variables (for example,`#{Octopus.Environment.Name}`), which are substituted before the agent runs. Be specific about what you want the agent to do and what "success" looks like.
34
34
4. In **Claude Settings**, set **API Key** to a reference to your sensitive variable, for example `#{anthropic-api-key}`.
35
-
5. Optionally, set **Model Version** to a model such as`claude-opus-4-8` or `claude-haiku-4-5`, or leave it blank to use the Claude Code CLI's current default. The **Effort** setting trades thoroughness against cost and latency; leave it blank to use the default.
35
+
5. Optionally, set **Model Version** to a model, like`claude-opus-4-8` or `claude-haiku-4-5`, or leave it blank to use the Claude Code CLI's current default. The **Effort** setting trades thoroughness against cost and latency; leave it blank to use the default.
36
36
37
37
:::figure
38
38

@@ -49,7 +49,7 @@ To add and configure the step:
49
49
The **Bash sandbox** and **Sandbox runtime** modes are supported on Linux (and WSL2) workers. They aren't available on Windows workers. If you're evaluating the step on a Windows worker, use **None** and rely on isolation such as the account Tentacle runs under.
50
50
:::
51
51
52
-
7. Select a **Permission Mode**. For your first run, select **dontAsk mode**. The step runs non-interactively, with no way to approve an action mid-run, so `dontAsk` is the standard choice: the agent may use any tool you allow and is denied everything else. The other option, Auto mode (a mode that uses a classifier model to determine whether to run a tool), is covered in [Security & Compliance](/docs/octopus-ai/claude-agent-step/security-and-compliance#tool-permissions).
52
+
7. Select a **Permission Mode**. For your first run, select **dontAsk mode**. The step runs non-interactively, with no way to approve an action mid-run, so `dontAsk` is the standard choice: the agent may use any tool you allow and is denied everything else. The other option, Auto mode (which uses a classifier model to determine whether to run a tool), is covered in [Security & Compliance](/docs/octopus-ai/claude-agent-step/security-and-compliance#tool-permissions).
53
53
8. In **Tool Permissions**, list the tools the agent needs, one per line. For example:
54
54
55
55
```text
@@ -59,7 +59,7 @@ To add and configure the step:
59
59
Bash(ls *)
60
60
```
61
61
62
-
Start with minimal permissions and add to it as you learn what the agent needs.
62
+
Start with minimal permissions and add to them as you learn what the agent needs.
63
63
9. Optionally, under **Agent Capabilities**, add **Skills**, connect the **Octopus MCP Server**, or add **Additional MCP Servers**. See [Extending the Claude Agent Step](/docs/octopus-ai/claude-agent-step/tools).
64
64
10. Under **Additional Configuration Options**, set a **Turn Limit** to cap how many turns the agent can take before the step stops. One turn is a single request/response cycle with the model. The default is 10.
65
65
11. Optionally, set a **Maximum Budget** as a spend cap in USD. Leave it blank for no limit.
@@ -75,7 +75,7 @@ A Run Claude Agent step runs like any other step. Run the process that contains
75
75
To run the step and watch its output:
76
76
77
77
1. Create a release and deploy it, as you would for any other step.
78
-
2. Open the task and expand the step in the **task log**. While the step runs, the agent streams its output in real time. At the default log level you see the agent's narration and its final answer.
78
+
2. Open the task and expand the step in the **task log**. While the step runs, the agent streams its output in real time. At the default log level, you see the agent's narration and its final answer.
79
79
3. To also see the agent's thinking, each tool call, and the exact command Octopus ran, switch the log to verbose (or download the raw log).
80
80
81
81
:::figure
@@ -101,7 +101,7 @@ Every completed run leaves the following outputs on the task page.
101
101
102
102
## Investigate a failed deployment
103
103
104
-
When a deployment fails, the fastest first responder is one that's already there. Add an agent step that runs only when an earlier step fails, and it attaches a first-pass diagnosis to the failed task, while the deployment is still in its failed state, instead of waiting for someone to start digging.
104
+
When a deployment fails, the fastest first responder is one that's already there. Add an agent step that runs only when an earlier step fails, and use it to attach a first-pass diagnosis to the failed task, while the deployment is still in its failed state, instead of waiting for someone to start digging.
105
105
106
106
To add an automatic failure investigation to a deployment process:
107
107
@@ -127,14 +127,14 @@ To add an automatic failure investigation to a deployment process:
127
127
6. Select **Sandbox runtime** as the sandbox mode on a Linux worker (or **None** while evaluating on Windows or macOS).
128
128
129
129
:::div{.hint}
130
-
Keep the allowlist to read-only tools. The prompt tells the agent not to change anything, but the allowlist helps to enforces that. With only read and query commands allowed, an agent that decides to "fix" the problem anyway is denied the tool it reaches for, and the step fails rather than making the outage worse. Match the list to how your infrastructure is inspected. For a virtual machine you might allow `Bash(systemctl status *)` and `Bash(journalctl *)` in place of the `kubectl` commands above.
130
+
Keep the allowlist to read-only tools. The prompt tells the agent not to change anything, but the allowlist helps to enforce that. With only read and query commands allowed, an agent that decides to "fix" the problem anyway is denied the tool it reaches for, and the step fails rather than making the outage worse. Match the list to how your infrastructure is inspected. For a virtual machine you might allow `Bash(systemctl status *)` and `Bash(journalctl *)` in place of the `kubectl` commands above.
131
131
:::
132
132
133
-
Because the step runs only on failure, the deployment still ends in a failed state, which is what you want: the agent explains the failure, it doesn't paper over it. Its summary appears in the task log next to the step that failed.
133
+
Because the step runs only on failure, the deployment still ends in a failed state, which is what you want: the agent explains the failure, it doesn't paper over it. Its summary appears in the task log next to the failed step.
134
134
135
135
## Smoke-test a service before promotion
136
136
137
-
Before promoting a release, you want an agent to check that the deployed service is healthy, and to fail the step if it isn't so the promotion stops. By default an agent run always *succeeds* when the agent finishes normally, so the agent has to explicitly signal failure; the built-in `octopus-fail-deployment` skill handles this when your prompt states a failure condition.
137
+
Before promoting a release, you want an agent to check that the deployed service is healthy and fail the step if it isn't, so the promotion stops. By default, an agent run always *succeeds* when the agent finishes normally, so the agent has to signal failure explicitly; the built-in `octopus-fail-deployment` skill handles this when your prompt states a failure condition.
138
138
139
139
To add a smoke test to a deployment process:
140
140
@@ -151,7 +151,7 @@ To add a smoke test to a deployment process:
151
151
4. In **Tool Permissions**, allow `Bash(curl *)`, plus any other command your check needs.
152
152
5. Select **Sandbox runtime** as the sandbox mode on a Linux worker.
153
153
154
-
If the health check doesn't pass, the agent emits the failure tag from the `octopus-fail-deployment`skill in its final message, and Octopus fails the step and surfaces the agent's reason in the task log, stopping the promotion. Stating the failure condition in the prompt is enough. See [Built-in skills](/docs/octopus-ai/claude-agent-step/tools#built-in-skills) for how the skill works.
154
+
If the health check doesn't pass, the agent emits the `octopus-fail-deployment`failure tag in its final message, and Octopus fails the step and surfaces the agent's reason in the task log, stopping the promotion. Stating the failure condition in the prompt is enough. See [Built-in skills](/docs/octopus-ai/claude-agent-step/tools#built-in-skills) for how the skill works.
155
155
156
156
:::div{.hint}
157
157
As with any AI tool, the outcome of a check like this is not deterministic. Treat the agent's verdict as a helpful check, not a hard gate, and pair it with deterministic checks where the outcome matters. See [Limitations](/docs/octopus-ai/claude-agent-step#limitations) for more information.
Copy file name to clipboardExpand all lines: src/pages/docs/octopus-ai/claude-agent-step/index.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ description: What the Claude Agent Step is, how it fits into a deployment, and t
9
9
navOrder: 4
10
10
---
11
11
12
-
The Claude Agent Step runs [Claude Code](https://code.claude.com/docs/en/overview) (Anthropic's agentic developer tool) as a step in your deployment process or runbook. This page explains the step, both what it provides, and why it runs inside the deployment. When you're ready to add the step to a process, start with [Getting started with the Claude Agent Step](/docs/octopus-ai/claude-agent-step/getting-started).
12
+
The Claude Agent Step runs [Claude Code](https://code.claude.com/docs/en/overview) (Anthropic's agentic developer tool) as a step in your deployment process or runbook. This page explains the step, both what it provides and why it runs inside the deployment. When you're ready to add the step to a process, start with [Getting started with the Claude Agent Step](/docs/octopus-ai/claude-agent-step/getting-started).
13
13
14
14
:::div{.warning}
15
15
The Claude Agent Step is an **alpha** release. The configuration and behavior may change between releases, and we're actively looking for feedback on how you use it. Don't build critical, unattended automation on it yet.
@@ -25,9 +25,9 @@ The Claude Agent Step gives you a place to run an agent *inside* the deployment.
25
25
26
26
## Models and API keys
27
27
28
-
The step brings no model of its own, you bring your own Anthropic API key and choose the Anthropic model based on your own requirements. Octopus doesn't proxy the model or add its own key. The step runs Claude Code specifically; there's currently no option to use a different provider, like Amazon Bedrock or Azure AI Foundry.
28
+
This step provides no model of its own; you bring your own Anthropic API key and choose the Anthropic model based on your requirements. Octopus doesn't proxy the model or add its own key. The step runs Claude Code specifically; there's currently no option to use a different provider, like Amazon Bedrock or Azure AI Foundry.
29
29
30
-
Every run records its token usage and cost against the task, so you can see what each agent run costs.
30
+
Every run records its token usage and cost against the task, so you can see how much each agent run costs.
0 commit comments