agentleFS
imtiazrayhanimtiazrayhan/agentscamp-library/skills/api-deprecation-planner/SKILL.md

api-deprecation-planner

Skill1 starsChanged 5 days agoMITView on GitHub

Plan the retirement of an API endpoint, field, event, tool, or version without surprising active consumers. Use when replacing an interface, removing legacy behavior, publishing a sunset, migrating internal or external clients, or deciding whether observed traffic is safe to turn off.

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    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:

    Make deprecation observable: Add safe usage metrics, per-consumer attribution where allowed, structured warnings, response headers or …

    line 16
  2. Distinctive:

    Disable reversibly before deletion: Prefer a controlled reject, feature flag, route switch, or scoped block with monitoring.

    line 19

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 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

Retire an interface through measured migration, not a deletion date alone.

Workflow

  1. Define the retiring surface. Identify endpoints, methods, fields, event versions, SDK methods, agent tools, error codes, authentication modes, and undocumented behaviors consumers may rely on.
  2. Inventory consumers. Combine gateway logs, client identifiers, tracing, repository search, SDK telemetry, support records, partner contracts, and owner interviews. State blind spots and the observation window.
  3. Verify the replacement. Map every required behavior, performance property, permission, error, and operational dependency to the replacement. Record gaps and migration prerequisites.
  4. Set policy and timeline. Apply versioning commitments, contractual notice, client release cadence, and rare usage cycles. Define announcement, warning, migration, freeze, disablement, and deletion milestones with owners.
  5. Make deprecation observable. Add safe usage metrics, per-consumer attribution where allowed, structured warnings, response headers or schema directives, dashboards, and alerts for unexpected traffic changes.
  6. Support migration. Provide side-by-side examples, SDK or codemod support, test environments, compatibility checks, and escalation paths. Avoid telling consumers only that the old interface will disappear.
  7. Define exit criteria. Require replacement parity, acknowledged high-risk consumers, traffic below a justified threshold for a representative window, passing contract tests, rollback readiness, and accountable approval.
  8. Disable reversibly before deletion. Prefer a controlled reject, feature flag, route switch, or scoped block with monitoring. Observe the result before removing code, data, documentation, and operational dependencies.

[!WARNING] Telemetry cannot prove absence when client identification, regions, long-running jobs, or rare workflows are missing. Document the coverage boundary before interpreting zero traffic.

Output

Produce a consumer matrix, replacement gap analysis, milestone timeline, communication plan, telemetry design, migration aids, exit checklist, reversible shutdown procedure, rollback trigger, and final cleanup list.

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.