ring:designing-api-contracts
Designing API contracts (component interfaces, request/response schemas, error catalog, versioning, pagination) from the validated TRD, before any protocol or technology selection. Gate 4 of ring:planning-large-features, Large Track only; runs after ring:writing-trds, before ring:designing-data-model. Use when a multi-component system needs integration contracts. Skip for Small Track, a single-component system, or an unvalidated TRD.
What this skill does
# API/Contract Design — Defining Component Interfaces
## When to use
- TRD passed Gate 3 validation
- System has multiple components that need to integrate
- Building APIs (internal or external)
- Large Track workflow (2+ day features)
## Skip when
- Small Track workflow → skip to Task Breakdown
- Single component system → skip to Data Model
- TRD not validated → complete Gate 3 first
## Sequence
**Runs before:** ring:designing-data-model
**Runs after:** ring:writing-trds
Defines WHAT data and operations components expose and consume, before protocol or technology selection. Contracts enable parallel team work and prevent integration failures discovered during development.
## Phase 0: API Standards Discovery (MANDATORY)
Check if organizational naming standards exist.
AskUserQuestion: "Do you have a data dictionary or API field naming standards to reference?"
- "No — Use industry best practices"
- "Yes — URL to document"
- "Yes — File path"
**If standards provided:** WebFetch or read the document and extract:
- Field naming convention (camelCase vs snake_case)
- Standard field names across APIs (createdAt, updatedAt, isActive)
- Data type formats (dates, IDs, amounts)
- Validation patterns (email, phone)
- Standard error codes
- Pagination fields
Save to `docs/pre-dev/{feature}/api-standards-ref.md`.
## Mandatory Workflow
| Phase | Activities |
|-------|------------|
| **1. Contract Discovery** | From TRD: identify all component interfaces; list operations each component exposes; define data contracts per operation |
| **2. Contract Definition** | Per operation: request schema, response schema, error conditions, versioning; apply API standards if loaded |
| **3. Gate 4 Validation** | All component interfaces defined; contracts complete; naming consistent with standards; error handling specified; versioning strategy documented |
## Contract Rules
### Include
- Operation names and descriptions
- Request schema (fields, types, required/optional, validation)
- Response schema (fields, types, nullable)
- Error catalog (code, HTTP status, condition, resolution)
- Versioning strategy (backward compatibility, deprecation)
- Pagination specification (if list operations)
### Never Include
- Protocol selection (REST vs gRPC → TRD)
- Implementation libraries (which HTTP framework)
- Infrastructure choices (caching layer, CDN)
- Code structure (packages, files)
## API Standards Application
**If api-standards-ref.md loaded:**
Use extracted naming for all field definitions. Document in output: "Fields follow [source] convention."
**If no standards:** Use industry defaults:
- Field naming: camelCase
- IDs: UUID v4
- Timestamps: ISO 8601 UTC
- Pagination: `page`, `limit`, `totalItems`, `nextCursor`
- Errors: `{ "code": "ERROR_CODE", "message": "...", "details": {} }`
## Output Format
**File:** `docs/pre-dev/{feature}/api-design.md`
Required sections:
1. **Standards Reference** — Source used (or "industry defaults")
2. **Component Interface Map** — Table of components + operations
3. **Operation Contracts** — Per operation: request/response schema, errors
4. **Shared Schemas** — Reusable data types
5. **Error Catalog** — All error codes used across operations
6. **Versioning Strategy** — Breaking vs non-breaking changes, deprecation policy
## Topology-Aware Output
| Structure | Files Generated |
|-----------|-----------------|
| single-repo | `docs/pre-dev/{feature}/api-design.md` |
| monorepo | Root `docs/pre-dev/{feature}/api-design.md` |
| multi-repo | Both: `{backend.path}/docs/pre-dev/{feature}/api-design.md` + frontend copy |
## Gate 4 Validation Checklist
| Category | Requirements |
|----------|--------------|
| **Completeness** | All TRD components have interfaces; all operations defined; request/response complete |
| **Naming Consistency** | Fields follow declared naming convention throughout; no mixed conventions |
| **Error Handling** | All error conditions documented; HTTP status codes correct; resolution guidance present |
| **Versioning** | Version strategy documented; backward compatibility rules clear |
| **No Implementation** | Zero protocol specifics; zero framework names; zero infrastructure names |
**Gate Result:** ✅ PASS → Data Model | ⚠️ CONDITIONAL (fix naming/missing fields) | ❌ FAIL (incomplete contracts)
Related in Design
contribute
IncludedLocal-only OSS contribution command center. Auto-refreshes the user's in-flight PR and issue state on invoke so conversations start with full context — no need to brief Claude on what's in flight. Helps the user find issues to contribute to on GitHub, builds per-repo dossiers of what each upstream expects (CLA, DCO, branch convention, AI policy, draft-first, review bots, issue templates), runs deterministic gates before any external action so AI-assisted contributions don't reach maintainers as slop. State is markdown-only: candidate files at ~/.contribute-system/candidates/, repo dossiers at ~/.contribute-system/research/, append-only event log at ~/.contribute-system/log.jsonl. No database, no cloud calls. Use when the user asks about their PRs / issues / contributions, wants to find new work to take on, claim an issue, build/refresh a repo's dossier, or draft a Design Issue or PR. Trigger with "/contribute", "what's my PR status", "find a contribution", "claim issue X", "draft a Design Issue for Y", "refresh dossier for Z".
architectural-analysis
IncludedUser-triggered deep architectural analysis of a codebase or scoped subtree across eight modes — information architecture, data flow, integration points, UI surfaces, interaction patterns, data model, control flow, and failure modes. This skill should be used when the user asks to "diagram this codebase," "map the architecture," "show the data flow," "give me an ERD," "trace control flow," "find the integration points," "verify the layout pattern," "audit the UX architecture," or any similar request whose primary deliverable is mermaid diagrams plus cited reports under docs/architecture/. Dispatches haiku/sonnet sub-agents in parallel for per-mode exploration, then verifies every citation mechanically before any node lands in a diagram. Not for one-off prose explanations of code (use code-explanation) or for high-level system design from scratch (use system-design).
mcp
IncludedModel Context Protocol (MCP) server development and tool management. Languages: Python, TypeScript. Capabilities: build MCP servers, integrate external APIs, discover/execute MCP tools, manage multi-server configs, design agent-centric tools. Actions: create, build, integrate, discover, execute, configure MCP servers/tools. Keywords: MCP, Model Context Protocol, MCP server, MCP tool, stdio transport, SSE transport, tool discovery, resource provider, prompt template, external API integration, Gemini CLI MCP, Claude MCP, agent tools, tool execution, server config. Use when: building MCP servers, integrating external APIs as MCP tools, discovering available MCP tools, executing MCP capabilities, configuring multi-server setups, designing tools for AI agents.
react-native-skia
IncludedDesign, build, debug, and optimise high-polish animated graphics in React Native or Expo using @shopify/react-native-skia, Reanimated, and Gesture Handler. Use when the user wants canvas-driven UI, shaders, paths, rich text, image filters, sprite fields, Skottie, video frames, snapshots, web CanvasKit setup, or performance tuning for custom motion-heavy elements such as loaders, hero art, cards, charts, progress indicators, particle systems, or gesture-driven surfaces. Also use when the user asks for fluid, glow, glass, blob, parallax, 60fps/120fps, or GPU-friendly animated effects in React Native, even if they do not explicitly say "Skia". Do not use for ordinary form/layout work with standard views.
plaid
IncludedProduct Led AI Development — guides founders from idea to launched product. Six capabilities: Idea (discover a product idea), Validate (pressure-test the idea against fatal flaws, problem reality, competition, and 2-week MVP feasibility), Plan (vision intake + document generation), Design (translate image references into a design.md spec), Launch (go-to-market strategy), and Build (roadmap execution). Use when someone says "PLAID", "plaid idea", "help me find an idea", "product idea", "idea from my business", "idea from my expertise", "plaid validate", "validate my idea", "pressure-test", "is this idea good", "find fatal flaws", "validate the problem", "plan a product", "define my vision", "generate a PRD", "product strategy", "plaid design", "design from image", "translate image to design", "create design.md", "extract design tokens", "plaid launch", "go-to-market", "launch plan", "GTM strategy", "launch playbook", "plaid build", "build the app", "start building", or "execute the roadmap".
nextjs-framer-motion-animations
IncludedAdds production-safe Motion for React or Framer Motion animations to Next.js apps, including reveal, hover and tap micro-interactions, whileInView, stagger, AnimatePresence, layout and layoutId transitions, reorder, scroll-linked UI, and lightweight route-content transitions. Use when the user asks to add, refactor, or debug Motion or Framer Motion in App Router or Pages Router codebases, especially around server/client boundaries, reduced motion, LazyMotion, bundle size, hydration, or route transitions. Avoid for GSAP-style timelines, WebGL or 3D scenes, heavy scroll storytelling, or CSS-only effects unless Motion is explicitly requested.