tool:read, granted by the platform API key scope tools.read.
Path parameters
This endpoint does not define query parameters or a request body.
Authentication
Use one of the supported credentials:x-api-key: abl_...for a platform API key.Authorization: Bearer <abl_... | JWT>for a platform API key or Studio user JWT.auth: <assertion>for a JWT App assertion.
pk_...) are not accepted. The JWT App assertion must be sent in the auth header, not the Authorization header.
Response
A successful response containssuccess and data. The data object includes the tool’s summary properties and an input property containing the JSON Schema for caller-supplied parameters.
The response can include the following properties:
The
unsupportedReason value is one of TOOL_TYPE_DISABLED, TOOL_DEFINITION_INVALID, WSDL_BINDING_DISABLED, MCP_SERVER_NOT_CONFIGURED, TABLE_SCOPE_UNSUPPORTED, ASYNC_BINDING_UNSUPPORTED, or RESERVED_PARAMETER_NAME.
Input schema behavior
Theinput schema includes only caller-suppliable parameters. Parameters resolved by the platform are omitted rather than published as caller inputs.
For an Agent Table tool without a query template, the schema describes the structured call accepted by the executor. This includes op and the operands applicable to the selected operation. Only op is unconditionally required. The applicability of other operands depends on the selected operation.
A tool whose definition cannot be parsed can still be returned. In that case, executable is false, and unsupportedReason is TOOL_DEFINITION_INVALID.
Use the returned schema to construct the params object for Execute a specific tool.
Errors
The
429 response uses a rate-limiter-specific response format rather than the standard API error envelope. Check the response headers for rate-limit information and retry guidance.