POST /tool/get
Get Tool
Get tool information using the canonical shared tool operation.
Request Body (GetToolApiRequest)
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Tool unique identifier |
tool_id | string | No | Legacy alias for tool unique identifier |
draft_id | string | No | Draft unique identifier |
snapshot_key | string | No | Cache snapshot key for consistent reads across related requests |
names | app__infra__tool__types__SectionFilter | No | Filter options for names |
descriptions | app__infra__tool__types__SectionFilter | No | Filter options for descriptions |
flags | app__infra__tool__types__SectionFilter | No | Filter options for flags |
args | app__infra__tool__types__SectionFilter | No | Filter options for args |
arg_positions | app__infra__tool__types__SectionFilter | No | Filter options for arg positions |
args_outputs | app__infra__tool__types__SectionFilter | No | Filter options for arg outputs |
permissions | app__infra__tool__types__SectionFilter | No | Filter options for permissions |
instructions | app__infra__tool__types__SectionFilter | No | Filter options for instructions |
departments | app__infra__tool__types__SectionFilter | No | Filter options for departments |
Response (GetToolApiResponse)
| Field | Type | Required | Description |
|---|---|---|---|
actor_name | string | No | Display name of the current actor |
tool_exists | boolean | No | Whether the tool exists |
can_edit | boolean | No | Whether the current user can edit |
disabled_reason | string | No | Reason editing is disabled |
group_id | string | No | Group identifier for the tool |
draft_name | string | No | Immutable draft label from the active draft entry, when a draft_id was supplied. None for non-draft fetches. |
tool_id | string | No | Tool identifier |
show_ai_generate | boolean | No | Whether AI generation is available |
basic_show_ai_generate | boolean | No | Show AI generate for basic step |
args_show_ai_generate | boolean | No | Show AI generate for args step |
permissions_show_ai_generate | boolean | No | Show AI generate for permissions step |
pending_ids | string[] | No | Pending resource identifiers when available |
names | ToolNameResource[] | No | Name resources |
descriptions | ToolDescriptionResource[] | No | Description resources |
flags | ToolFlagResource[] | No | Flag resources (one per flags_resource row, value=true/false) |
args | ToolArgResource[] | No | Argument resources |
arg_positions | ToolArgPositionResource[] | No | Argument position resources |
args_outputs | ToolArgOutputResource[] | No | Argument output resources |
permissions | ToolPermissionResource[] | No | Permission resources |
instructions | ToolInstructionResource[] | No | Instruction resources (single-select) |
departments | ToolDepartmentResource[] | No | Department resources |
Last updated on