v0.6.16

api-and-interface-design

addyosmani@addyosmani⭐ 117.8k stars· last commit 1d ago· 59 open issues

Guides stable API and interface design. Use when designing APIs, module boundaries, or any public interface. Use when creating REST or GraphQL endpoints, defining type contracts between modules, or establishing boundaries between frontend and backend.

Choose how to use this skill

You do not need every option. Choose the path your AI client supports. The stable page stays the same; versioned files are immutable.

1. Native installer

This listing has no registered native installer command. Use the complete package or source fallback below, depending on what your client supports.

Do not guess an installer command or replace an existing version without reviewing the diff.

2. Complete package recommended

Download the ZIP when available. It includes SKILL.md plus the references, security notes and version metadata.

No complete ProSkills package is published for this listing yet.

3. Prompt-only

Copy the prompt above when the agent can read the stable page or when you want to adopt the workflow without installing a skill.

Need only the instruction file?

Download SKILL.md only if your client requires a single file. The complete ZIP is safer for a full installation because it preserves the references and release context.

No path installs or executes anything by itself. Your agent still needs access to the project files. Before updating, compare the installed version and review the diff.

7.8/10
Verified
Oct 8, 2026

// RATINGS

⭐GitHub Stars
⭐⭐⭐⭐⭐ 117.8k on GitHubGitHub ↗

Very popular

🟢ProSkills ScoreAI Verified
7.8/10
📍

Not yet listed on ClawHub or SkillsMP

// README

Agent Skills

Production-grade engineering skills for AI coding agents.

Skills encode the workflows, quality gates, and best practices that senior engineers use when building software. These ones are packaged so AI agents follow them consistently across every phase of development.

Addy's Agent Skills

  DEFINE          PLAN           BUILD          VERIFY         REVIEW          SHIP
 ┌──────┐      ┌──────┐      ┌──────┐      ┌──────┐      ┌──────┐      ┌──────┐
 │ Idea │ ───▶ │ Spec │ ───▶ │ Code │ ───▶ │ Test │ ───▶ │  QA  │ ───▶ │  Go  │
 │Refine│      │  PRD │      │ Impl │      │Debug │      │ Gate │      │ Live │
 └──────┘      └──────┘      └──────┘      └──────┘      └──────┘      └──────┘
  /spec          /plan          /build        /test         /review       /ship

Commands

9 slash commands that map to the development lifecycle. Each one activates the right skills automatically.

What you're doingCommandKey principle
Define what to build/specSpec before code
Plan how to build it/planSmall, atomic tasks
Build incrementally/buildOne slice at a time
Prove it works/testTests are proof
Set the quality bar/constraintsDecide it once, enforce it everywhere
Review before merge/reviewImprove code health
Audit web performance/webperfMeasure before you optimize
Simplify the code/code-simplifyClarity over cleverness
Ship to production/shipFaster is safer

In Claude Code these install as plugin commands. Where a built-in command has the same name, as /review does, use the namespaced form: /agent-skills:review.

Want fewer manual steps once the spec exists? /build auto generates the plan and implements every task in a single approved pass — you approve the plan once, then it runs autonomously. It removes the human stepping between tasks, not the verification: every task is still test-driven and committed individually, and it pauses on failures or risky steps.

Skills also activate automatically based on what you're doing — designing an API triggers api-and-interface-design, building UI triggers frontend-ui-engineering, and so on.


Quick Start

Fastest path — any agent, one command. The open skills CLI installs into 70+ agents (Claude Code, Cursor, Codex, Copilot, Cline, and more):

npx skills add addyosmani/agent-skills            # install all 25 skills
npx skills add addyosmani/agent-skills --list     # browse before installing

Or grab individual skills:

npx skills add addyosmani/agent-skills --skill code-review-and-quality   # five-axis review before merge
npx skills add addyosmani/agent-skills --skill interview-me              # requirements interrogation, one question at a time
npx skills add addyosmani/agent-skills --skill test-driven-development   # red-green-refactor, enforced

Installing one skill? A per-skill npx install copies only skills/<name>/, not the repo-level references/ directory. The skill still works, but paths to supplementary shared checklists are unavailable. Use a whole-repo integration, clone the repository, or copy the needed checklist into a references/ directory inside the installed skill. This portability gap is tracked in #361.

Prefer a native integration? Pick your tool below.

Marketplace install:

/plugin marketplace add addyosmani/agent-skills
/plugin install agent-skills@addy-agent-skills

SSH errors? The marketplace clones repos via SSH. If you don't have SSH keys set up on GitHub, either add your SSH key or use the full HTTPS URL to force HTTPS cloning during the marketplace-add step:

/plugin marketplace add https://github.com/addyosmani/agent-skills.git
/plugin install agent-skills@addy-agent-skills

If /plugin install still fails with [email protected]: Permission denied (publickey) on Windows or macOS, the recommended workaround is to configure Git once to rewrite GitHub SSH URLs to HTTPS for subprocess clones:

git config --global url."https://github.com/".insteadOf [email protected]:

Local / development:

git clone https://github.com/addyosmani/agent-skills.git
claude --plugin-dir /path/to/agent-skills

Put workflow skills under .cursor/skills/ (sync from agent-skills/skills/) and short policies in .cursor/rules/*.mdc — do not paste full skills into rules. Both directories live in your project; this repo does not ship a .cursor/ folder. See docs/cursor-setup.md.

Install as a native plugin for skills and subagents. In affected Antigravity CLI releases, legacy command TOMLs are reported as converted but their wrapper commands are not discoverable; invoke the underlying namespaced skills directly. See docs/antigravity-setup.md.

Install from the repo:

agy plugin install https://github.com/addyosmani/agent-skills.git

Install from a local clone:

git clone https://github.com/addyosmani/agent-skills.git
agy plugin install ./agent-skills

Install as native skills for auto-discovery, or add to GEMINI.md for persistent context. See docs/gemini-cli-setup.md.

Install from the repo:

gemini skills install https://github.com/addyosmani/agent-skills.git --path skills

Install from a local clone:

gemini skills install ./agent-skills/skills/

Add skill contents to your Windsurf rules configuration. See docs/windsurf-setup.md.

Copy skills to .opencode/skills/ (or ~/.config/opencode/skills/), add a project-local AGENTS.md, and use the built-in skill tool for agent-driven execution. Optional slash commands can be added under .opencode/commands/.

See docs/opencode-setup.md.

Use agent definitions from agents/ as Copilot personas and skill content in .github/copilot-instructions.md. The lifecycle slash commands (/spec, /plan, /build, /test, /review, /ship) are Claude Code commands and do not appear in Copilot; invoke the skills by name (/spec-driven-development, …) instead. See docs/copilot-setup.md.

Using the standalone copilot CLI? Install it as a plugin — see docs/copilot-cli-setup.md.

Install as a native Codex plugin (Codex CLI v0.122+):

codex plugin marketplace add addyosmani/agent-skills
codex plugin add agent-skills@agent-skills

The first command registers the marketplace; the second installs the plugin. Codex reads t

// HOW IT'S BUILT

// FILES

2 files shipped with this skill. Inline text is the catalog copy. The upstream link is the source repository.

  • skills/api-and-interface-design/SKILL.md15 KBce58d72ed0eeupstream ↗
    ---
    name: api-and-interface-design
    description: Guides stable API and interface design. Use when designing APIs, module boundaries, or any public interface. Use when creating REST or GraphQL endpoints, defining type contracts between modules, or establishing boundaries between frontend and backend.
    ---
    
    # API and Interface Design
    
    ## Overview
    
    Design stable, well-documented interfaces that are hard to misuse. Good interfaces make the right thing easy and the wrong thing hard. This applies to REST APIs, GraphQL schemas, module boundaries, component props, and any surface where one piece of code talks to another.
    
    ## When to Use
    
    - Designing new API endpoints
    - Defining module boundaries or contracts between teams
    - Creating component prop interfaces
    - Establishing database schema that informs API shape
    - Changing existing public interfaces
    
    ## Core Principles
    
    ### Hyrum's Law
    
    > With a sufficient number of users of an API, all observable behaviors of your system will be depended on by somebody, regardless of what you promise in the contract.
    
    This means: every public behavior — including undocumented quirks, error message text, timing, and ordering — becomes a de facto contract once users depend on it. Design implications:
    
    - **Be intentional about what you expose.** Every observable behavior is a potential commitment.
    - **Don't leak implementation details.** If users can observe it, they will depend on it.
    - **Plan for deprecation at design time.** See `deprecation-and-migration` for how to safely remove things users depend on.
    - **Tests are not enough.** Even with perfect contract tests, Hyrum's Law means "safe" changes can break real users who depend on undocumented behavior.
    
    ### The One-Version Rule
    
    Avoid forcing consumers to choose between multiple versions of the same dependency or API. Diamond dependency problems arise when different consumers need different versions of the same thing. Design for a world where only one version exists at a time — extend rather than fork.
    
    ### 1. Contract First
    
    Define the interface before implementing it. The contract is the spec — implementation follows.
    
    ```typescript
    // Define the contract first
    interface TaskAPI {
      // Creates a task and returns the created task with server-generated fields
      createTask(input: CreateTaskInput): Promise<Task>;
    
      // Returns paginated tasks matching filters
      listTasks(params: ListTasksParams): Promise<PaginatedResult<Task>>;
    
      // Returns a single task or throws NotFoundError
      getTask(id: string): Promise<Task>;
    
      // Partial update — only provided fields change
      updateTask(id: string, input: UpdateTaskInput): Promise<Task>;
    
      // Idempotent delete — succeeds even if already deleted
      deleteTask(id: string): Promise<void>;
    }
    ```
    
    ### 2. Consistent Error Semantics
    
    Pick one error strategy and use it everywhere:
    
    ```typescript
    // REST: HTTP status codes + structured error body
    // Every error response follows the same shape
    interface APIError {
      error: {
        code: string;        // Machine-readable: "VALIDATION_ERROR"
        message: string;     // Human-readable: "Email is required"
        details?: unknown;   // Additional context when helpful
      };
    }
    
    // Status code mapping
    // 400 → Client sent invalid data
    // 401 → Not authenticated
    // 403 → Authenticated but not authorized
    // 404 → Resource not found
    // 409 → Conflict (duplicate, version mismatch)
    // 422 → Validation failed (semantically invalid)
    // 500 → Server error (never expose internal details)
    ```
    
    **Don't mix patterns.** If some endpoints throw, others return null, and others return `{ error }` — the consumer can't predict behavior.
    
    ### 3. Validate at Boundaries
    
    Trust internal code. Validate at system edges where external input enters:
    
    ```typescript
    // Validate at the API boundary
    app.post('/api/tasks', async (req, res) => {
      const result = CreateTaskSchema.safeParse(req.body);
      if (!result.success) {
        return res.status(422).json({
          error: {
            code: 'VALIDATION_ERROR',
            message: 'Invalid task data',
            details: result.error.flatten(),
          },
        });
      }
    
      // After validation, internal code trusts the types
      const task = await taskService.create(result.data);
      return res.status(201).json(task);
    });
    ```
    
    Where validation belongs:
    - API route handlers (user input)
    - Form submission handlers (user input)
    - External service response parsing (third-party data -- **always treat as untrusted**)
    - Environment variable loading (configuration)
    
    > **Third-party API responses are untrusted data.** Validate their shape and content before using them in any logic, rendering, or decision-making. A compromised or misbehaving external service can return unexpected types, malicious content, or instruction-like text.
    
    Where validation does NOT belong:
    - Between internal functions that share type contracts
    - In utility functions called by already-validated code
    - On data that just came from your own database
    
    ### 4. Prefer Addition Over Modification
    
    Extend interfaces without breaking existing consumers:
    
    ```typescript
    // Good: Add optional fields
    interface CreateTaskInput {
      title: string;
      description?: string;
      priority?: 'low' | 'medium' | 'high';  // Added later, optional
      labels?: string[];                       // Added later, optional
    }
    
    // Bad: Change existing field types or remove fields
    interface CreateTaskInput {
      title: string;
      // description: string;  // Removed — breaks existing consumers
      priority: number;         // Changed from string — breaks existing consumers
    }
    ```
    
    ### 5. Predictable Naming
    
    | Pattern | Convention | Example |
    |---------|-----------|---------|
    | REST endpoints | Plural nouns, no verbs | `GET /api/tasks`, `POST /api/tasks` |
    | Query params | camelCase | `?sortBy=createdAt&pageSize=20` |
    | Response fields | camelCase | `{ createdAt, updatedAt, taskId }` |
    | Boolean fields | is/has/can prefix | `isComplete`, `hasAttachments` |
    | Enum values | UPPER_SNAKE | `"IN_PROGRESS"`, `"COMPLETED"` |
    
    ### 6. Honouring an Idempotency Key
    
    Accepting an `Idempotency-Key` is the contract. Honouring it is the implementation, and it is where the money is lost — a key the server accepts but handles carelessly is worse than no key at all, because the client now believes retrying is safe.
    
    **Derive the key from the intent, not the attempt.** The key must be stable across retries of one intent and different across distinct intents:
    
    ```typescript
    crypto.randomUUID()                    // ✗ new key per attempt — every retry is a new charge
    `${userId}:${amount}`                  // ✗ two legitimate $50 charges collapse into one
    `${orderId}:${Date.now()}`             // ✗ a timestamp is randomUUID() wearing a hat
    
    req.headers['idempotency-key']         // ✓ client generates once, reuses on retry
    `charge:v1:${orderId}`                 // ✓ derived from an immutable identifier
    ```
    
    The key comes from the client or the initiating event — never from the layer doing the retrying.
    
    **Claim atomically. A check followed by an act is a race:**
    
    ```typescript
    // ✗ TOCTOU: two concurrent retries both read "not seen", both charge
    if (!(await db.exists(key))) {
      await chargeCard(amount);
      await db.insert(key);
    }
    
    // ✓ let the unique constraint pick the winner
    try {
      await db.insert({ key, state: 'in_progress', requestHash });
    } catch (e) {
      if (isUniqueViolation(e)) return replayOrReject(key);
      throw e;
    }
    const result = await chargeCard(amount);
    await db.update({ key, state: 'succeeded', response: result });
    ```
    
    The unique constraint *is* the mechanism. A store that cannot enforce uniqueness in one operation cannot back this.
    
    **Guard the payload.** Same key with a different body is a client bug, and must fail loudly rather than serving the first response to a second request:
    
    ```typescript
    if (existing.requestHash !== hash(req.body)) {
      return res.status(422).json({
        error: { code: 'IDEMPOTENCY_KEY_REUSED', message: 'Idempotency key reused with a different payload' },
      });
    }
    ```
    
    **Decide what an in-flight duplicate gets.** The first request is still running when the second arrives — the common case under retry storms:
    
    | Strategy | Response | Use when |
    |---|---|---|
    | Reject | `409 Conflict` | Client can retry later; simplest and safest |
    | Wait | Block for the result, bounded | Caller needs it synchronously |
    | Return pending | `202` + status URL | Long-running effects |
    
    Never let the second caller through because the first "seems stuck". A stalled attempt whose fate is unknown is exactly when duplicating costs most.
    
    **Every call has three outcomes, not two: success, failure, and _unknown_.** A timeout tells you nothing about whether the effect applied. Record the intent *before* calling out, so a crash between the call and the response leaves evidence something must resolve later — rather than a silently retried charge.
    
    **Set retention from the longest retry chain**, not from disk cost. Keys must outlive every path that can re-deliver the same intent, including a dead-letter queue replayed a week later and any provider dispute window. A 24-hour key TTL behind a 7-day DLQ is a duplicate waiting to happen.
    
    ## REST API Patterns
    
    ### Resource Design
    
    ```
    GET    /api/tasks              → List tasks (with query params for filtering)
    POST   /api/tasks              → Create a task
    GET    /api/tasks/:id          → Get a single task
    PATCH  /api/tasks/:id          → Update a task (partial)
    DELETE /api/tasks/:id          → Delete a task
    
    GET    /api/tasks/:id/comments → List comments for a task (sub-resource)
    POST   /api/tasks/:id/comments → Add a comment to a task
    ```
    
    ### Pagination
    
    Paginate list endpoints:
    
    ```typescript
    // Request
    GET /api/tasks?page=1&pageSize=20&sortBy=createdAt&sortOrder=desc
    
    // Response
    {
      "data": [...],
      "pagination": {
        "page": 1,
        "pageSize": 20,
        "totalItems": 142,
        "totalPages": 8
      }
    }
    ```
    
    ### Filtering
    
    Use query parameters for filters:
    
    ```
    GET /api/tasks?status=in_progress&assignee=user123&createdAfter=2025-01-01
    ```
    
    ### Partial Updates (PATCH)
    
    Accept partial objects — only update what's provided:
    
    ```typescript
    // Only title changes, everything else preserved
    PATCH /api/tasks/123
    { "title": "Updated title" }
    ```
    
    ## TypeScript Interface Patterns
    
    ### Use Discriminated Unions for Variants
    
    ```typescript
    // Good: Each variant is explicit
    type TaskStatus =
      | { type: 'pending' }
      | { type: 'in_progress'; assignee: string; startedAt: Date }
      | { type: 'completed'; completedAt: Date; completedBy: string }
      | { type: 'cancelled'; reason: string; cancelledAt: Date };
    
    // Consumer gets type narrowing
    function getStatusLabel(status: TaskStatus): string {
      switch (status.type) {
        case 'pending': return 'Pending';
        case 'in_progress': return `In progress (${status.assignee})`;
        case 'completed': return `Done on ${status.completedAt}`;
        case 'cancelled': return `Cancelled: ${status.reason}`;
      }
    }
    ```
    
    ### Input/Output Separation
    
    ```typescript
    // Input: what the caller provides
    interface CreateTaskInput {
      title: string;
      description?: string;
    }
    
    // Output: what the system returns (includes server-generated fields)
    interface Task {
      id: string;
      title: string;
      description: string | null;
      createdAt: Date;
      updatedAt: Date;
      createdBy: string;
    }
    ```
    
    ### Use Branded Types for IDs
    
    ```typescript
    type TaskId = string & { readonly __brand: 'TaskId' };
    type UserId = string & { readonly __brand: 'UserId' };
    
    // Prevents accidentally passing a UserId where a TaskId is expected
    function getTask(id: TaskId): Promise<Task> { ... }
    ```
    
    ## Common Rationalizations
    
    | Rationalization | Reality |
    |---|---|
    | "We'll document the API later" | The types ARE the documentation. Define them first. |
    | "We don't need pagination for now" | You will the moment someone has 100+ items. Add it from the start. |
    | "PATCH is complicated, let's just use PUT" | PUT requires the full object every time. PATCH is what clients actually want. |
    | "We'll version the API when we need to" | Breaking changes without versioning break consumers. Design for extension from the start. |
    | "Nobody uses that undocumented behavior" | Hyrum's Law: if it's observable, somebody depends on it. Treat every public behavior as a commitment. |
    | "We can just maintain two versions" | Multiple versions multiply maintenance cost and create diamond dependency problems. Prefer the One-Version Rule. |
    | "Internal APIs don't need contracts" | Internal consumers are still consumers. Contracts prevent coupling and enable parallel work. |
    | "Accepting the Idempotency-Key header is enough" | The header is the contract; storing the key against the result is the implementation. A key you accept but don't honour tells the client retrying is safe when it isn't. |
    | "Our queue guarantees exactly-once delivery" | No queue does across a consumer crash — the broker's ack and your side effect are not in one transaction. Design for at-least-once with idempotent processing. |
    | "Duplicate requests are rare" | They're *correlated*. Retries spike exactly when a dependency is degraded — the moment duplicates are most likely and most expensive. |
    
    ## Red Flags
    
    - Endpoints that return different shapes depending on conditions
    - Inconsistent error formats across endpoints
    - Validation scattered throughout internal code instead of at boundaries
    - Breaking changes to existing fields (type changes, removals)
    - List endpoints without pagination
    - Verbs in REST URLs (`/api/createTask`, `/api/getUsers`)
    - Third-party API responses used without validation or sanitization
    - A `SELECT` for an idempotency key followed by an `INSERT` — that's a race, not a guard
    - An idempotency key derived from a UUID, timestamp, or anything else regenerated per attempt
    - The same key accepted with a different request body, silently returning the first response
    - A key retention window shorter than the longest path that can re-deliver the request
    
    ## Verification
    
    After designing an API:
    
    - [ ] Every endpoint has typed input and output schemas
    - [ ] Error responses follow a single consistent format
    - [ ] Validation happens at system boundaries only
    - [ ] List endpoints support pagination
    - [ ] New fields are additive and optional (backward compatible)
    - [ ] Naming follows consistent conventions across all endpoints
    - [ ] API documentation or types are committed alongside the implementation
    - [ ] State-changing endpoints either honour an idempotency key or are documented as unsafe to retry
    - [ ] The key is claimed in one atomic operation, guarded by a unique constraint
    - [ ] A reused key with a different payload fails loudly rather than replaying the wrong response
    - [ ] The in-flight-duplicate response is a deliberate choice (409, wait, or 202) rather than whatever falls out
    - [ ] Key retention outlives the longest retry path, including dead-letter replay
    
  • README.mdupstream ↗

    Contents are not inlined in the catalog. Open the upstream file.

Plain-text copy, no login: /skill-bundles/addyosmani-agent-skills-skills-api-and-interface-design.md

// REPO STATS

117.8k stars
59 open issues
Last commit: 1d ago