> ## Documentation Index
> Fetch the complete documentation index at: https://www.voiceflow.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# vf playbook add-tool-message

> vf playbook add-tool-message: add playbook tool message. Requires --body-param, --environment-alias, --playbook-id, --project-id and --slot.

Set a message on one of the playbook's tools. Rejected when that message already exists.

## Usage

```bash
vf playbook add-tool-message [flags]
```

## Examples

```bash
  vf playbook add-tool-message --playbook-id <id> --project-id <id> --environment-alias <value> --slot execution
```

## Flags

```text
      --body string                             Request body as JSON (alternative to individual flags). Can also be provided via stdin.
  -b, --body-param string                       JSON value (variants: generative: { type: string, examples: string[] }, scripted: { type: string, messageID: string })
      --body-param.generative string            StableToolMessageRequest_Generative variant as JSON
      --body-param.scripted string              StableToolMessageRequest_Scripted variant as JSON
      --body-param.scripted.message-id string   The ID of an existing response in this environment — the same ID this slot reports as <slot>MessageID on a read. [required]
  -e, --environment-alias string                Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected. [required]
  -h, --help                                    help for add-tool-message
  -n, --native-tool string                      Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected. (options: endTool, cardTool, buttonTool, carouselTool, webSearchTool, callForwardTool, knowledgeBaseTool)
      --playbook-id string                      [required]
      --project-id string                       Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected. [required]
  -s, --slot string                             Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected. (options: delay, failure, execution, completion) [required]
  -t, --tool-id string                          Addresses one message on one tool. Exactly one of toolID and nativeTool is required; sending neither or both is rejected.
```

## Global flags

These flags are inherited from the parent command and work on every invocation.

```text
      --agent-mode             Enable structured errors and default TOON output for AI coding agents. Automatically enabled when a known agent environment is detected (CLAUDE_CODE, CURSOR_AGENT, etc.). Use --agent-mode=false to disable.
      --color string           Control colored output: auto (color when output is a TTY), always, or never. Respects NO_COLOR and FORCE_COLOR env vars. (default "auto")
  -d, --debug                  Log request and response diagnostics to stderr
      --dry-run                Preview the request that would be sent without executing it (output to stderr)
  -H, --header stringArray     Set a custom HTTP request header (format: "Key: Value"). Can be specified multiple times.
      --include-headers        Include HTTP response headers in the output
  -q, --jq string              Filter and transform output using a jq expression (e.g., '.name', '.items[] | .id')
      --no-interactive         Disable all interactive features (auto-prompting, explorer auto-launch, TUI forms)
  -o, --output-format string   Specify the output format. Options: pretty, json, yaml, table, toon. (default "pretty")
      --server-url string      Override the default server URL
      --timeout string         HTTP request timeout (e.g., 30s, 5m, 100ms)
      --token string           Voiceflow bearer token
      --usage                  Print the CLI Usage schema in KDL format
```

## See also

- [vf playbook](/docs/cli/commands/playbook) - Operations for playbook