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.

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.

Related

Get Workspace Context