# Tool specification

> Generated field reference from the AQVEN Python package.

[Read in the browser](https://aqvenstudio.com/reference/tools/)

<!-- Generated by tools/generate_reference.py. Do not edit this file by hand. -->

This reference is generated from the package's Pydantic models. Fields use their YAML aliases. Unknown fields are rejected. Cross-field rules implemented by validators may not appear in JSON Schema; run `aqven check` on a complete project.

## JobWaitSpec

| YAML field | Type | Required | Default | Constraints |
| --- | --- | --- | --- | --- |
| `poll` | `string` | Yes | `—` | — |
| `interval_seconds` | `integer` | Yes | `—` | minimum=1 |
| `timeout_seconds` | `integer` | Yes | `—` | minimum=1 |

[JSON Schema](/reference/schemas/JobWaitSpec.json)

## McpToolSource

| YAML field | Type | Required | Default | Constraints |
| --- | --- | --- | --- | --- |
| `server` | `string` | Yes | `—` | — |
| `tool` | `string` | Yes | `—` | minLength=1 |

[JSON Schema](/reference/schemas/McpToolSource.json)

## ToolSpec

| YAML field | Type | Required | Default | Constraints |
| --- | --- | --- | --- | --- |
| `apiVersion` | `'aqven/v1'` | Yes | `—` | — |
| `kind` | `'Tool'` | Yes | `—` | — |
| `description` | `string` | Yes | `—` | minLength=1 |
| `run` | `string \| null` | No | `None` | — |
| `mcp` | `McpToolSource \| null` | No | `None` | — |
| `effect` | `'read' \| 'write' \| 'external'` | Yes | `—` | — |
| `idempotency_key` | `string[] \| null` | No | `None` | — |
| `secrets` | `SecretBinding[] \| null` | No | `None` | — |
| `wait` | `JobWaitSpec \| null` | No | `None` | — |
| `in` | `FieldDecl[]` | No | `[]` | — |
| `out` | `OutputField[]` | No | `[]` | — |

[JSON Schema](/reference/schemas/ToolSpec.json)
