Arcade · Schema

Arcade Engine ToolResponse

JSON Schema for the Arcade Engine ToolResponse resource, extracted from the public Arcade OpenAPI 3.0 spec at https://api.arcade.dev/v1/swagger.

AgentsMCPAI AgentsAuthorizationOAuthTool CallingAgent InfrastructureLLMIntegrations

Properties

Name Type Description
description string
formatted_schema object
fully_qualified_name string
input object
metadata object
name string
output object
qualified_name string
requirements object
toolkit object
View JSON Schema on GitHub

JSON Schema

arcade-engine-tool-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-evangelist/arcade/json-schema/arcade-engine-tool-response-schema.json",
  "title": "Arcade Engine ToolResponse",
  "description": "JSON Schema for the Arcade Engine ToolResponse resource, extracted from the public Arcade OpenAPI 3.0 spec at https://api.arcade.dev/v1/swagger.",
  "type": "object",
  "required": [
    "fully_qualified_name",
    "input",
    "name",
    "qualified_name",
    "toolkit"
  ],
  "properties": {
    "description": {
      "type": "string"
    },
    "formatted_schema": {
      "type": "object",
      "additionalProperties": {}
    },
    "fully_qualified_name": {
      "type": "string"
    },
    "input": {
      "type": "object",
      "properties": {
        "parameters": {
          "type": "array",
          "minItems": 0,
          "items": {
            "type": "object",
            "required": [
              "name",
              "value_schema"
            ],
            "properties": {
              "description": {
                "type": "string"
              },
              "inferrable": {
                "type": "boolean",
                "default": true
              },
              "name": {
                "type": "string"
              },
              "required": {
                "type": "boolean"
              },
              "value_schema": {
                "$ref": "#/components/schemas/schemas.ValueSchema"
              }
            }
          }
        }
      }
    },
    "metadata": {
      "type": "object",
      "properties": {
        "behavior": {
          "type": "object",
          "properties": {
            "destructive": {
              "type": "boolean"
            },
            "idempotent": {
              "type": "boolean"
            },
            "open_world": {
              "type": "boolean"
            },
            "operations": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "read_only": {
              "type": "boolean"
            }
          }
        },
        "classification": {
          "type": "object",
          "properties": {
            "service_domains": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "extras": {
          "type": "object",
          "additionalProperties": {}
        }
      }
    },
    "name": {
      "type": "string"
    },
    "output": {
      "type": "object",
      "properties": {
        "available_modes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "description": {
          "type": "string"
        },
        "value_schema": {
          "type": "object",
          "required": [
            "val_type"
          ],
          "properties": {
            "enum": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "inner_val_type": {
              "type": "string"
            },
            "val_type": {
              "type": "string"
            }
          }
        }
      }
    },
    "qualified_name": {
      "type": "string"
    },
    "requirements": {
      "type": "object",
      "properties": {
        "authorization": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "oauth2": {
              "$ref": "#/components/schemas/schemas.OAuth2AuthorizationRequirement"
            },
            "provider_id": {
              "type": "string"
            },
            "provider_type": {
              "type": "string"
            },
            "status": {
              "default": "disabled",
              "allOf": [
                {
                  "$ref": "#/components/schemas/auth.Status"
                }
              ]
            },
            "status_reason": {
              "type": "string"
            },
            "token_status": {
              "$ref": "#/components/schemas/auth.AuthorizationStatus"
            }
          }
        },
        "met": {
          "type": "boolean",
          "default": false
        },
        "secrets": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "key"
            ],
            "properties": {
              "key": {
                "type": "string"
              },
              "met": {
                "type": "boolean",
                "default": false
              },
              "status_reason": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "toolkit": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "description": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "version": {
          "type": "string"
        }
      }
    }
  }
}