agentleFS
ArcanEdge-AIArcanEdge-AI/coding-agent-playbook-codex/skills/production-api-integration/SKILL.md

production-api-integration

Skill3 starsChanged 3 months agoMITView on GitHub

Review API and integration readiness for production, including request validation, response consistency, status codes, auth, authorization, pagination, rate limiting, idempotency, webhooks, third-party failures, timeout handling, retry behavior, sensitive data exposure, and API documentation.

1 other project uses a version of this, 1 of them edited.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

9 rules. About 0 are common, 9 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈9

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Add relevant tests when making authorized API behavior changes.

    line 60
  2. Distinctive:

    Document breaking-change risks separately.

    line 61
  3. Distinctive:

    Update API docs for authorized API changes.

    line 62
  4. Distinctive:

    Do not break API contracts without explicit approval.

    line 76
  5. Distinctive:

    Do not remove auth or validation to make tests pass.

    line 77
  6. Distinctive:

    Do not leak internal errors to clients.

    line 78
  7. Distinctive:

    Do not retry non-idempotent operations without safeguards.

    line 79
  8. Distinctive:

    Do not log secrets or sensitive payloads.

    line 80
  9. Distinctive:

    Do not hide integration failures as successful responses.

    line 81

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Production API Integration

Core purpose

Improve API predictability, integration safety, and failure handling without unnecessary breaking changes.

Use this skill when

  • The production pass needs API or integration review.
  • The repository exposes APIs, consumes APIs, uses webhooks, or depends on third-party services.
  • The user wants APIs production-ready and predictable.

Do not use this skill when

  • The application has no API or integration layer.
  • The task is only frontend styling.
  • The requested change would break public API behavior without approval.

Check for

  • Request validation
  • Response shape consistency
  • Correct HTTP status codes
  • Error response consistency
  • Pagination
  • Rate limiting
  • Authentication
  • Authorization
  • Idempotency for sensitive operations
  • Timeout handling
  • Third-party failure handling
  • Webhook signature validation
  • API documentation gaps
  • Breaking change risks
  • Retry behavior
  • Sensitive data exposure
  • Internal error leakage
  • Contract drift between client and server

Default workflow

Resolve the task mode first: assessment-only work reports findings without source, test, or repository-document edits; authorized remediation applies only in-scope fixes. Release, production, and destructive operations retain their separate authority requirements.

  1. Inspect route definitions, controllers, service clients, middleware, schemas, and API docs.
  2. Identify critical API flows.
  3. Identify external integrations and webhooks.
  4. Classify findings as Blocker, High, Medium, or Low.
  5. In an authorized remediation task, fix safe in-scope issues; for assessment-only requests, report them without editing:
    • missing validation
    • inconsistent errors
    • missing status handling
    • timeout gaps
    • obvious auth checks
    • webhook validation gaps
  6. Add relevant tests when making authorized API behavior changes; in assessment mode, report coverage gaps.
  7. Document breaking-change risks separately.
  8. Update API docs for authorized API changes; in assessment mode, report documentation gaps.

Severity guidance

Classify as Blocker when API behavior creates critical security, data loss, payment, auth, or production availability risk.

Classify as High when API flaws create serious release risk or likely production incidents.

Classify as Medium when improvements should be scheduled soon.

Classify as Low for optional consistency or documentation polish.

Guardrails

  • Do not break API contracts without explicit approval.
  • Do not remove auth or validation to make tests pass.
  • Do not leak internal errors to clients.
  • Do not retry non-idempotent operations without safeguards.
  • Do not log secrets or sensitive payloads.
  • Do not hide integration failures as successful responses.

Deliverables

Include the following in the requested assessment response or report. Update repository readiness files only when those artifacts are requested or part of authorized remediation:

  • API readiness summary
  • Integration risk summary
  • Safe fixes applied
  • Tests added or updated
  • Remaining API risks
  • Files changed and reasons

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.