Skip to content

UKS v3.0 Specification

The normative specification is maintained at spec/UKS-v3-specification.md in the GitHub repository.

Overview

A UKS packet is a JSON document conforming to application/uks+json (IANA pending). Every packet has a schema_version: "3.0" field and up to five layers:

LayerNameRequired for
AData Contracts & SourcesL1, L2, L3
BScrape TargetsL2, L3
CExtraction RulesL2, L3
DDirectivesL3
EActions & Agent InstructionsL3

Minimum Valid Packet (L1)

json
{
  "packet_id": "uks-example-v1",
  "schema_version": "3.0",
  "conformance_level": "L1",
  "created_at": "2026-06-15T00:00:00Z",
  "topic": { "title": "Example Topic" },
  "sources": [
    {
      "id": "src_001",
      "title": "Example Source",
      "source_type": "research_paper",
      "credibility_score": 7,
      "evidence_grade": "moderate",
      "clinical_status": "informational"
    }
  ]
}

JSON Schema

The canonical JSON Schema (draft/2020-12) is at:

spec/schema/UKS.v3.schema.json

Validate any packet:

bash
uks validate my-packet.uks.json

Or in TypeScript:

typescript
import { validate } from '@uks/sdk';
const result = validate(packet);

Standards Submissions

Released under the MIT License.