Skill: SDK Design Patterns

When to Activate

• Designing a client library for a REST, gRPC, or WebSocket API
• Evaluating whether to generate an SDK from OpenAPI or write it manually
• Reviewing an existing SDK for ergonomics, consistency, or backward compatibility
• Planning a multi-language SDK strategy
• Setting up automated SDK publishing from CI
• Designing error hierarchies for a developer-facing library
• Writing documentation for public APIs

Core SDK Design Principles

1. Progressive Disclosure

The simplest use case must be accomplishable in 3 lines. Full control must still be possible.