Skip to main content

List Agent Tools

List all tools available to the embedded agent including their impact level (read/write) and descriptions for discovering agent capabilities.

Discover all tools available to the embedded AI agent. Each tool declares its impact level — whether it performs a read-only operation or a mutation — so you can build permission-aware integrations. Use this endpoint to dynamically generate tool descriptions for external AI agents or to audit available capabilities.

Call this endpoint at startup to populate your integration's tool registry, or periodically to detect newly added capabilities. The response includes every tool the agent can invoke, with a stable name identifier, a human-readable description, and the impact classification.

The totalCount field gives the total number of tools available. Each tool's impact field follows a four-level severity scale: read, draft_mutation, live_mutation, and irreversible. Use these levels to build confirmation gates — for example, auto-approve read tools but require user confirmation for live_mutation and above.

Pair this with the Workspace Context endpoint to give your external AI agent both situational awareness (context) and available actions (tools). The tool names returned here are stable identifiers that can be referenced in custom orchestration logic or permission policies.

Impact levels follow a severity scale: read (no side effects), draft_mutation (creates drafts only), live_mutation (modifies live data), and irreversible (permanent changes like deletion). Use these to implement confirmation gates in your integration.
GET/v1/agent/tools

Response

Response fields

toolsarrayArray of tool descriptors.
tools[].namestringUnique tool identifier.
tools[].impactstringImpact level: read, draft_mutation, live_mutation, or irreversible.
tools[].descriptionstringHuman-readable description of what the tool does.
totalCountintegerTotal number of available tools.

Response

{
  "tools": [
    {
      "name": "list_schemas",
      "impact": "read",
      "description": "Lists all user-defined schemas."
    }
  ],
  "totalCount": 35
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.