Examples

Validated sample packages from the ucpcore/ucp repository. Use them to explore the data model, test consumers, or validate your parser.

minimal.ucp.json

Smallest valid ucp-core package — entity, generator, and a single source entry. Good starting point for schema exploration.

{
  "ucp_version": "0.1.0",
  "id": "urn:uuid:00000000-0000-4000-8000-000000000001",
  "generated_at": "2026-07-05T12:00:00Z",
  "generator": { "name": "minimal-producer" },
  "entity": {
    "ref": { "system": "filesystem", "type": "file", "id": "/docs/readme.md" },
    "title": "readme.md"
  },
  "sources": {
    "src-1": { "system": "filesystem", "type": "file", "title": "readme.md" }
  }
}

jira-task.ucp.json

Realistic Jira task with must_know, decisions, constraints, audience access control, and temporal fields. Demonstrates the full ucp-core + temporal + secure profiles.

{
  "ucp_version": "0.1.0",
  "profiles": ["ucp-core", "ucp-temporal", "ucp-secure"],
  "entity": {
    "ref": { "system": "jira", "type": "issue", "id": "PAY-482" },
    "title": "Migrate payment webhooks to v2 API",
    "status": "In Progress"
  },
  "summary": { "text": "Payment provider deprecates webhook API v1…" },
  "must_know": [ … ],
  "decisions": [ … ],
  "sources": { … }
}

sidebar-receipt.receipt.json

Usage Receipt (SPEC §4.12) — feedback after an agent consumes a package. Records claims_cited, claims_ignored, gaps_needed, and outcome without embedding claim text.

{
  "receipt_version": "0.1.0",
  "package_id": "urn:uuid:7f9c2e14-…",
  "consumer": { "type": "mcp", "id": "cursor@1.0" },
  "claims_cited": ["mk-1", "mk-3"],
  "claims_ignored": ["mk-2"],
  "gaps_needed": ["API rate limits not in package"],
  "outcome": "task_completed"
}

unknown-fields-ignored.ucp.json

Conformance fixture: producers and consumers MUST tolerate unknown top-level and nested fields (SPEC §6). Tests forward compatibility.

{
  "ucp_version": "0.1.0",
  "entity": { "ref": { "system": "jira", "type": "issue", "id": "X-1" }, … },
  "some_future_field": { "introduced_in": "2.0.0" },
  "must_know": [
    { "id": "mk-1", "text": "Consumers must ignore fields they do not understand.",
      "sources": ["s"], "future_claim_field": true }
  ]
}

Generate from a live issue

Examples above are static fixtures. To build a package from a real GitHub issue or Jira ticket:

ucp-gen github pallets/flask#5961 -o task.ucp.json # or via the server: curl -s -X POST http://localhost:8080/v1/generate \ -H 'Content-Type: application/json' \ -d '{"source": "github", "ref": "pallets/flask#5961"}'

Validate a package

pip install pyucp python -c "import ucp; ucp.load('task.ucp.json'); print('valid')"

Schema: schema/ucp.schema.json · More fixtures: conformance/