az agent tool docs
Inspect command-help metadata or rebuild the local catalog used by the Agent.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az agent tool docs generate |
Rebuild the local help catalog used by AI recovery and command-help lookups. |
Core | Preview |
| az agent tool docs list |
List discoverable commands from the local help catalog. |
Core | Preview |
| az agent tool docs show |
Look up a command's metadata from the local help catalog. |
Core | Preview |
az agent tool docs generate
Rebuild the local help catalog used by AI recovery and command-help lookups.
az agent tool docs generate rebuilds the local help catalog from the currently discoverable bundled and installed extensions. It uses the CLI's extension version selection and registry pins, then publishes validated catalog files under ~/.azclips/agent/help/. On success, the command returns JSON with generated: true and the number of discovered commands. It does not call a model or query Azure resources.
az agent tool docs generate
Examples
Rebuild the help catalog
az agent tool docs generate
Global Parameters
Increase logging verbosity to show all debug logs.
Show help for the command or group and exit.
Bypass the extension discovery cache and reload extensions from disk.
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, table, tsv, yaml, yamlc |
JMESPath query string to filter/project the command result before rendering.
az agent tool docs list
List discoverable commands from the local help catalog.
az agent tool docs list shares the local catalog reader used by the Agent and returns a JSON index of all known commands. Missing, stale, or corrupt catalog files are regenerated on demand. External AI tools use this metadata to discover commands before proposing plans.
az agent tool docs list
Examples
List all known commands
az agent tool docs list
Rebuild the local help catalog
az agent tool docs generate
Global Parameters
Increase logging verbosity to show all debug logs.
Show help for the command or group and exit.
Bypass the extension discovery cache and reload extensions from disk.
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, table, tsv, yaml, yamlc |
JMESPath query string to filter/project the command result before rendering.
az agent tool docs show
Look up a command's metadata from the local help catalog.
az agent tool docs show shares the local catalog reader used by the Agent. The required --name argument selects a command whose full metadata is returned as JSON, including parameters, aliases, required flags, and extension owner. Missing, stale, or corrupt catalog files are regenerated on demand. External AI tools use this metadata to validate command syntax before proposing plans, avoiding hallucinated flags. Use az agent tool docs list to list all known commands.
az agent tool docs show --name
Examples
Look up metadata for a specific command
az agent tool docs show --name "vm create"
Rebuild the local help catalog
az agent tool docs generate
Required Parameters
Command name to look up (e.g. 'vm create').
Global Parameters
Increase logging verbosity to show all debug logs.
Show help for the command or group and exit.
Bypass the extension discovery cache and reload extensions from disk.
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, table, tsv, yaml, yamlc |
JMESPath query string to filter/project the command result before rendering.