# API Design

> Use when designing APIs, tool schemas, commands or integration contracts.

- Skill: `vinilana/api-design` (Agent Skill)
- Install (CLI): `npx skillmds@latest add vinilana/api-design`
- Raw SKILL.md: https://api.skillmd.com/api/skills/vinilana/api-design/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Integrations & APIs
- Author: vinilana (https://skillmd.com/u/vinilana)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/vinilana/api-design

---


# API Design

## Procedure

1. Confirm the task scope and active PREVC phase.
2. Load the relevant project docs from `.context/docs/`.
3. Apply the checklist below to the specific files in scope.
4. Capture validation evidence and unresolved risks.

## Checklist

- Use repository-specific conventions, not generic defaults.
- Reference concrete files, commands and outputs.
- Keep recommendations actionable and prioritized.
- If information is missing, inspect the codebase first, then ask a focused question only when needed.

## Project Notes

- Use this skill against a pi-extension codebase with TypeScript as the primary language.
- CLI flag --dotcontext-feedforward: Inject .context docs/agents/skills before each agent turn
- custom session message aicoders-context-feedforward: Custom message type emitted into the pi session.
- custom session message aicoders-guardrails-context: Custom message type emitted into the pi session.
- custom session message prevc-context: Custom message type emitted into the pi session.
- LLM tool prevc_workflow: Registra e avança etapas do workflow PREVC: P planejar, R revisar, E executar, V validar, C confirmar/commit.
- pi event hook before_agent_start: Extension subscribes to this pi lifecycle/event hook.

## Useful Context

- `.context/docs/project-overview.md`
- `.context/docs/development-workflow.md`
- `.context/docs/architecture.md`
- `.context/docs/glossary.md`
- `.context/docs/security.md`
- `.context/docs/data-flow.md`
- `.context/docs/contributing.md`
- `.context/docs/api.md`