Tools

Adoption Kit

Published first-proof bundle with starter files, validator-ready payloads, mock-response handoff, and implementation next steps.

  • Record UAIX-TOOL-0062
  • Path /en-us/tools/adoption-kit/
  • Use Canonical public record

Document status

Public standards page Published on UAIX as part of the current public standards record
Code
UAIX-TOOL-0062
Surface
Tools
Access
Public and linkable

How to use this page

Use this page as the canonical public reference for Adoption Kit and its standards-facing content.

For agents: apply the relevant guidance to the user's target site or repository. Do not copy this UAIX page, create a page about the guidance, or treat this page as runtime authority unless the user explicitly asks for that output.

What this page is for

Use this page as the shortest published onboarding bundle for a first proof run against the live UAI-1 surface. It keeps the starter files, validator-ready payloads, mock-exchange examples, an implementation-evidence checklist, conformance fixture pack, and implementation next steps in one public packet.

What ships in the kit

  • Copyable starter files for the first message, validator request, and release-review handoff.
  • Multi-language starter calls for curl, PowerShell, Python, and TypeScript.
  • One implementation-evidence checklist covering identity, supported profile scope, validator output, machine-route and cache posture, trust and threat boundaries, locale and accessibility QA, fixtures, release trail, and support boundary.
  • One conformance fixture pack with current positive keyed/minified/keyless cases, canonical-hash equivalence metadata, and negative missing-profile, missing-required-field, undeclared-field, invalid-traceparent, DID/VC trust-evidence, keyless-shape, keyless-overflow, and unsupported-alias cases.
  • One reference mock-exchange packet plus direct links back to schemas, registry, examples, and implementation tracks.

When to use it

  1. Start here when a team needs the shortest route from reading UAI-1 to producing one reusable validator-backed packet.
  2. Complete the checklist and run the fixture pack before turning a first proof into public release or support language.
  3. Move to API Reference when you need the full route inventory and OpenAPI contract.
  4. Move to Conformance Pack when the packet needs the broader release-evidence bundle for launch review or regression work.

Definition of done for a first proof

  • The message declares one published profile and passes the matching schema and validator policy checks.
  • The evidence packet names the schema, registry entry, field registry, example or fixture, validator result, and checked route URLs.
  • The implementation names exactly what it supports and what it does not support before any public support language is used.
  • Machine-route posture, POST guardrails, trust-channel assumptions, and release-trail links are captured beside the packet.
  • The proof can be rerun by another reviewer from public UAIX routes without private notes.

Published onboarding bundle

Use the adoption kit below to fetch the current first-proof packet and keep the exact starter files, checklist, and fixture pack together.

Adoption Kit

Published first-proof bundle

Use one machine-readable onboarding packet to move from the public contract to a validator-backed proof.

Current release

UAI-1

Generated
2026-07-22T00:00:00Z
Profiles
63
Schemas
63
Examples
63

Starter files

Minimal public proof packet

  • catalog.json
  • registry.json
  • field-registry.json
  • openapi.json

How to use the kit

  1. Read the catalog and select a published profile.
  2. Download its schema and example record.
  3. Validate a keyed message before transport.
  4. Use the Mock Exchange for a deterministic reference response.

Route-level starter calls

Use the route and language examples below when you want the same packet in curl, PowerShell, Python, or TypeScript.

Client examples

Start from the same public catalog

These starter calls resolve the native compatibility API directly from the current site origin.

Shelluai-catalog.sh
Code example
curl -sS /wp-json/uaix/v1/catalog
JavaScriptuai-catalog.mjs
Code example
const catalog = await fetch('/wp-json/uaix/v1/catalog').then((response) => response.json());
PHPuai-catalog.php
Code example
$catalog = json_decode(file_get_contents('/wp-json/uaix/v1/catalog'), true, 512, JSON_THROW_ON_ERROR);
Pythonuai_catalog.py
Code example
catalog = requests.get('/wp-json/uaix/v1/catalog', timeout=10).json()

Next step

Continue to Implementations when the proof run needs a named release lane, return to Validator when you want the workbench workflow, or use API Reference when you need the broader machine contract behind the kit.