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.
| YAML field | Type | Required | Default | Constraints |
|---|
poll | string | Yes | — | — |
interval_seconds | integer | Yes | — | minimum=1 |
timeout_seconds | integer | Yes | — | minimum=1 |
JSON Schema
| YAML field | Type | Required | Default | Constraints |
|---|
server | string | Yes | — | — |
tool | string | Yes | — | minLength=1 |
JSON Schema
| 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