api-contract-architecture SKILL.md skillA

api-contract-architecture from devcodex-labs/devcodex is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add devcodex-labs/devcodex/api-contract-architecture@git:20261021.9117d5c

Pins git:20261021.9117d5c in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
devcodex-labs/devcodex
Path
content/skills/api-contract-architecture/SKILL.md
Versions recorded
2
Latest version
git:20261021.9117d5c, committed Oct 21, 2026
First version recorded
Jul 30, 2026
Size
6,820 bytes
Repository stars
432
License
AGPL-3.0

API 契约架构专家 Owner — 当任务涉及 public API、HTTP/SDK/CLI 契约、版本兼容、错误模型、分页过滤、幂等、Schema、类型、迁移或消费者影响时使用;要求先冻结消费者契约,再设计实现与验证。.

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

# API Contract Architecture Skill

## 定位

本 Skill 负责 API 契约 Owner 视角。它确保方案先回答“谁消费、契约是什么、如何兼容、如何验证”,再进入实现细节。

## 触发条件

| 场景 | 是否触发 |
|------|:--------:|
| 新增或调整 HTTP API、SDK API、CLI 参数、Hook payload、MCP tool/resource、事件、配置 Schema 或 public types | 必须 |
| 涉及版本兼容、迁移、错误码、分页、过滤、幂等、鉴权响应或消费者文档 | 必须 |
| 修复会影响调用方行为或示例用法 | 必须 |
| 纯内部实现且不改变任何公开输入/输出/错误/类型 | N/A + skipReason |

## 核心门禁

| Gate | 要求 | 证据 |
|------|------|------|
| `ApiContractArchitectureGate` | 公开契约必须有消费者、输入、输出、错误、兼容和验证矩阵 | consumerSurface、contractInventory |
| `ConsumerSurfaceGate` | 先列真实消费者,避免首个实现反向定义公共契约 | README、types、examples、route、SDK |
| `ErrorModelGate` | 错误结构、错误码、detail 和恢复路径必须稳定 | errorModel、docs |
| `CliJsonContractGate` | 机器可读 CLI 必须冻结 envelope 字段、成功/失败互斥、错误码、nextStep 与 native exit code | DevCodexCliEnvelopeV1、spawn fixtures |
| `VersionCompatibilityGate` | 兼容、弃用、迁移和 breaking change 必须明确 | versionCompatibility |
| `ReleaseAuthorityBeforeCompatibilityGate` | 先证明契约是否已发布并形成稳定消费者,再决定兼容、迁移或直接收敛 | publishedState、consumerEvidence、authoritySources、decision |
| `ConfigurationErgonomicsGate` | 公开配置 Schema 必须证明最小任务、字段必要性、复杂度预算和可选字段省略行为 | MinimalTaskConfig、FieldNecessityMatrix、OptionalFieldOmissionProbe |
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add devcodex-labs/devcodex/api-contract-architecture@sha256:ba20f4a8ce4876b9

The line at the top of this page pins the label git:20261021.9117d5c, 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_w6wkk42h7yq4yidy.svg)](https://markdownregistry.com/a/art_w6wkk42h7yq4yidy)

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

Versions

The registry has recorded 2 versions of this file, between Jul 30, 2026 and Oct 21, 2026, about one every 83 days.

versioncommittedcommitsizeaudit
git:20261021.9117d5c latest2026-10-21 9117d5c 6,820 BA view · diff
git:20260730.6ee304a2026-07-30 6ee304a 5,490 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 (6820 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

devcodex-labs/devcodex · 432 stars · license AGPL-3.0 · pushed 2026-10-27 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_w6wkk42h7yq4yidy
GET https://markdownregistry.com/api/v1/resolve?ref=devcodex-labs/devcodex/api-contract-architecture
GET https://markdownregistry.com/api/v1/blob/ba20f4a8ce4876b96a05c8256e34d598705d1032657b735c336f4986980daf35

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 devcodex-labs/devcodex

accessibility-i18n SKILL.md skill
devcodex-labs/devcodex · content/skills/accessibility-i18n/SKILL.md · 无障碍与国际化专家 Owner — 当任务涉及可访问性、键盘操作、焦点、屏幕阅读器、ARIA、语言地区、本地化、RTL、翻译资源、用户可见文案或多语言文档时使用;要求把包容性体验和本地化验证绑定到真实用户路径。
git:20260730.6ee304a · audit A · 432 stars
ai-agent-system-architecture SKILL.md skill
devcodex-labs/devcodex · content/skills/ai-agent-system-architecture/SKILL.md · AI Agent 系统架构专家 Owner — 当任务涉及 Agent 路由、工具调用、上下文管理、记忆、状态机、权限、人机协作、可观测性、回放验证或模型辅助治理时使用;要求把 Agent 行为设计成可解释、可恢复、可审计。
git:20260907.36d3d18 · audit A · 432 stars
ai-evaluation-engineering SKILL.md skill
devcodex-labs/devcodex · content/skills/ai-evaluation-engineering/SKILL.md · AI 评测工程专家 Owner — 当任务涉及模型/Prompt 评测、模型选择、黄金集、评分量表、LLM-as-judge、Judge 校准、重复采样、方差、质量-成本-延迟权衡、提示词回归或模型升级回归时使用;要求把概率性结果转化为可复…
git:20260730.6ee304a · audit A · 432 stars
analyze-default SKILL.md skill
devcodex-labs/devcodex · content/skills/analyze-default/SKILL.md · 默认分析工作流规范 — 只读多轮分析、代码事实优先、analyze-lite 关联联查与 PCV 收敛验证
git:20260730.6ee304a · audit A · 432 stars
analyze-research SKILL.md skill
devcodex-labs/devcodex · content/skills/analyze-research/SKILL.md · 技术调研子类型规范 — 技术选型/可行性评估/根因调查,只读工作流
git:20260730.6ee304a · audit A · 432 stars
api-verification SKILL.md skill
devcodex-labs/devcodex · content/skills/api-verification/SKILL.md · 接口验证规范 — 双产物(.http + .cjs)生成 + 自动化执行脚本
git:20260730.6ee304a · audit A · 432 stars
architecture-design SKILL.md skill
devcodex-labs/devcodex · content/skills/architecture-design/SKILL.md · 架构设计文档编排 Owner — 当用户要求架构设计、系统设计、技术架构或可指导开发、Review 与任务拆分的完整方案时使用;要求从业务流程反推节点、状态、数据、一致性、异常补偿、ADR 与实施任务。
git:20260917.1dd4525 · audit A · 432 stars
audit-common SKILL.md skill
devcodex-labs/devcodex · content/skills/audit-common/SKILL.md · 审查公共维度 G0~G5 + Profile Freshness Check — 所有 audit 子类型必先执行的基础维度层
git:20261018.fda4337 · audit A · 432 stars
audit-dimensions SKILL.md skill
devcodex-labs/devcodex · content/skills/audit-dimensions/SKILL.md · D1~D25 规范文件审查维度总览 — 规范库/specs 文件专属审查层
git:20261018.fda4337 · audit A · 432 stars
audit-document SKILL.md skill
devcodex-labs/devcodex · content/skills/audit-document/SKILL.md · 通用文档审查维度 DA-1~DA-6 — README/架构文档/开发指南专属审查层
git:20260908.6caf1bf · audit A · 432 stars
audit-execution-guide SKILL.md skill
devcodex-labs/devcodex · content/skills/audit-execution-guide/SKILL.md · 审查执行指南 — 维度优先级分批、定向审查子集、联动检查清单
git:20261017.e96e3c4 · audit A · 432 stars
audit-project SKILL.md skill
devcodex-labs/devcodex · content/skills/audit-project/SKILL.md · 项目工程审查维度 PE-1~PE-12 — 代码质量/项目结构/依赖安全/资源泄漏专属审查层
git:20260730.6ee304a · audit A · 432 stars

Every file in devcodex-labs/devcodex

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