II.
Workflow overview
Reference · liveworkflow:sdk-api-design
SDK / API Design overview
Collaborative design workflow for creating stable, ergonomic public SDK and API interfaces that will be consumed by external developers or internal platform teams. The platform engineer drafts an interface proposal covering method signatures, data models, error semantics, versioning strategy, and backward compatibility guarantees. The architect reviews the proposal for consistency with existing platform conventions and long-term extensibility. Iterative feedback rounds incorporate input from potential consumers before the interface is frozen. Final design documentation and code stubs are committed as the authoritative contract ahead of implementation.
Attributes
displayName
SDK / API Design
description
Collaborative design workflow for creating stable, ergonomic public SDK and API
interfaces that will be consumed by external developers or internal platform teams.
The platform engineer drafts an interface proposal covering method signatures, data
models, error semantics, versioning strategy, and backward compatibility guarantees.
The architect reviews the proposal for consistency with existing platform conventions
and long-term extensibility. Iterative feedback rounds incorporate input from potential
consumers before the interface is frozen. Final design documentation and code stubs
are committed as the authoritative contract ahead of implementation.
workflowKind
development
triggerType
on-demand
typicalCadence
per-feature
complexity
complex
Outgoing edges
applies_to_domain1
- domain:software-engineering·DomainSoftware Engineering
involves_role4
- role:platform-engineer·Role
- role:architect·RoleArchitect
- role:tech-lead·RoleTech Lead
- role:technical-writer·RoleTechnical Writer
Incoming edges
follows_workflow2
- stack-profile:sdk-developer-kit·StackProfileSDK / Developer Kit Stack (TypeScript, tsup, Vitest, Typedoc, npm, GitHub Actions)
- stack-profile:plugin-extension-system·StackProfilePlugin / Extension System Stack (TypeScript, JSON Schema, Vitest, npm, esbuild)
lib_implements_workflow48
- lib-process:cli-mcp-development--argument-parser-setup·LibraryProcessspecializations/cli-mcp-development/argument-parser-setup
- lib-process:cli-mcp-development--cli-application-bootstrap·LibraryProcessspecializations/cli-mcp-development/cli-application-bootstrap
- lib-process:cli-mcp-development--cli-binary-distribution·LibraryProcessspecializations/cli-mcp-development/cli-binary-distribution
- lib-process:cli-mcp-development--cli-command-structure-design·LibraryProcessspecializations/cli-mcp-development/cli-command-structure-design
- lib-process:cli-mcp-development--cli-documentation-generation·LibraryProcessspecializations/cli-mcp-development/cli-documentation-generation
- lib-process:cli-mcp-development--cli-output-formatting·LibraryProcessspecializations/cli-mcp-development/cli-output-formatting
- lib-process:cli-mcp-development--cli-unit-integration-testing·LibraryProcessspecializations/cli-mcp-development/cli-unit-integration-testing
- lib-process:cli-mcp-development--cli-update-mechanism·LibraryProcessspecializations/cli-mcp-development/cli-update-mechanism
- lib-process:cli-mcp-development--configuration-management-system·LibraryProcessspecializations/cli-mcp-development/configuration-management-system
- lib-process:cli-mcp-development--cross-platform-cli-compatibility·LibraryProcessspecializations/cli-mcp-development/cross-platform-cli-compatibility
- lib-process:cli-mcp-development--dashboard-monitoring-tui·LibraryProcessspecializations/cli-mcp-development/dashboard-monitoring-tui
- lib-process:cli-mcp-development--error-handling-user-feedback·LibraryProcessspecializations/cli-mcp-development/error-handling-user-feedback
- lib-process:cli-mcp-development--interactive-form-implementation·LibraryProcessspecializations/cli-mcp-development/interactive-form-implementation
- lib-process:cli-mcp-development--interactive-prompt-system·LibraryProcessspecializations/cli-mcp-development/interactive-prompt-system
- lib-process:cli-mcp-development--mcp-client-implementation·LibraryProcessspecializations/cli-mcp-development/mcp-client-implementation
- lib-process:cli-mcp-development--mcp-resource-provider·LibraryProcessspecializations/cli-mcp-development/mcp-resource-provider
- lib-process:cli-mcp-development--mcp-server-bootstrap·LibraryProcessspecializations/cli-mcp-development/mcp-server-bootstrap
- lib-process:cli-mcp-development--mcp-server-monitoring-debugging·LibraryProcessspecializations/cli-mcp-development/mcp-server-monitoring-debugging
- lib-process:cli-mcp-development--mcp-server-registry-discovery·LibraryProcessspecializations/cli-mcp-development/mcp-server-registry-discovery
- lib-process:cli-mcp-development--mcp-server-security-hardening·LibraryProcessspecializations/cli-mcp-development/mcp-server-security-hardening
- lib-process:cli-mcp-development--mcp-server-testing-suite·LibraryProcessspecializations/cli-mcp-development/mcp-server-testing-suite
- lib-process:cli-mcp-development--mcp-tool-documentation·LibraryProcessspecializations/cli-mcp-development/mcp-tool-documentation
- lib-process:cli-mcp-development--mcp-tool-implementation·LibraryProcessspecializations/cli-mcp-development/mcp-tool-implementation
- lib-process:cli-mcp-development--mcp-transport-layer·LibraryProcessspecializations/cli-mcp-development/mcp-transport-layer
- lib-process:cli-mcp-development--package-manager-publishing·LibraryProcessspecializations/cli-mcp-development/package-manager-publishing
- lib-process:cli-mcp-development--plugin-architecture-implementation·LibraryProcessspecializations/cli-mcp-development/plugin-architecture-implementation
- lib-process:cli-mcp-development--progress-status-indicators·LibraryProcessspecializations/cli-mcp-development/progress-status-indicators
- lib-process:cli-mcp-development--shell-completion-scripts·LibraryProcessspecializations/cli-mcp-development/shell-completion-scripts
- lib-process:cli-mcp-development--shell-script-development·LibraryProcessspecializations/cli-mcp-development/shell-script-development
- lib-process:cli-mcp-development--tui-application-framework·LibraryProcessspecializations/cli-mcp-development/tui-application-framework
- lib-process:programming-languages--bytecode-vm-implementation·LibraryProcessspecializations/programming-languages/bytecode-vm-implementation
- lib-process:programming-languages--code-generation-llvm·LibraryProcessspecializations/programming-languages/code-generation-llvm
- lib-process:programming-languages--concurrency-primitives·LibraryProcessspecializations/programming-languages/concurrency-primitives
- lib-process:programming-languages--error-message-enhancement·LibraryProcessspecializations/programming-languages/error-message-enhancement
- lib-process:programming-languages--ffi-implementation·LibraryProcessspecializations/programming-languages/ffi-implementation
- lib-process:programming-languages--garbage-collector-implementation·LibraryProcessspecializations/programming-languages/garbage-collector-implementation
- lib-process:programming-languages--generics-polymorphism·LibraryProcessspecializations/programming-languages/generics-polymorphism
- lib-process:programming-languages--interpreter-implementation·LibraryProcessspecializations/programming-languages/interpreter-implementation
- lib-process:programming-languages--jit-compiler-development·LibraryProcessspecializations/programming-languages/jit-compiler-development
- lib-process:programming-languages--lexer-implementation·LibraryProcessspecializations/programming-languages/lexer-implementation
- lib-process:programming-languages--lsp-server-implementation·LibraryProcessspecializations/programming-languages/lsp-server-implementation
- lib-process:programming-languages--macro-system-implementation·LibraryProcessspecializations/programming-languages/macro-system-implementation
- lib-process:programming-languages--parser-development·LibraryProcessspecializations/programming-languages/parser-development
- lib-process:programming-languages--pattern-matching-implementation·LibraryProcessspecializations/programming-languages/pattern-matching-implementation
- lib-process:programming-languages--repl-development·LibraryProcessspecializations/programming-languages/repl-development
- lib-process:programming-languages--semantic-analysis·LibraryProcessspecializations/programming-languages/semantic-analysis
- lib-process:programming-languages--source-map-generation·LibraryProcessspecializations/programming-languages/source-map-generation
- lib-process:programming-languages--type-system-implementation·LibraryProcessspecializations/programming-languages/type-system-implementation