Skip to Content

POST /tool/get

Get Tool

Get tool information using the canonical shared tool operation.

Request Body (GetToolApiRequest)

FieldTypeRequiredDescription
idstringNoTool unique identifier
tool_idstringNoLegacy alias for tool unique identifier
draft_idstringNoDraft unique identifier
snapshot_keystringNoCache snapshot key for consistent reads across related requests
namesapp__infra__tool__types__SectionFilterNoFilter options for names
descriptionsapp__infra__tool__types__SectionFilterNoFilter options for descriptions
flagsapp__infra__tool__types__SectionFilterNoFilter options for flags
argsapp__infra__tool__types__SectionFilterNoFilter options for args
arg_positionsapp__infra__tool__types__SectionFilterNoFilter options for arg positions
args_outputsapp__infra__tool__types__SectionFilterNoFilter options for arg outputs
permissionsapp__infra__tool__types__SectionFilterNoFilter options for permissions
instructionsapp__infra__tool__types__SectionFilterNoFilter options for instructions
departmentsapp__infra__tool__types__SectionFilterNoFilter options for departments

Response (GetToolApiResponse)

FieldTypeRequiredDescription
actor_namestringNoDisplay name of the current actor
tool_existsbooleanNoWhether the tool exists
can_editbooleanNoWhether the current user can edit
disabled_reasonstringNoReason editing is disabled
group_idstringNoGroup identifier for the tool
draft_namestringNoImmutable draft label from the active draft entry, when a draft_id was supplied. None for non-draft fetches.
tool_idstringNoTool identifier
show_ai_generatebooleanNoWhether AI generation is available
basic_show_ai_generatebooleanNoShow AI generate for basic step
args_show_ai_generatebooleanNoShow AI generate for args step
permissions_show_ai_generatebooleanNoShow AI generate for permissions step
pending_idsstring[]NoPending resource identifiers when available
namesToolNameResource[]NoName resources
descriptionsToolDescriptionResource[]NoDescription resources
flagsToolFlagResource[]NoFlag resources (one per flags_resource row, value=true/false)
argsToolArgResource[]NoArgument resources
arg_positionsToolArgPositionResource[]NoArgument position resources
args_outputsToolArgOutputResource[]NoArgument output resources
permissionsToolPermissionResource[]NoPermission resources
instructionsToolInstructionResource[]NoInstruction resources (single-select)
departmentsToolDepartmentResource[]NoDepartment resources
Last updated on