OnboardingStepHowTo
Authoritative machine-readable "how to complete this step" descriptor. A connector drives each pending step from this (call `tool` with `args`) instead of fabricating a non-existent `aimeat_onboarding_
Properties
| Name | Type | Description |
|---|---|---|
| actor | string | Who performs the action -- the agent calls a tool, or the server validates passively. |
| automatic | boolean | true when the server auto-ticks the step by reading real state (no dedicated confirm call). |
| gatesCompletion | boolean | Mirrors `required` -- true when this step gates onboarding completion. |
| validationMethod | string | |
| tool | stringnull | Exact MCP tool to call, or null for passive/server steps. |
| toolAlias | string | Optional local-connector convenience tool with the same effect (e.g. aimeat_offers_publish). |
| restEndpoint | objectnull | Underlying REST route for non-MCP clients; null for passive steps. |
| args | object | 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 |
| passiveNote | string | For tool === null steps, the condition under which the server auto-passes the step. |
JSON Schema
{
"$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."
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
curl "https://apis.io/api/v1/json-schemas/aimeat-io-onboarding-step-how-to"
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.