API & interface design

Designing interfaces that are hard to misuse and cheap to evolve — naming, versioning, error shape, defaults.

Installation

$ npx skills add addyosmani/agent-skills

The CLI's unit is the repository, so this installs everything in addyosmani/agent-skills, not api-and-interface-design alone. It writes into whichever agent directories it finds — Claude Code, Codex, Cursor, Copilot, Windsurf, Zed.

Summary

Designing interfaces that are hard to misuse and cheap to evolve — naming, versioning, error shape, defaults.

  • Reach for it when you are about to add a public function, endpoint or package export that other teams will depend on.
  • Sits in Design & architect — interfaces, module boundaries and domain language — decided before the code sets them in concrete.
  • Stack-agnostic — nothing in it assumes a particular language or framework.
  • Published by Addy Osmani. Well regarded, but not the vendor of the thing it covers.
  • Installing pulls the whole addyosmani/agent-skills repository: this catalogue lists 19 other entries from it, and the repo may hold more.

Where it sits in delivery

Design & architectInterfaces, module boundaries and domain language — decided before the code sets them in concrete.Everything in Design

The skill itself

The full text lives with its publisher and changes when they change it. Read it there rather than here — a mirrored copy of somebody else's procedure goes stale silently, and this page would have no way of telling you.

Related

More in Design & architect