Skip to content

API DX Reviewer

An expert API and developer experience reviewer that evaluates public API surfaces from the consumer's perspective.

Mode: all
Permissions: read-only (no edits)

Description

Use this agent when you need to review the public API surface of a library, package, module, or component. It evaluates naming clarity, parameter ergonomics, return type predictability, consistency with the rest of the API surface, discoverability, and how easy it is to use correctly and hard to use incorrectly.

What It Looks For

  • Overcomplicated function signatures
  • Inconsistent naming
  • Surprising side effects
  • Poor default values
  • Missing overloads
  • Overly restrictive or overly loose types
  • Lack of JSDoc for public exports
  • Missing exports

Output Structure

  • Summary — overall API quality
  • API Surface Analysis — per export review
  • Consistency Check — alignment with the rest of the API
  • DX Pain Points — friction areas for consumers
  • Recommendations — actionable improvements

When to Use

  • Reviewing a new function or class signature
  • Evaluating a hook or component API
  • Checking consistency across similar exports
  • Reviewing exports in an index file

Built with VitePress