Tool

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/hermoso-ai/json-schema/hermoso-ai-tool-schema.json",
  "title": "Tool",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/app_hermoso_ai_rest.json#/components/schemas/Tool",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "enum": [
        "tool"
      ]
    },
    "name": {
      "type": "string",
      "description": "Call it at POST /v1/tools/{name}."
    },
    "title": {
      "type": "string"
    },
    "area": {
      "type": [
        "string",
        "null"
      ],
      "description": "Which area of the product it belongs to. THIS SET MAY GROW — tolerate a member you have not seen."
    },
    "description": {
      "type": "string",
      "description": "What it does, written for whoever is choosing: a person reading the index or a model reading the roster."
    },
    "read_only": {
      "type": "boolean",
      "description": "It reads and changes nothing. Read-only tools are metered on the READ rate-limit budget."
    },
    "destructive": {
      "type": "boolean",
      "description": "It can remove or overwrite something. Destructive tools carry their own confirmation arguments — read the schema."
    },
    "idempotent": {
      "type": "boolean",
      "description": "Calling it twice with the same arguments has the same effect as calling it once. Independent of `Idempotency-Key`, which protects a retry regardless."
    },
    "requires_connector": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party account this tool needs linked, or null when it needs none. Linking is a browser flow: an OAuth consent screen cannot be completed headlessly."
    },
    "connector_connected": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether that connector is linked in this workspace. NULL means the connections could not be read, which is NOT the same as \"no\" — never render it as a refusal."
    },
    "rate_class": {
      "type": "string",
      "enum": [
        "read",
        "write"
      ],
      "description": "Which rate-limit budget a call to it spends."
    },
    "invoke": {
      "type": "object",
      "properties": {
        "method": {
          "type": "string"
        },
        "path": {
          "type": "string"
        }
      }
    },
    "input_schema": {
      "type": "object",
      "description": "JSON Schema for the request body of POST /v1/tools/{name}. The body IS the argument object."
    }
  }
}