Arcade · Schema

Arcade Execute Tool Response

AgentsMCPAI AgentsAuthorizationOAuthTool CallingAgent InfrastructureLLMIntegrations

Properties

Name Type Description
$schema string
execution_id string The globally-unique ID for this tool execution.
duration number The duration of the tool call, in milliseconds
finished_at string The timestamp when the tool execution finished.
success boolean Whether the tool execution was successful
output object
View JSON Schema on GitHub

JSON Schema

arcade-execute-tool-response-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "$schema": {
      "type": "string",
      "format": "uri"
    },
    "execution_id": {
      "type": "string",
      "description": "The globally-unique ID for this tool execution."
    },
    "duration": {
      "type": "number",
      "description": "The duration of the tool call, in milliseconds"
    },
    "finished_at": {
      "type": "string",
      "format": "date-time",
      "description": "The timestamp when the tool execution finished."
    },
    "success": {
      "type": "boolean",
      "description": "Whether the tool execution was successful"
    },
    "output": {
      "type": "object",
      "oneOf": [
        {
          "properties": {
            "value": {
              "description": "The value returned from the function",
              "oneOf": [
                { "type": "object", "additionalProperties": true },
                { "type": "number" },
                { "type": "string" },
                { "type": "boolean" }
              ]
            }
          },
          "required": ["value"],
          "additionalProperties": false
        },
        {
          "properties": {
            "error": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "description": "An error message that can be shown to the user or the AI model"
                },
                "developer_message": {
                  "type": "string",
                  "description": "An internal message that will be logged but will not be shown to the user or the AI model"
                },
                "can_retry": {
                  "type": "boolean",
                  "description": "Whether the tool call can be retried",
                  "default": false
                },
                "additional_prompt_content": {
                  "type": "string",
                  "description": "Additional content to be included in the retry prompt"
                },
                "retry_after_ms": {
                  "type": "integer",
                  "description": "The number of milliseconds (if any) to wait before retrying the tool call"
                }
              },
              "required": ["message"],
              "additionalProperties": false
            }
          },
          "required": ["error"],
          "additionalProperties": false
        },
        {
          "properties": {
            "requires_authorization": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The ID for checking the status of the authorization"
                },
                "url": {
                  "type": "string",
                  "format": "uri",
                  "description": "The URL to redirect the user to for authorization"
                },
                "scopes": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "The scopes that are required for authorization"
                },
                "status": {
                  "type": "string",
                  "description": "The status of the authorization"
                }
              },
              "required": ["id", "status"],
              "additionalProperties": false
            }
          },
          "required": ["requires_authorization"],
          "additionalProperties": false
        },
        {
          "properties": {
            "artifact": {
              "type": "object",
              "properties": {
                "url": {
                  "type": "string",
                  "format": "uri",
                  "description": "The location of the stored artifact"
                },
                "content_type": {
                  "type": "string",
                  "description": "The MIME Media Type of the data inside the artifact (e.g. text/csv or application/json)"
                },
                "size": {
                  "type": "integer",
                  "description": "The size of the artifact, in bytes"
                },
                "meta": {
                  "type": "object",
                  "properties": {
                    "description": {
                      "type": "string",
                      "description": "A descriptive, human-readable explanation of the data inside the artifact"
                    }
                  },
                  "required": ["description"],
                  "additionalProperties": false
                }
              },
              "required": ["url", "content_type", "size", "meta"],
              "additionalProperties": false
            }
          },
          "required": ["artifact"],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": ["invocation_id", "finished_at", "success"],
  "additionalProperties": false
}