What is api-contract-docs?

A set of project rules for keeping public API documentation and OpenAPI descriptions aligned with code changes. OpenAPI is a standard format for describing web APIs.

Use it when changing a public API, its documentation, its OpenAPI files, or related MCP tool schemas.

It prevents endpoint, parameter, and response changes from leaving the guides, generated README, and API specifications out of date.

api-contract-docs — Cursor rule by pricewatcha

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.

agentmods

npx agentmods add rules/pricewatcha/pricewatcha-api/api-contract-docs

Clone the repo

git clone --depth 1 https://github.com/pricewatcha/pricewatcha-api

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.

When invoked 242 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. Scan, not verified.

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.

Model	Per session	Once invoked
Fable 5	$0.00000	$0.00242
Opus 5	$0.00000	$0.00121
Sonnet 5	$0.00000	$0.00048
Haiku 4.5	$0.00000	$0.00024

Measured yesterday against content hash 66271dcec6a8, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

api-contract-docs 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 yesterday.

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.

.cursor/rules/api-contract-docs.mdc · 21 lines

What it actually says

Public API contract updates

Canonical guides live in docs/. Do not edit README.md by hand.

After any semantic change to endpoints, query params, or response fields:

Edit the matching file under docs/ (and docs/changelog.md).
Run python scripts/build_readme.py.
Update openapi/openapi.yaml (GitHub contract). Query params need a description.
Update ../price_tracker/app/api/v1/openapi_spec.py (live GET /openapi.json).
Run ../price_tracker/scripts/sync_api_docs.sh and commit app/api_docs/.
If an MCP tool is affected: mcp-server/src/tools/*.ts and mcp/tools.schema.json.

Checks: python scripts/build_readme.py --check and python scripts/verify_openapi_query_descriptions.py.

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.

yesterday First seen · 21 lines · 0 tokens per session scan A 66271dcec6a8

Subscribe to this mod's changes

api-contract-docs is a cursor rule published in the GitHub repository pricewatcha/pricewatcha-api (1 stars, last pushed 5d ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 242 tokens. 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.

Backend and APIs E-commerce Writing and docs ai-agents async-api developer-tools mcp openapi

architecture

Architecture of openapi-to-cli (ocli).

EvilFreelancer/openapi-to-cli · 1,404 tokens

cursor

You are working on the checkout service. Preserve transaction integrity and auditability.

mrwogu/promptscript · 53 tokens

agents-shipgate

Run Agents Shipgate as the deterministic merge gate for AI-generated agent capability changes.

ThreeMoonsLab/agents-shipgate · 0 tokens

pro-deck-builder

Create polished HTML slide decks and PDF-ready documents for consulting deliverables. Uses the RRBC design system with warm light mode, dark mode cover pages, Lora/Inter/Roboto Mono typography, and data visualization palette. Trigger on 'deck', 'slides', 'presentation', 'pitch deck', 'keynote', 'report', or 'PDF'.

thatrebeccarae/claude-marketing · 70 tokens

release-notes

Generate changelog entries and GitHub releases from git history. Categorizes commits into features, fixes, breaking changes, and docs. Supports conventional commits, PR-based grouping, and semantic versioning. Creates formatted CHANGELOG.md entries and GitHub releases.

thatrebeccarae/claude-marketing · 50 tokens

facebook-ads

Meta Ads (Facebook & Instagram) platform expertise. Audit campaigns, audiences, creative strategy, pixel tracking, and CAPI. Use when the user asks about Facebook Ads, Instagram Ads, Meta Ads, social media advertising, Advantage+ campaigns, or Meta pixel/CAPI setup.

thatrebeccarae/claude-marketing · 55 tokens