au3 api — Command Reference¶
CLI command group: au3 api
Commands for exploring and executing API commands, viewing DTOs, generating an ERD of API entities, and running/listing MCP tools for the ADS API.
Sections¶
| Section | Commands |
|---|---|
| Command | 4 |
| DTO | 3 |
| ERM | 2 |
| MCP | 3 |
au3 api command¶
au3 api command list¶
List Commands
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 api command view¶
View Command
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | command id | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 api command exec¶
Exec Command
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | command id | |
--argument |
string | argument in JSON/YAML format or path to file containing argument | ||
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 api dto¶
au3 api dto list¶
List DTOs
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--include |
string | List of DTOs to include | ||
--exclude |
string | List of DTOs to exclude | ||
--full |
boolean | false | Whether to print the full content of each schema | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 api dto view¶
View DTOs
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--id |
string | ✅ | dto id | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 api erm¶
au3 api erm erd¶
Generate ERD of API entities
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--include |
string | List of entities to include | ||
--exclude |
string | List of entities to exclude | ||
--mode |
enum | no-fields | Include all fields Choices: "no-fields", "ref-fields", "all-fields" | |
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 api mcp¶
au3 api mcp list-tools¶
List available MCP tools for the consumption layer
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--tool-filter |
string | tool filter in JSON/YAML format or path to file containing filter | ||
--fields |
string | comma-separate list of fields to display | ||
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
au3 api mcp run¶
Run an MCP server for the ADS API
| Option | Type | Required | Default | Notes |
|---|---|---|---|---|
--port |
✅ | port to listen on | ||
--external-host |
string | hostname of the external interface | ||
--secure |
boolean | false | whether to use HTTPS | |
--use-tb-auth |
boolean | true | whether to use toolbelt token & context | |
--drain-ttl |
30000 | TTL to wait for active connections to drain | ||
--log-level |
enum | debug | Log level Choices: "fatal", "error", "warn", "info", "debug", "trace" | |
--tool-filter |
string | tool filter in JSON/YAML format or path to file containing filter | ||
--redirect-uris |
string | Allowed redirect URIs for OAuth clients | ||
--fmt |
enum | human | Output format Choices: "human", "json", "yaml" | |
--debug |
boolean | false | Enable more verbose output on error |
Generated from au3 api --help and subcommand help output.