api-design · margelo — Claude Code skill: what it does, how to install
This skill shapes and reviews public APIs for TypeScript, JavaScript, React, and React Native libraries before implementation.
npx skills add margelo/react-native-skills --skill api-design -a claude-codeWhat api-design does
api-design starts with the consumer-facing TypeScript surface rather than the internal implementation. It covers exported functions and classes, hooks, option objects, events, listener contracts, error behavior, naming, and APIs shared across platforms.
Its workflow asks for realistic call sites, including failure and cleanup cases, then checks the exported types with the repository’s typecheck, lint, and documentation tooling. The guidance favors typed state variants, focused option objects, and a clear split between required configuration and best-effort preferences.
A Nitro Module needs build-nitro-modules afterward: api-design handles the public TypeScript and React shape, while the second skill covers Nitro-specific specs, native state, and bindings.
What it helps with
- shape a library’s exported API before coding
- review typed states and failure behavior
- separate required settings from preferences
- write call-site examples with cleanup paths
- check the API against typecheck, lint, and docs
Example prompts for the agent
- Design the public TypeScript API for this library before implementing its internals.
- Review these options and state variants so invalid combinations cannot be represented.
- Create call-site examples that cover an error and resource cleanup.
How to install api-design
1Skills CLI (Vercel)
npx skills add margelo/react-native-skills --skill api-design -a claude-code2Manually: put the files in place
~/.claude/skills/api-design/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/api-design/
1Skills CLI (Vercel)
npx skills add margelo/react-native-skills --skill api-design -a codex2Manually: put the files in place
.agents/skills/api-design/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add margelo/react-native-skills --skill api-design -a cursor2Manually: put the files in place
.cursor/skills/api-design/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install margelo/react-native-skills api-design2Manually: put the files in place
.github/skills/api-design/SKILL.md1Skills CLI (Vercel)
npx skills add margelo/react-native-skills --skill api-design -a gemini-cli2Platform CLI
gemini skills install https://github.com/margelo/react-native-skills --path skills/api-designManually: put the files in place
.devin/skills/api-design/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add margelo/react-native-skills --skill api-design -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about api-design
How do I install api-design in Claude Code?
Run npx skills add margelo/react-native-skills --skill api-design -a claude-code, then check ~/.claude/skills/api-design/SKILL.md.
What does api-design do?
It helps design and review public APIs for TypeScript, JavaScript, React, and React Native libraries, covering types, options, events, errors, naming, and cross-platform behavior.
What changes when the library is a Nitro Module?
Use api-design for the public TypeScript and React API first. Follow it with build-nitro-modules for Nitro-specific specifications, native state, and binding constraints.
Similar skills
All skills for Backend and APIs →api-design by other authors comes first.