api-ref-tags-errors

A set of OpenAPI documentation rules for grouping endpoints, describing errors, and documenting authentication. OpenAPI is a standard format for explaining how a web API can be used.

In plain words
What is it for?
Use it when documenting or reviewing API tags, standard HTTP errors, bearer tokens, API keys, parameter names, and versioned operation summaries.
Why use it?
It gives API references consistent tags, error responses, authorization details, and version labels, so readers can understand and use them more reliably.

Cursor rule for Cursor

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/adobedocs/ff-services-docs/api-ref-tags-errors
Clone the repo
git clone --depth 1 https://github.com/AdobeDocs/ff-services-docs

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 260 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.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00260
Opus 5 $0.00000 $0.00130
Sonnet 5 $0.00000 $0.00052
Haiku 4.5 $0.00000 $0.00026

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

Security

Grade A, and why

api-ref-tags-errors 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-ref-tags-errors.mdc · 44 lines

What it actually says

API reference — tags, errors, auth

Tags

  • Descriptive sentence-case names with descriptions.
  • Order logically; core operations first (e.g. "Common operations").
  • No empty tag arrays; avoid generic tags (API, product name only).

Standard error responses

Include where appropriate:

Code Description
400 Bad Request or Input Validation Error
401 Unauthorized
403 Forbidden
404 Requested Resource Was Not Found
429 Too Many Requests
500 Internal Server Error

Use Title Case, no periods on response descriptions.

Error schema

  • error_code (snake_case, gateway-aligned) and optional message on error payloads.

Authentication

  • Document Authorization (Bearer) as required.
  • Document x-api-key as optional where Cluster Gateway applies.
  • Consistent parameter naming across operations.

Versioning

  • Summaries include version: Remove background v1, Get status - v2.
  • Beta: v2 (beta); lowercase vN.
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. yesterday First seen · 44 lines · 0 tokens per session scan A 20b7f54cb7bb

Subscribe to this mod's changes

api-ref-tags-errors is a cursor rule published in the GitHub repository AdobeDocs/ff-services-docs (4 stars, last pushed 2mo ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 260 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.