Skip to main content
GET
Python

Authorizations

Authorization
string
header
required

Enter your JWT token

Path Parameters

toolSlug
string
required

The slug identifying the tool to retrieve.

Query Parameters

applicationSlug
string | null

Optional parent-application slug used to disambiguate when the same tool slug exists across applications.

toolsetId
string | null

Optional toolset id; when supplied, a slug naming one of the caller's workflows in that toolset resolves to the workflow-tool detail.

connectionId
integer<int32> | null

Optional connection id; when supplied, field-option enums (e.g. the object list) in the input schema come from that connection instead of the caller's default. Must belong to the caller's account and the tool's application.

Response

The detailed representation of the tool.

Detail view returned by GET /v1/applications/{slug}/... Extends ToolDTO with the embedded input/output schemas and the supports* flags AI agents inspect before composing a tool call.

toolSlug
string
required

Public identifier, sourced from Activity.McpToolName.

category
string
required

Category the tool belongs to.

applicationSlug
string
required

Slug of the application this tool belongs to.

isDeprecated
boolean
required

Whether the tool is deprecated.

toolName
string | null

Human-readable display name of the tool.

description
string | null

Description of what the tool does.

applicationName
string | null

Display name of the application this tool belongs to.

version
string | null

Version of the tool.

accessClass
string | null

Advisory access class: read, write or destructive, derived from the connector author's HTTP method (DELETE is destructive, GET/HEAD read, anything else write; an activity with no method whose name reads as a delete is destructive). Null for workflow tools and trigger activities. Not a permission: nothing enforces it at execute time.

workspace
object | null

The workspace the tool's workflow belongs to; null for a row that predates workspaces. Only a workflow-backed tool has one; a tool of an application's catalog belongs to no workspace, so both are null.

environment
object | null

The environment (of Workspace) the tool's workflow belongs to; null for a row that predates workspaces.

inputSchema
any | null

JSON Schema describing the tool's input fields.

outputSchema
any | null

JSON Schema describing the tool's output shape.

supportsFilters
boolean

Whether the tool supports filter conditions on execution.

supportsSort
boolean

Whether the tool supports sort ordering on execution.

supportsTopOffset
boolean

Whether the tool supports top/offset pagination on execution.

maxFilters
integer<int32>

Maximum number of filter conditions allowed per execution.

maxSorts
integer<int32>

Maximum number of sort clauses allowed per execution.