design-serialization-schema SKILL.md skillA

design-serialization-schema from pjt222/agent-almanac is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add pjt222/agent-almanac/design-serialization-schema@v1.0

Pins v1.0 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
pjt222/agent-almanac
Path
i18n/caveman-lite/skills/design-serialization-schema/SKILL.md
Versions recorded
4
Latest version
v1.0, committed Aug 17, 2026
First version recorded
Apr 19, 2026
Size
11,111 bytes
Repository stars
43
License
MIT

Design serialization schemas using JSON Schema, Protocol Buffer definitions, or Apache Avro. Covers schema versioning, backwards compatibility, validation rules, and evolution strategies for long-lived data formats. Use when defining a new API contract or data interchange format, adding fields to an existing schema without breaking consumers, migrating between schema versions, choosing between schema systems, or documenting data validation rules for automated enforcement.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Design Serialization Schema

Create well-versioned serialization schemas that evolve gracefully without breaking consumers.

## When to Use

- Defining a new API contract or data interchange format
- Adding fields to an existing schema without breaking consumers
- Migrating between schema versions
- Choosing between schema systems (JSON Schema, Protobuf, Avro)
- Documenting data validation rules for automated enforcement

## Inputs

- **Required**: Data model (entity relationships, field types, constraints)
- **Required**: Compatibility requirements (who consumes this data, how long must old formats be readable)
- **Optional**: Existing schema to evolve
- **Optional**: Performance requirements (validation speed, schema registry integration)
- **Optional**: Target serialization format (JSON, binary, columnar)

## Procedure

### Step 1: Choose a Schema System

| System | Format | Strengths | Best For |
|---|---|---|---|
| JSON Schema | JSON | Widely supported, flexible validation | REST APIs, config validation |
| Protocol Buffers | Binary | Compact, fast, strong typing, built-in evolution | gRPC, microservices |
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add pjt222/agent-almanac/design-serialization-schema@sha256:03ee0334a70005d0

The line at the top of this page pins the label v1.0, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_a6f4hixvtajjrtm7.svg)](https://markdownregistry.com/a/art_a6f4hixvtajjrtm7)

3 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 4 versions of this file, between Apr 19, 2026 and Aug 17, 2026, about one every 40 days.

versioncommittedcommitsizeaudit
v1.0 latest2026-08-17 a784899 11,111 BA view · diff
v1.02026-06-05 75ded7a 11,082 BA view · diff
v1.02026-04-23 eb36d45 11,153 BA view · diff
v1.02026-04-19 e334ebd 11,205 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (11111 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

pjt222/agent-almanac · 43 stars · license MIT · pushed 2026-11-06 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_a6f4hixvtajjrtm7
GET https://markdownregistry.com/api/v1/resolve?ref=pjt222/agent-almanac/design-serialization-schema
GET https://markdownregistry.com/api/v1/blob/03ee0334a70005d081caa78ec3c6d79663a287779b226b9367fd0b15af285e5d

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from pjt222/agent-almanac

CLAUDE.md CLAUDE.md file
pjt222/agent-almanac · CLAUDE.md
git:20261105.d2f5ad6 · audit A · 43 stars
adapt-architecture SKILL.md skill
pjt222/agent-almanac · i18n/caveman-lite/skills/adapt-architecture/SKILL.md · Execute structural metamorphosis using strangler fig migration, chrysalis phases, and interface preservation. Covers…
v1.0 · audit A · 43 stars
adaptic SKILL.md skill
pjt222/agent-almanac · i18n/caveman-lite/skills/adaptic/SKILL.md · Master skill composing the 5-step synoptic cycle for panoramic synthesis across multiple domains. Orchestrates…
v1.0 · audit A · 43 stars
add-puzzle-type SKILL.md skill
pjt222/agent-almanac · i18n/caveman-lite/skills/add-puzzle-type/SKILL.md · Scaffold a new puzzle type across all 10+ pipeline integration points in jigsawR. Creates the core puzzle module, wires…
v1.0 · audit A · 43 stars
add-rcpp-integration SKILL.md skill
pjt222/agent-almanac · i18n/caveman-lite/skills/add-rcpp-integration/SKILL.md · Add Rcpp or RcppArmadillo integration to an R package for high-performance C++ code. Covers setup, writing C++…
v1.0 · audit A · 43 stars
aikido SKILL.md skill
pjt222/agent-almanac · i18n/caveman-lite/skills/aikido/SKILL.md · Practice aikido as a defensive martial art emphasizing harmony, redirection, and controlled resolution. Covers…
v1.0 · audit A · 43 stars
analyze-codebase-for-mcp SKILL.md skill
pjt222/agent-almanac · i18n/caveman-lite/skills/analyze-codebase-for-mcp/SKILL.md · Analyze an arbitrary codebase to identify functions, APIs, and data sources suitable for exposure as MCP tools…
v1.0 · audit A · 43 stars
analyze-codebase-workflow SKILL.md skill
pjt222/agent-almanac · i18n/caveman-lite/skills/analyze-codebase-workflow/SKILL.md · Analyze an arbitrary codebase to auto-detect workflows, data pipelines, and file dependencies using putior's put_auto()…
v1.0 · audit A · 43 stars
analyze-diffusion-dynamics SKILL.md skill
pjt222/agent-almanac · i18n/caveman-lite/skills/analyze-diffusion-dynamics/SKILL.md · Analyze the dynamics of diffusion processes using stochastic differential equations, Fokker-Planck equations…
v1.0 · audit A · 43 stars
analyze-generative-diffusion-model SKILL.md skill
pjt222/agent-almanac · i18n/caveman-lite/skills/analyze-generative-diffusion-model/SKILL.md · Analyze pre-trained generative diffusion models (Stable Diffusion, DALL-E, Flux) by computing quality metrics (FID, IS…
v1.0 · audit A · 43 stars
analyze-kernel-bottleneck SKILL.md skill
pjt222/agent-almanac · i18n/caveman-lite/skills/analyze-kernel-bottleneck/SKILL.md · Systematically identify whether a GPU kernel is compute-bound, memory-bound, or latency-bound using roofline analysis…
v1.0 · audit A · 43 stars
analyze-magnetic-field SKILL.md skill
pjt222/agent-almanac · i18n/caveman-lite/skills/analyze-magnetic-field/SKILL.md · Calculate and visualize magnetic fields produced by current distributions using the Biot-Savart law, Ampere's law, and…
v1.0 · audit A · 43 stars

Every file in pjt222/agent-almanac

Browse by kind, by grade A, or by owner.