Design Documentation#
Architecture and design documentation for scafctl.
Core Architecture#
- Solutions — Solutions architecture
- Resolvers — Resolver system design
- Providers — Provider framework design
- Actions — Actions system design
- Authentication — Authentication architecture
- CEL Integration — CEL expression language integration
- Catalog — Catalog system design
- CLI — Command-line interface design
- Plugins — Plugin system architecture and auto-fetch
- Testing — Testing strategy and patterns
- Miscellaneous — Cross-cutting design considerations
Architecture Decision Records#
- Solution Provider — Solution provider design
- Catalog Build Bundling — Solution file bundling
- Catalog CLI Design Decision — ADR: push/pull reference patterns
- JSON Schema Migration — ADR: provider schema approach
- Shared Library Migration — Shared library extraction for MCP/CLI parity
- Future Enhancements — Planned features and enhancements
MCP & AI Integration#
- MCP Server — MCP server architecture and tool design
- MCP Server Enhancements — Enhanced tools, prompts, resources, and CLI parity
- MCP Server Implementation Guide — Implementation patterns and conventions
REST API#
- API Surface — REST API endpoint reference and design
- Web API Implementation Plan — Implementation plan and architecture
Auth & Infrastructure#
- Entra Auth Implementation — Microsoft Entra ID authentication
- GCP Auth Handler — Google Cloud Platform authentication
- GitHub Auth Handler — GitHub authentication
- OTel Telemetry Migration — OpenTelemetry integration
- State — State management design
Contributing#
- CLI Contributing — How to implement CLI commands
- Hugo Guide — How to work on the documentation site