agentmods.dev

api-ref-copy

A set of writing rules for user-facing text in OpenAPI specifications, including summaries, descriptions, punctuation, terminology, and public information.

In plain words
What is it for?
Use it when writing or reviewing operation summaries, parameters, schemas, examples, response descriptions, and other text in an OpenAPI file.
Why use it?
It keeps API documentation consistent, clear, grammatically correct, and free of internal project details.

Cursor rule for Cursor

4 2mo ago A scan 0 tokens original Apache-2.0
View the source file AdobeDocs/ff-services-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.

agentmods
npx agentmods add rules/adobedocs/ff-services-docs/api-ref-copy
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 403 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.00403
Opus 5 $0.00000 $0.00201
Sonnet 5 $0.00000 $0.00081
Haiku 4.5 $0.00000 $0.00040

Measured yesterday against content hash ce6f8e7c8893, 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-copy 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-copy.mdc · 43 lines

What it actually says

API reference — copy and descriptions

Response descriptions (HTTP status lines)

  • Title Case, no trailing period.
  • Standardize: Success, Accepted, Bad Request, Unauthorized, Forbidden, Requested Resource Was Not Found, Too Many Requests, Internal Server Error, Input Validation Error.

All other descriptions

  • Complete sentences with periods (operations, parameters, request bodies, schemas, headers).
  • No trailing or leading spaces on parameter descriptions.
  • Fix spelling and grammar (eg → e.g., etc. → etc.).
  • Proper acronyms: GUID, URL (not Guid, Url).
  • Consistent terminology (e.g. Adobe Asset Link).

Summaries

  • Sentence case; no trailing period; no API suffix.
  • Lowercase version labels: v1, v2 (not V1).
  • Clear, descriptive; operationId in camelCase.

Public-facing text

User-visible strings must not contain internal-only information.

Scan: info, tags, operation summaries/descriptions, parameters, schemas, examples (prose), enum descriptions.

Do not allow:

  • Jira or ticket keys (e.g. FFENT-8796, PROJ-123)
  • Internal codenames, internal service names, corp-only wiki URLs
  • Authoring TODOs tied to tickets (e.g. TODO: fix after FFENT-…)

Allowed: Public product names, customer error codes, placeholders ({your_api_key}), standard field names (jobId).

Flag violations as high severity in eval/review output. /api-fix does not auto-fix copy — use /api-review or explicit ref-based edits.

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 · 43 lines · 0 tokens per session scan A ce6f8e7c8893

Subscribe to this mod's changes

api-ref-copy 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 403 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 APIsWriting and docs
Related

Other cursor rules, from other repositories

angular-20

This rule provides comprehensive best practices and coding standards for Angular development, focusing on modern TypeScript, standalone components, signals, and performance optimizations.

angular/angular · 0 tokens

dev-standard

Apache Superset development standards and guidelines for Cursor IDE.

apache/superset · 1,147 tokens

typescript

Changes to these high-fan-out internals can affect every message, delta, element, or rerun. Keep work in them minimal, and benchmark changes with representative stress-test apps.

streamlit/streamlit · 4,669 tokens

coolify-ai-docs

Master reference to all Coolify AI documentation in .ai/ directory.

coollabsio/coolify · 1,426 tokens

python_lib

Tips and guidelines specific to the development of the Streamlit Python library, not applicable to scripts and e2e tests.

streamlit/streamlit · 0 tokens

specs

This directory contains product and tech specs for Streamlit features.

streamlit/streamlit · 0 tokens