api-contract-docs

api-contract-docs is a cursor rule for Cursor from pricewatcha/pricewatcha-api. It costs 0 tokens per session (242 once invoked), scanned A, original, Apache-2.0.

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.

In plain words
What is it for?
Use it when changing a public API, its documentation, its OpenAPI files, or related MCP tool schemas.
Why use it?
It prevents endpoint, parameter, and response changes from leaving the guides, generated README, and API specifications out of date.

Cursor rule for Cursor

Written for Cursor: installed under .cursor/.

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

Compare 6 cursor rules from other repositories ↓
Install with agentmods
npx agentmods add rules/pricewatcha/pricewatcha-api/api-contract-docs
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.

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

Made for: Cursor.

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-docs

README.md
[![agentmods](https://agentmods.dev/badge/rules/pricewatcha/pricewatcha-api/api-contract-docs/github.svg)](https://agentmods.dev/rules/pricewatcha/pricewatcha-api/api-contract-docs)
Your own site
<a href="https://agentmods.dev/rules/pricewatcha/pricewatcha-api/api-contract-docs"><img src="https://agentmods.dev/badge/rules/pricewatcha/pricewatcha-api/api-contract-docs/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-docs

Your own site · 80×15
<a href="https://agentmods.dev/rules/pricewatcha/pricewatcha-api/api-contract-docs"><img src="https://agentmods.dev/badge/rules/pricewatcha/pricewatcha-api/api-contract-docs.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
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. 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.00000 $0.00242
Opus 5.5 $0.00000 $0.00097
Sonnet 5.5 $0.00000 $0.00048
Haiku 4.5 $0.00000 $0.00024

Measured 1mo ago against content hash 66271dcec6a8, 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-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 1mo 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.

.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:

  1. Edit the matching file under docs/ (and docs/changelog.md).
  2. Run python scripts/build_readme.py.
  3. Update openapi/openapi.yaml (GitHub contract). Query params need a description.
  4. Update ../price_tracker/app/api/v1/openapi_spec.py (live GET /openapi.json).
  5. Run ../price_tracker/scripts/sync_api_docs.sh and commit app/api_docs/.
  6. 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.

  1. 1mo ago 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 yesterday), 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.

Related

Other cursor rules, from other repositories

lap

LAP CLI -- search, download, and install API specs for AI agents. Use when user needs an API (Stripe, Plaid, Twilio, etc). Commands: (1) npx -y @lap-platform/lapsh search , (2) npx -y @lap-platform/lapsh get -o .lap, (3) npx -y @lap-platform/lapsh skill-install --target cursor. The .lap file IS the spec -- do NOT…

Lap-Platform/LAP · 124 tokens

architecture

Architecture of openapi-to-cli (ocli).

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

cursor

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

mrwogu/promptscript · 53 tokens

storage-plugin

Rules for creating storage-provider plug-ins in the Pixuli application. A storage provider is a component that can list, upload, delete, and create links for stored files.

trueLoving/Pixuli · 0 tokens

tray-api

Regras e documentação da API Tray. Aplica quando o desenvolvedor trabalhar com autenticação OAuth, produtos, pedidos, clientes, webhooks, frete, pagamentos ou qualquer outro recurso da plataforma Tray. Inclui convenções obrigatórias de autenticação, formato de payload, rate limit e índice completo de skills com…

tray-tecnologia/tray-api-ai-plugin · 70 tokens

marketplace-all

Composite skill for the marketplace track. Apply when building catalog or SKU synchronization logic for VTEX marketplace seller connectors. Covers the changenotification endpoint, SKU suggestion lifecycle, product data mapping, price and inventory sync, and fulfillment simulation. Use for implementing seller-side…

vtex/skills · 25,584 tokens