{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/aimeat-io/json-schema/aimeat-io-onboarding-step-how-to-schema.json",
  "title": "OnboardingStepHowTo",
  "description": "Authoritative machine-readable \"how to complete this step\" descriptor. A connector drives\neach pending step from this (call `tool` with `args`) instead of fabricating a non-existent\n`aimeat_onboarding_<stepId>` tool. The only onboarding-prefixed tools that exist are the five\naimeat_onboarding_* tools; every other step is completed by calling its mapped real tool.\n",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aimeat-io-agent-onboarding-api-openapi.yml#/components/schemas/OnboardingStepHowTo",
  "type": "object",
  "properties": {
    "actor": {
      "type": "string",
      "enum": [
        "agent",
        "server"
      ],
      "description": "Who performs the action -- the agent calls a tool, or the server validates passively."
    },
    "automatic": {
      "type": "boolean",
      "description": "true when the server auto-ticks the step by reading real state (no dedicated confirm call)."
    },
    "gatesCompletion": {
      "type": "boolean",
      "description": "Mirrors `required` -- true when this step gates onboarding completion."
    },
    "validationMethod": {
      "type": "string",
      "enum": [
        "automatic",
        "api_call",
        "owner_confirm"
      ]
    },
    "tool": {
      "type": [
        "string",
        "null"
      ],
      "description": "Exact MCP tool to call, or null for passive/server steps."
    },
    "toolAlias": {
      "type": "string",
      "description": "Optional local-connector convenience tool with the same effect (e.g. aimeat_offers_publish)."
    },
    "restEndpoint": {
      "type": [
        "object",
        "null"
      ],
      "description": "Underlying REST route for non-MCP clients; null for passive steps.",
      "properties": {
        "method": {
          "type": "string",
          "enum": [
            "GET",
            "POST",
            "PUT",
            "PATCH"
          ]
        },
        "path": {
          "type": "string"
        }
      }
    },
    "args": {
      "type": "object",
      "additionalProperties": true,
      "description": "Copyable argument template. `{name}` and `{test_task_id}` are both substituted server-side (the placeholder only survives when no test task exists yet); `{test_task_id}` is also mirrored in hints.test_task_id."
    },
    "passiveNote": {
      "type": "string",
      "description": "For tool === null steps, the condition under which the server auto-passes the step."
    }
  }
}