Tools

Tools

Validator, discovery, field-registry, and review tools that help teams test and adopt UAI-1.

  • Record UAIX-TOOL-0059
  • Path /en-us/tools/
  • Use Canonical public record

Document status

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

How to use this page

Use this page as the canonical public reference for Tools 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.

Tooling

UAIX tools support validation, inspection, field-order governance, transport and trust review, fixture testing, machine-readable discovery, and implementation onboarding for UAI-1.

What tools should help with

  • Resolve the current public record without scraping page text.
  • Inspect schema targets, profile IDs, field order, fixtures, transport bindings, trust channels, error codes, and conformance expectations before release.
  • Surface structural drift, async workflow mistakes, trace-context problems, and trust-policy gaps before downstream users depend on them.
  • Export conformance outcomes as reviewable records that can travel into release notes, CI logs, or audit evidence.

Primary tooling path

Most readers should start with the Validator, then move back to Examples or forward into Implementations depending on whether the next need is debugging or release evidence.

WordPress memory-management surface

UAI Memory Management is the UAIX.org WordPress admin package for keeping live .uai memory, Advanced Persona files, existing docs/ and wiki/ memory surfaces, guarded update prompts, and Project Handoff exports aligned. Use it when a WordPress site needs humans and agents to see stale, oversized, duplicated, or missing memory before that drift pollutes future context.

Experimental dogfood surface

UAIX Agents Protocol remains the legacy dogfood record for the same plugin lineage, ZIP preflight checks, validation-failure refusal, cleanup, and activation smoke evidence. Treat that route as historical evidence; use UAI Memory Management for the current public admin-plugin surface.

Hello-world conformance path

  1. Choose one published Example or prepare one candidate message tied to a known public profile.
  2. Resolve the matching schema, registry, field-order, transport, trust, and error records before running the check so another reviewer can reproduce the same packet.
  3. Run the Validator and export the result as a reviewable record.
  4. Carry that result into Implementations, the Changelog, News, and References and Contributors when the check supports a public release or support claim.
  5. Repeat the run whenever schemas, registry mappings, field order, transport guidance, error codes, validator behavior, or runtime mappings change.

Published starter path

Use the public proof run and client calls below when the next task is onboarding a tool, script, or QA flow to the live public surface without private helpers.

First message

Run one reproducible UAI-1 proof

Start with a published fixture, validate the exact profile, then keep the result with release evidence.

Step 1

Read the catalog and select a published profile.

Step 2

Download its schema and example record.

Step 3

Validate a keyed message before transport.

Step 4

Use the Mock Exchange for a deterministic reference response.

Starter packetuai-first-packet.json
Code example
{
    "uai_version": "1.0",
    "profile": "uai.intent.request.v1",
    "message_id": "msg-2026-04-22-0001",
    "source": {
        "type": "agent",
        "id": "agent.alpha",
        "label": "Agent Alpha",
        "uri": "https://agents.alpha.example/runtime",
        "did": "did:web:agents.alpha.example",
        "role": "requesting-agent",
        "implementation": "alpha-runtime-2.4.1"
    },
    "target": {
        "type": "service",
        "id": "uaix.gateway",
        "label": "UAIX Gateway",
        "uri": "/wp-json/uaix/v1/discovery",
        "did": "did:web:uaix.org",
        "role": "public-record-gateway",
        "implementation": "uaix-core-0.4.0"
    },
    "conversation": {
        "conversation_id": "conv-2026-04-22-uaix-001",
        "turn_id": "turn-001",
        "traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
        "sequence": 1
    },
    "delivery": {
        "mode": "async",
        "priority": "interactive",
        "expires_at": "2026-04-22T16:05:00Z",
        "reply_requested": true,
        "ack_required": true
    },
    "trust": {
        "channel": "credentialed",
        "auth_scheme": "did+vc",
        "principal": "did:web:agents.alpha.example",
        "credential_ref": "https://agents.alpha.example/credentials/uai-interop.json",
        "signature_ref": "https://agents.alpha.example/signatures/msg-2026-04-22-0001.jws",
        "replay_window_id": "rw-2026-04-22-0001",
        "trust_profile": "uai.trust.did-vc-reference.v1",
        "verification_status": "not_verified",
        "credential_status": "not_checked",
        "verifier_ref": "https://agents.alpha.example/verifiers/uai-trust-policy.json",
        "trust_root_ref": "https://agents.alpha.example/.well-known/uai.json",
        "proof_ref": "https://agents.alpha.example/signatures/msg-2026-04-22-0001.jws",
        "replay_policy_ref": "https://agents.alpha.example/trust/replay-policy.json",
        "verification_checked_at": "2026-04-22T16:00:00Z",
        "verification_expires_at": "2026-04-22T16:05:00Z",
        "assurance_level": "reference_only"
    },
    "body": {
        "intent": "resolve-profile",
        "subject": "uai.task.status.v1",
        "requested_profile": "uai.task.status.v1",
        "parameters": {
            "include_schema": true,
            "include_example": true,
            "include_field_registry": true
        },
        "constraints": [
            "public-record-only",
            "trace-linked",
            "validator-ready"
        ],
        "response_profile": "uai.intent.response.v1"
    },
    "provenance": {
        "trace_id": "trace-7f3a2d",
        "parent_trace_id": "trace-root-uaix-2026",
        "issued_at": "2026-04-22T16:00:00Z",
        "log_ref": "urn:uaix:log:2026:0001",
        "agent_id": "agent.alpha",
        "model_id": "model.alpha.reasoner-2",
        "confidence": 0.98,
        "lineage": [
            {
                "stage": "request-composition",
                "actor_id": "agent.alpha",
                "model_id": "model.alpha.reasoner-2",
                "note": "Requested the async task-status profile and matching field registry."
            }
        ]
    },
    "integrity": {
        "version": 2,
        "algorithm": "sha256",
        "canonicalization": "jcs",
        "checksum": "sha256:dd8a9d16c9226cc9d1f4888a4d2bbcbf06b5b4b8"
    },
    "extensions": [
        {
            "namespace": "urn:uaix:ext:delivery",
            "purpose": "Explicit async request handling and expiry semantics.",
            "critical": false
        }
    ]
}

Client examples

Start from the same public catalog

Use the same public catalog from shell, browser, server, or automation clients.

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()

Discovery and sitemap surfaces

Automation and public QA should be able to resolve the same page inventory from both the root discovery surface and the locale-prefixed route space.

  • Use /.well-known/uaix.json as the preferred machine-readable manifest.
  • Use /sitemap.xml and /sitemap.html as the durable root crawl and directory surfaces.
  • Use /en-us/sitemap.xml and /en-us/sitemap.html when localized readers or tooling need the same inventory through the English route space.
  • Treat the root sitemap files as the canonical public SEO surface even when locale-prefixed sitemap routes are also live and tested.

Current machine-facing routes

The public tooling surface includes a human-facing validator page plus machine-facing REST routes for automation and release checks.

API reference and reusable pack surfaces

  • AI Memory Package Wizard guides a supported starter bundle into a package model, populated system profile, copy-paste file deck, receiver brief, startup packet, manifest overlay, long-term semantic pointer ledger required for durable-memory configuration, readiness metadata, and canonical ZIP download without claiming general hosted generation, automatic repository writes, or automatic wiki sync.
  • API Reference turns the live REST surface into a route-by-route handbook with a published OpenAPI 3.1 document and starter request examples.
  • Adoption Kit publishes the first-proof onboarding bundle with starter files, validator-ready payloads, and mock-exchange examples.
  • Conformance Pack assembles the broader schemas, registry data, fixtures, transport and trust guidance, and validator entry points into one reusable machine-readable packet.
  • /wp-json/uaix/v1/adoption-kit is the machine-facing onboarding bundle for the shortest reusable first-proof run; append ?download=1 when you want the same response as an attachment.
  • /wp-json/uaix/v1/openapi.json is the machine-facing OpenAPI export for the live UAIX REST surface.
  • /wp-json/uaix/v1/conformance-pack is the machine-facing JSON packet for launch review and repeatable conformance work; append ?download=1 when you want the same response as an attachment.
  • /wp-json/uaix/v1/roadmap is the machine-facing forward-plan record for current, next, planned, and research-track work; append ?download=1 when you want the same response as an attachment.

Published operating-surface references

The records below are part of the live machine-readable protocol surface and should be carried with schema and example resolution when you are evaluating interoperability or support claims.

Operating surface

Transport, trust, errors, and conformance

These records keep delivery, trust posture, typed failure semantics, and support claims explicit.

Transport

Published bindings

  • https-json-envelope.v1: application/vnd.uaix.uai+json
  • https-json-keyless.v1: application/vnd.uaix.uai-keyless+json

Trust

Published trust channels

  • public-web: Publicly readable records over HTTPS with no prior bilateral trust setup.
  • private-api: Service-to-service exchange on a scoped network or tenant boundary.
  • mtls: Transport-authenticated exchange where peer identity is anchored at the connection layer.
  • signed-envelope: Message-level signature or detached signature reference accompanies the record.
  • credentialed: The sender or execution context is backed by a machine-verifiable credential or comparable signed identity assertion.

Conformance

Published level ladder

  • L1-core-envelope: L1 Core Envelope
  • L2-profile-validation: L2 Profile Validation
  • L3-trust-and-integrity: L3 Trust and Integrity
  • L4-public-record-publisher: L4 Public Record Publisher
  • L5-agent-communication-profiles: L5 Agent Communication Profiles
  • L6-reliable-delegation-idempotency-correlation: L6 Reliable Delegation with Idempotency and Correlation
  • L7-capability-negotiation: L7 Capability Negotiation

Errors

Published message error codes

  • invalid_message: Invalid message
  • unknown_profile: Unknown profile
  • capability_not_supported: Capability not supported
  • auth_required: Authentication required
  • insufficient_trust: Insufficient trust
  • task_not_found: Task not found
  • task_expired: Task expired
  • replay_window_violation: Replay window violation
  • rate_limited: Rate limited
  • upstream_unavailable: Upstream unavailable
  • conformance_failed: Conformance failed
  • idempotency_required: Idempotency required

Discovery surface

Automation should start with the current UAIX discovery manifest and standards catalog.

Discovery

Machine-readable standards discovery

Resolve the current UAI-1 records from stable public endpoints without scraping page copy.

Public routes

Current machine-facing surface

  • Catalog: /wp-json/uaix/v1/catalog
  • Schemas: /wp-json/uaix/v1/schemas
  • Registry: /wp-json/uaix/v1/registry
  • Field registry: /wp-json/uaix/v1/field-registry
  • Transport Bindings: /wp-json/uaix/v1/transport-bindings
  • Trust Channels: /wp-json/uaix/v1/trust-channels
  • Conformance Levels: /wp-json/uaix/v1/conformance-levels
  • Error Registry: /wp-json/uaix/v1/error-registry
  • Examples: /wp-json/uaix/v1/examples
  • Validate (POST JSON): /wp-json/uaix/v1/validate
  • Adoption Kit: /wp-json/uaix/v1/adoption-kit
  • Mock Exchange: /wp-json/uaix/v1/mock-exchange

Next step

Start with the Validator, then carry the resulting evidence into Implementations, the Changelog, and News when the result affects a public release.