Agents Tools
Manage Dash Agents -- AI-powered automation agents that perform tasks on your behalf. List agents, view their configuration, trigger manual runs, check run history, and enable or disable agents.
Required scope: agents:read for read tools, agents:write for write tools
Tools Overview
| Tool | Description | Read-only? |
|---|---|---|
list_agents | List all Dash Agents with optional filters | Yes |
get_agent | Get details of a specific agent | Yes |
run_agent | Trigger a manual run of an agent | No |
get_agent_runs | Get run history for an agent | Yes |
toggle_agent | Enable or disable an agent | No |
list_agents
List all Dash Agents for this supplier. Returns agent names, statuses, trigger types, and run stats.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
search | string | No | Search by agent name or description |
trigger_type | string | No | Filter by trigger type: manual, schedule, or event |
status | string | No | Filter by status: enabled or disabled |
Example
"List all my scheduled agents"
The AI calls list_agents with trigger_type: "schedule".
get_agent
Get details of a specific Dash Agent including its configuration, tools, trigger settings, and recent run history.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
agent_id | integer | Yes | The ID of the agent to retrieve |
Example
"Show me the details for agent 5"
run_agent
Trigger a manual run of a Dash Agent. The agent will execute in the background.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
agent_id | integer | Yes | The ID of the agent to run |
Example
"Run the Daily Summary Agent"
The AI looks up the agent by name, then calls run_agent with the matching ID.
An agent can only have one active run at a time. If the agent is already running or is disabled, the tool will return an error.
get_agent_runs
Get the run history for a Dash Agent. Returns recent runs with status, summary, and token usage.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
agent_id | integer | Yes | The ID of the agent |
status | string | No | Filter by run status: running, awaiting_approval, completed, failed, cancelled, timed_out |
limit | integer | No | Number of results (default 10, max 50) |
Example
"Show me the last 5 failed runs for agent 3"
The AI calls get_agent_runs with agent_id: 3, status: "failed", limit: 5.
toggle_agent
Enable or disable a Dash Agent. Disabled agents will not run on schedule or respond to events.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
agent_id | integer | Yes | The ID of the agent to toggle |
Example
"Disable the Late Return Monitor agent"
The AI looks up the agent by name, then calls toggle_agent to disable it.
Related
- Bookings Tools - Booking management tools agents commonly use
- Reports Tools - Reporting tools for agent-generated summaries