Skip to main content
Glama

start_onboarding

Idempotent

Create the user's website. Saves the document as a private draft and returns an approvalUrl; give that link to the user, who signs in with this email and approves to publish. No account or email verification is needed on your side, and no email is sent.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "email": "<email>",
      "agentName": "<agentName>",
      "document": "<document>"
    },
    "name": "start_onboarding"
  }
}

Input Schema

NameRequiredDescriptionDefault
emailYes
documentYes
agentNameYes
idempotencyKeyNoOptional. Set a random key and reuse it exactly when retrying, so a retry is not applied twice

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed59 schema fields changed
    • addedInput schema / properties / document / properties / about / description
      Added value: +"Up to 4000 characters"
    • addedInput schema / properties / document / properties / about / maxLength
      Added value: +4000
    • addedInput schema / properties / document / properties / blockLayout / description
      Added value: +"The visual block layout (version 3). Start from get_site or the catalog; colours and shapes follow the catalog's blockColours and sectionShapes"
    • addedInput schema / properties / document / properties / bookingUrl / description
      Added value: +"An https:// booking link or empty, up to 1000 characters"
    • addedInput schema / properties / document / properties / bookingUrl / maxLength
      Added value: +1000
    • addedInput schema / properties / document / properties / businessName / description
      Added value: +"Up to 120 characters"
    • addedInput schema / properties / document / properties / businessName / maxLength
      Added value: +120
    • addedInput schema / properties / document / properties / description / description
      Added value: +"Up to 320 characters"
    • addedInput schema / properties / document / properties / description / maxLength
      Added value: +320
    • addedInput schema / properties / document / properties / email / description
      Added value: +"A contact email or empty, up to 254 characters"
    • addedInput schema / properties / document / properties / email / maxLength
      Added value: +254
    • addedInput schema / properties / document / properties / email / pattern
      Added value: +"^(?:[^\\s@<>]+@[^\\s@<>]+\\.[^\\s@<>]+)?$"
    • addedInput schema / properties / document / properties / gallery / description
      Added value: +"Up to 19 images"
    • addedInput schema / properties / document / properties / gallery / items / properties / alt / maxLength
      Added value: +240
    • addedInput schema / properties / document / properties / gallery / items / properties / assetId / description
      Added value: +"An assetId returned by upload_image or upload_image_from_url"
    • addedInput schema / properties / document / properties / gallery / items / properties / assetId / pattern
      Added value: +"^[a-f0-9-]{36}$"
    • addedInput schema / properties / document / properties / gallery / maxItems
      Added value: +19
    • addedInput schema / properties / document / properties / headline / description
      Added value: +"Up to 180 characters"
    • addedInput schema / properties / document / properties / headline / maxLength
      Added value: +180
    • addedInput schema / properties / document / properties / hours / description
      Added value: +"Up to 1000 characters"
    • addedInput schema / properties / document / properties / hours / maxLength
      Added value: +1000
    • addedInput schema / properties / document / properties / introduction / description
      Added value: +"Up to 1600 characters"
    • addedInput schema / properties / document / properties / introduction / maxLength
      Added value: +1600
    • changedInput schema / properties / document / properties / logo / anyOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "alt": {
      -        "type": "string"
      -      },
      -      "assetId": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "assetId",
      -      "alt"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "alt": {
      +        "maxLength": 240,
      +        "type": "string"
      +      },
      +      "assetId": {
      +        "description": "An assetId returned by upload_image or upload_image_from_url",
      +        "pattern": "^[a-f0-9-]{36}$",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "assetId",
      +      "alt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / document / properties / pages / items / properties / content / properties / about / description
      Added value: +"Up to 4000 characters"
    • addedInput schema / properties / document / properties / pages / items / properties / content / properties / about / maxLength
      Added value: +4000
    • addedInput schema / properties / document / properties / pages / items / properties / content / properties / gallery / description
      Added value: +"Up to 19 images"
    • addedInput schema / properties / document / properties / pages / items / properties / content / properties / gallery / items / properties / alt / maxLength
      Added value: +240
    • addedInput schema / properties / document / properties / pages / items / properties / content / properties / gallery / items / properties / assetId / description
      Added value: +"An assetId returned by upload_image or upload_image_from_url"
    • addedInput schema / properties / document / properties / pages / items / properties / content / properties / gallery / items / properties / assetId / pattern
      Added value: +"^[a-f0-9-]{36}$"
    • addedInput schema / properties / document / properties / pages / items / properties / content / properties / gallery / maxItems
      Added value: +19
    • addedInput schema / properties / document / properties / pages / items / properties / content / properties / headline / description
      Added value: +"Up to 180 characters"
    • addedInput schema / properties / document / properties / pages / items / properties / content / properties / headline / maxLength
      Added value: +180
    • addedInput schema / properties / document / properties / pages / items / properties / content / properties / introduction / description
      Added value: +"Up to 1600 characters"
    • addedInput schema / properties / document / properties / pages / items / properties / content / properties / introduction / maxLength
      Added value: +1600
    • addedInput schema / properties / document / properties / pages / items / properties / content / properties / services / description
      Added value: +"Up to 12 services of up to 180 characters"
    • addedInput schema / properties / document / properties / pages / items / properties / content / properties / services / items / maxLength
      Added value: +180
    • addedInput schema / properties / document / properties / pages / items / properties / content / properties / services / maxItems
      Added value: +12
    • addedInput schema / properties / document / properties / pages / items / properties / sections / description
      Added value: +"Each of hero, services, about, gallery, hours, area, contact once, in display order"
    • addedInput schema / properties / document / properties / pages / items / properties / sections / items / properties / id / enum
      Added value: +[
      +  "hero",
      +  "services",
      +  "about",
      +  "gallery",
      +  "hours",
      +  "area",
      +  "contact"
      +]
    • addedInput schema / properties / document / properties / pages / items / properties / sections / maxItems
      Added value: +7
    • addedInput schema / properties / document / properties / pages / items / properties / sections / minItems
      Added value: +7
    • changedInput schema / properties / document / properties / pages / items / properties / seo / properties / image / anyOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "alt": {
      -        "type": "string"
      -      },
      -      "assetId": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "assetId",
      -      "alt"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "alt": {
      +        "maxLength": 240,
      +        "type": "string"
      +      },
      +      "assetId": {
      +        "description": "An assetId returned by upload_image or upload_image_from_url",
      +        "pattern": "^[a-f0-9-]{36}$",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "assetId",
      +      "alt"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / document / properties / pages / items / properties / slug / description
      Added value: +"Empty for the Home page; otherwise lowercase words and hyphens"
    • addedInput schema / properties / document / properties / pages / items / properties / slug / pattern
      Added value: +"^(?:[a-z0-9]+(?:-[a-z0-9]+)*)?$"
    • addedInput schema / properties / document / properties / pages / items / properties / title / pattern
      Added value: +"\\S"
    • addedInput schema / properties / document / properties / phone / description
      Added value: +"Up to 40 characters"
    • addedInput schema / properties / document / properties / phone / maxLength
      Added value: +40
    • addedInput schema / properties / document / properties / sections / description
      Added value: +"Each of hero, services, about, gallery, hours, area, contact once, in display order"
    • addedInput schema / properties / document / properties / sections / items / properties / id / enum
      Added value: +[
      +  "hero",
      +  "services",
      +  "about",
      +  "gallery",
      +  "hours",
      +  "area",
      +  "contact"
      +]
    • addedInput schema / properties / document / properties / sections / maxItems
      Added value: +7
    • addedInput schema / properties / document / properties / sections / minItems
      Added value: +7
    • addedInput schema / properties / document / properties / serviceArea / description
      Added value: +"Up to 500 characters"
    • addedInput schema / properties / document / properties / serviceArea / maxLength
      Added value: +500
    • addedInput schema / properties / document / properties / services / description
      Added value: +"Up to 12 services of up to 180 characters"
    • addedInput schema / properties / document / properties / services / items / maxLength
      Added value: +180
    • addedInput schema / properties / document / properties / services / maxItems
      Added value: +12
    • addedInput schema / properties / document / properties / title / description
      Added value: +"Up to 160 characters"
    • addedInput schema / properties / document / properties / title / maxLength
      Added value: +160
  2. Changed7 schema fields changed
    • addedInput schema / properties / document / properties / colour / enum
      Added value: +[
      +  "forest",
      +  "ocean",
      +  "charcoal",
      +  "terracotta"
      +]
    • addedInput schema / properties / document / properties / font / enum
      Added value: +[
      +  "sans",
      +  "serif"
      +]
    • addedInput schema / properties / document / properties / industry / description
      Added value: +"Industry tag from the catalog"
    • addedInput schema / properties / document / properties / industry / enum
      Added value: +[
      +  "4x4-accessories",
      +  "accountant",
      +  "air-conditioning",
      +  "air-conditioning-cleaning",
      +  "aluminium-fabricators-and-repairers",
      +  "aluminium-windows",
      +  "appliance-repairs-and-parts",
      +  "arborist",
      +  "asbestos-removals",
      +  "asphalt-and-bitumen",
      +  "auto-electricians",
      +  "auto-parts",
      +  "auto-wreckers",
      +  "awnings",
      +  "balustrading",
      +  "barber",
      +  "bathroom-renovations",
      +  "batteries",
      +  "beauty-salons",
      +  "bike-shops",
      +  "blinds",
      +  "blocked-drains",
      +  "boat-sales-and-service",
      +  "bobcat-and-dingo-hire",
      +  "bookkeeper",
      +  "bore-drilling",
      +  "brake-and-clutch-repairs",
      +  "bricklayers-and-blocklayers",
      +  "builder",
      +  "building-and-home-renovations",
      +  "pest-inspector",
      +  "building-designers",
      +  "butchers",
      +  "cabinet-makers",
      +  "cafes",
      +  "car-air-conditioning",
      +  "car-transmissions",
      +  "car-wash-and-detailing",
      +  "caravan-repairs",
      +  "caravans-sales-and-parts",
      +  "carpenter",
      +  "carpet-cleaning",
      +  "carpet-stores",
      +  "caterers",
      +  "cctv-and-security-cameras",
      +  "chemists-and-pharmacies",
      +  "child-care-centres",
      +  "chiropractor",
      +  "civil-contractors",
      +  "cleaner",
      +  "coach-charters-and-bus-tours",
      +  "commercial-air-conditioning",
      +  "commercial-cleaners",
      +  "computer-repairs",
      +  "computer-sales-and-equipment",
      +  "concrete-cutting",
      +  "concrete-pre-mixed",
      +  "concrete-pumping-services",
      +  "concreter",
      +  "conveyancing",
      +  "cosmetic-services",
      +  "couriers",
      +  "crane-hire",
      +  "cremation",
      +  "curtains",
      +  "data-cabling-and-communications",
      +  "demolition-contractors",
      +  "dentist",
      +  "denture-clinics",
      +  "diesel-mechanics",
      +  "disability-care-services-and-support",
      +  "doctors-and-medical-centres",
      +  "dog-boarding-kennels",
      +  "dog-grooming",
      +  "driving-schools",
      +  "electrician",
      +  "equipment-hire",
      +  "excavating-and-earthmoving-equipment",
      +  "excavator-and-earthmoving-hire",
      +  "family-lawyers",
      +  "farm-machinery",
      +  "fencer",
      +  "fencing-supplies",
      +  "finance-brokers-loans-and-mortgages",
      +  "financial-planning",
      +  "fire-protection-services",
      +  "fitness-centres-and-gyms",
      +  "floor-sanding-and-polishing",
      +  "flooring-stores",
      +  "florists",
      +  "funeral-directors",
      +  "garage-doors",
      +  "gardeners",
      +  "gas-fitter",
      +  "gate-installation-and-repairs",
      +  "general-engineering",
      +  "gift-shops",
      +  "glass-repairs-and-replacements",
      +  "guttering-and-downpipes",
      +  "hairdresser",
      +  "handyman-services",
      +  "heavy-transport",
      +  "high-pressure-cleaners",
      +  "hoses-and-fittings-sales-and-repairs",
      +  "hot-water-systems",
      +  "hydraulics",
      +  "insurance-brokers",
      +  "irrigation-and-sprinkler-systems",
      +  "kitchen-renovations-and-installations",
      +  "land-surveyors",
      +  "landscape-supplies",
      +  "landscaper",
      +  "lawn-and-turf-supplies",
      +  "lawn-mowers",
      +  "lawn-mowing-services",
      +  "lawyer",
      +  "locksmith",
      +  "massage-therapists",
      +  "mechanic",
      +  "mobile-mechanic",
      +  "mortgage-brokers",
      +  "motorcycle-dealers",
      +  "mufflers-and-exhausts",
      +  "nurseries-and-garden-centres",
      +  "optometrist",
      +  "paint-supplies-and-accessories",
      +  "painter",
      +  "panel-beaters-and-smash-repairs",
      +  "party-hire",
      +  "patio-builders",
      +  "pest-control",
      +  "physiotherapist",
      +  "picture-framing",
      +  "plasterer",
      +  "plumber",
      +  "podiatrist",
      +  "pool-cleaning-and-maintenance",
      +  "pool-fencing",
      +  "pool-shops-and-supplies",
      +  "powder-coating",
      +  "printing-services",
      +  "property-management",
      +  "pumps-sales-and-repairs",
      +  "quarries",
      +  "real-estate-agents",
      +  "refrigeration",
      +  "removalists",
      +  "restaurants",
      +  "retaining-and-rock-walls",
      +  "roadworthy-and-safety-certificates",
      +  "roof-painting",
      +  "roof-restorations-and-repairs",
      +  "roofer",
      +  "rubbish-removal",
      +  "sand-soil-and-gravel-supplies",
      +  "scaffolding-sales-and-hire",
      +  "scrap-metal-merchants",
      +  "security-doors-and-screens",
      +  "security-guards-and-patrolling-services",
      +  "security-systems",
      +  "self-storage",
      +  "septic-tank-cleaning-and-servicing",
      +  "septic-tank-sales-and-installation",
      +  "shade-sails-and-structures",
      +  "sheds",
      +  "sheet-metal-fabricators",
      +  "shock-absorbers-and-suspension",
      +  "shower-screens",
      +  "shutters",
      +  "sign-shops",
      +  "skip-bin-hire",
      +  "slashing-contractors",
      +  "solar-power-systems",
      +  "steel-fabrication",
      +  "steel-suppliers",
      +  "swimming-pool-builders",
      +  "takeaway-food",
      +  "tax-accountants",
      +  "termite-treatment",
      +  "tile-shops",
      +  "tiler",
      +  "timber-supplies",
      +  "towing-services",
      +  "trade-supplies",
      +  "transport-services",
      +  "tree-and-stump-removal",
      +  "truck-and-bus-repairs",
      +  "tv-antenna-installations",
      +  "tyres",
      +  "upholsterers",
      +  "used-car-dealers",
      +  "vacuum-excavation",
      +  "vet",
      +  "wardrobes",
      +  "water-cartage",
      +  "welders",
      +  "wheel-alignment-and-balancing",
      +  "window-tinting",
      +  "windscreen-repairs-and-replacements",
      +  "workwear",
      +  "jewellers",
      +  "prestige-car-dealers",
      +  "luxury-watch-dealers",
      +  "yacht-and-marine-dealers",
      +  "art-galleries",
      +  "luxury-fashion-boutiques",
      +  "cosmetic-surgery",
      +  "luxury-furniture-and-interiors",
      +  "beef-cattle-farming",
      +  "agricultural-support-services",
      +  "motels",
      +  "caravan-parks",
      +  "it-support-companies",
      +  "web-development-agencies",
      +  "video-production-companies",
      +  "service-stations",
      +  "online-retailers",
      +  "industrial-supplies-wholesalers",
      +  "craft-breweries",
      +  "commercial-bakeries",
      +  "joinery-cabinet-manufacturers",
      +  "early-learning-centres",
      +  "aged-care-providers",
      +  "freight-forwarding-services",
      +  "aquaculture-farms",
      +  "logging-contractors",
      +  "commercial-fishing-operators",
      +  "clothing-manufacturers",
      +  "boat-builders",
      +  "liquor-wholesalers",
      +  "fruit-vegetable-wholesalers",
      +  "wholesale-agents-brokers",
      +  "scenic-tour-operators",
      +  "software-companies",
      +  "online-media-publishers",
      +  "web-hosting-cloud-services",
      +  "recruitment-agencies",
      +  "travel-agencies",
      +  "creative-performing-arts",
      +  "pubs-and-bars",
      +  "landscapers",
      +  "earthmoving-excavation-contractors",
      +  "advertising-marketing-agencies",
      +  "photographers",
      +  "graphic-designers",
      +  "management-consultants",
      +  "consulting-engineers",
      +  "car-rental-companies",
      +  "dry-cleaners-laundromats",
      +  "appliance-stores",
      +  "swim-schools",
      +  "music-dance-schools",
      +  "greengrocers",
      +  "event-management-companies",
      +  "coal-mining-companies",
      +  "oil-gas-companies",
      +  "metal-ore-miners",
      +  "mining-services-contractors",
      +  "paper-pulp-manufacturers",
      +  "petroleum-product-manufacturers",
      +  "cleaning-product-manufacturers",
      +  "plastics-manufacturers",
      +  "metal-manufacturers",
      +  "energy-retailers",
      +  "gas-suppliers",
      +  "water-treatment-supply",
      +  "rail-operators",
      +  "shipping-companies",
      +  "air-charter-operators",
      +  "radio-tv-broadcasters",
      +  "telecommunications-providers",
      +  "libraries-archives",
      +  "non-bank-lenders",
      +  "insurance-companies",
      +  "local-government-councils",
      +  "defence-suppliers",
      +  "training-colleges-rtos",
      +  "private-hospitals-day-surgeries",
      +  "museums-galleries",
      +  "gaming-venues"
      +]
    • addedInput schema / properties / document / properties / template / enum
      Added value: +[
      +  "local",
      +  "studio",
      +  "professional",
      +  "workshop",
      +  "hospitality",
      +  "care"
      +]
    • changedInput schema / properties / idempotencyKey / description
      Previous value: -"Unique random key for this operation; reuse exactly when retrying"New value: +"Optional. Set a random key and reuse it exactly when retrying, so a retry is not applied twice"
    • changedInput schema / required
      Previous value: -[
      -  "email",
      -  "agentName",
      -  "document",
      -  "idempotencyKey"
      -]New value: +[
      +  "email",
      +  "agentName",
      +  "document"
      +]
  3. First observed

TDQS

A3.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already establish a non-destructive, idempotent, closed-world mutation. The description adds genuinely new behavior: the result is a private draft, the return value is an approvalUrl, no email is dispatched, and no account or verification step is required on the caller's side. It does not explain what happens if the user never approves or whether repeated calls create duplicates.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences, front-loaded with the action and outcome, followed by the required caller follow-up and the negative guarantees. Every sentence carries information; only minor tightening is possible.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool whose payload is a large nested document schema with no output schema, the description covers the call outcome and caller obligations well. It leaves out differentiation from sibling write tools and the lifecycle after approval, which an agent would still need to infer.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 25%, so the description should carry more weight. It clarifies that `email` is the identity the user signs in with and that `document` becomes a private draft, but `agentName` and `idempotencyKey` (the retry-safety parameter) are never mentioned, leaving two of four parameters unaddressed.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a concrete verb and resource ("Create the user's website") and adds the key outcome (private draft plus an approvalUrl). It does not, however, distinguish this from close siblings like create_site, save_site, or exchange_onboarding, which an agent could easily confuse it with.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The post-call workflow is spelled out (hand the approvalUrl to the user, who signs in with this email and approves), which implies this is the onboarding entry point. But there is no explicit statement of when to prefer this over create_site/save_site, nor any exclusion or prerequisite guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources