VocalDocscontracts 1.65.0

Tool

A Tool (1.49.0): a function the model may call, http or function. Calls run the copy an Agent version froze at publish, never the Tool itself.

An object with 18 fields.

Fields

FieldTypeRequiredDescription
annotationsToolAnnotationsyes
archived_atTimestamp or nullyesWhen DELETE archived the Tool, or null. An archived Tool takes no write and no test (409 tool_archived) and cannot be attached; the Agent versions that froze it keep running it.
created_atTimestampyes
definition_sha256stringyesThe SHA-256 of the canonical definition without the auth secret, in lowercase hex; equal to a PinnedTool's when the Agent version froze this revision's definition.
descriptionstringyesModel-facing: what the Tool does and when to use it.
fillerToolFiller or nullyes
httpHttpToolConfig or nullyesThe request of an http Tool; null otherwise.
idToolIdyes
idempotentbooleanyes
nameToolNameyes
object"tool"yes
organization_idOrganizationIdyes
parametersToolParametersyes
response_schemaToolResponseSchema or nullyes
revisionintegeryesCounts writes to the Tool; returned as the ETag and required in If-Match.
timeout_msintegeryesThe deadline of one invocation, in milliseconds.
typeToolTypeyes
updated_atTimestampyes

Used by

The operations whose parameters, request body or responses name this shape directly.