api-contract-sync

api-contract-sync is a skill for Claude Code, Codex from me-cedric/agent-compass. It costs 43 tokens per session (674 once invoked), scanned A, original, MIT.

A workflow for keeping an API's implementation and its contract descriptions in sync. An API contract documents endpoints, data shapes, status codes, query parameters, authentication rules, and business state changes.

In plain words
What is it for?
Use it when changing API endpoints, request or response objects, status codes, query parameters, authentication, or business transitions in projects using tools such as OpenAPI, Swagger, Bruno, Gherkin, shared client types, or generated mocks.
Why use it?
It helps prevent the server code, documentation, client types, tests, and generated mocks from describing different API behavior.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: mentions AGENTS.md.

Good fit Use it when changing API endpoints, request or response objects, status codes, query parameters, authentication, or business transitions in projects using tools such as OpenAPI, Swagger, Bruno, Gherkin, shared client types, or generated mocks.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/me-cedric/agent-compass/api-contract-sync
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add me-cedric/agent-compass --skill api-contract-sync
Clone the repo
git clone --depth 1 https://github.com/me-cedric/agent-compass

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for api-contract-sync

README.md
[![agentmods](https://agentmods.dev/badge/skills/me-cedric/agent-compass/api-contract-sync/github.svg)](https://agentmods.dev/skills/me-cedric/agent-compass/api-contract-sync)
Your own site
<a href="https://agentmods.dev/skills/me-cedric/agent-compass/api-contract-sync"><img src="https://agentmods.dev/badge/skills/me-cedric/agent-compass/api-contract-sync/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for api-contract-sync

Your own site · 80×15
<a href="https://agentmods.dev/skills/me-cedric/agent-compass/api-contract-sync"><img src="https://agentmods.dev/badge/skills/me-cedric/agent-compass/api-contract-sync.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 43 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 674 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00043 $0.00674
Opus 5.5 $0.00017 $0.00270
Sonnet 5.5 $0.00009 $0.00135
Haiku 4.5 $0.00004 $0.00067

Measured 10d ago against content hash b470bf830377, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

api-contract-sync scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 10d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/api-contract-sync/SKILL.md · 62 lines

How it starts

The opening of the file, as written. The whole thing — 62 lines — stays where its author put it; the contents beside it link to each section on GitHub.

api-contract-sync

An endpoint is not done until the code, the docs, the client examples and the behavior specs agree. Update all layers in the same task. Never defer a layer to a follow-up PR.

Trigger

Run this skill when you change any of these:

  • A route path, method, auth rule, ownership rule, status code, header or query parameter.
  • A payload, DTO, schema, error shape, pagination, sorting or filtering.
  • Controller or service behavior that an API shows.
  • Generated shared types or API client contracts.

Layers

Check only the layers that exist in the repository. The OpenAPI file is in {{OPENAPI_DIR}} when the project keeps one there.

  1. Controller docs and DTO metadata (OpenAPI, Swagger or Scalar decorators):
    • Each endpoint documents its purpose, all response codes, its query and path parameters and its auth scheme.
    • Each DTO field has a description and an example, and says if it is required.
    • A new module is registered in the OpenAPI bootstrap, with its tags.
  2. Bruno requests (*.bru):
    • The URL, method, query parameters, body and headers match the controller and the DTO.
    • The docs block and the pre-request and post-response scripts are current.
    • A new endpoint gets a new request file. A deleted endpoint loses its file. Keep the seq order in folder.bru.
  3. Gherkin (*.feature): add or change a Scenario for each new or changed behavior. Update Examples tables.
  4. Mocks and client types:
    • Mockoon: start a mock from the OpenAPI file with npx @mockoon/cli start --data <openapi-file>. Check that the mock answers the new shape.
    • Shared client types: update each consumer that imports the changed symbol.

Steps

  1. Read the repository AGENTS.md, the module README and the nearby specs and features.
  2. Find every layer for the changed route or DTO.
  3. Change the code and the layers together.
  4. Write not present for a layer that does not exist. Never write skipped.
  5. Run the smallest declared checks: lint, typecheck, the API tests, the contract tests.
  6. Run the Bruno collection against the running API: bru run <collection-dir> --env <env>. Report each failing request.
  7. After a decorator change, check that the app still starts and the OpenAPI document builds.

Read the full file on GitHub · 62 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 10d ago Changed · +3 lines · -19 tokens per session b470bf830377
  2. 1mo ago First seen · 59 lines · 62 tokens per session scan A 79c3f543fc28

Subscribe to this mod's changes

api-contract-sync is a skill published in the GitHub repository me-cedric/agent-compass (3 stars, last pushed 4d ago), licensed MIT. It adds 43 tokens to every session and 674 once invoked, about $0.0002 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

agent-crdt-synchronizer

Agent skill for crdt-synchronizer - invoke with $agent-crdt-synchronizer.

ruvnet/ruflo · 25 tokens

event-store-design

Design and implement event stores for event-sourced systems. Use when building event sourcing infrastructure, choosing event store technologies, or implementing event persistence patterns.

wshobson/agents · 33 tokens

cqrs-implementation

Implement Command Query Responsibility Segregation for scalable architectures. Use when separating read and write models, optimizing query performance, or building event-sourced systems.

wshobson/agents · 35 tokens

workflow-orchestration-patterns

Design durable workflows with Temporal for distributed systems. Covers workflow vs activity separation, saga patterns, state management, and determinism constraints. Use when building long-running processes, distributed transactions, or microservice orchestration.

wshobson/agents · 49 tokens

microservices-patterns

Design microservices architectures with service boundaries, event-driven communication, and resilience patterns. Use when building distributed systems, decomposing monoliths, or implementing microservices.

wshobson/agents · 38 tokens

deepstream-sop

Use this skill when building, deploying, evaluating, debugging, or measuring latency for the DeepStream SOP Inference Microservice — a GPU-accelerated FastAPI service that detects whether operators perform assembly-line steps in order via event boundary detection (GEBD) plus VLM classification. Trigger even if the…

NVIDIA/skills · 219 tokens