freeshard-architecture-contract

Enforces architectural invariants and security constraints for shard_core FastAPI applications.

47|2|Updated Feb 11, 2025
One-click install
npx skills add https://github.com/FreeshardBase/freeshard --skill freeshard-architecture-contract
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: freeshard-architecture-contract
Source: https://github.com/FreeshardBase/freeshard/tree/main/.claude/skills/freeshard-architecture-contract
Command: npx skills add https://github.com/FreeshardBase/freeshard --skill freeshard-architecture-contract

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents architectural regressions and security vulnerabilities in the shard_core codebase by enforcing strict adherence to established design invariants, auth models, and startup sequences.

Core Features & Use Cases

  • Auth Enforcement Audit: Validates that changes to endpoints respect the Traefik-gated security model and do not inadvertently expose internal routes.
  • Lifecycle & State Management: Provides guidance on the critical startup/shutdown order and the app status machine to prevent deadlocks and boot loops.
  • Use Case: Before modifying app_factory.py or adding a new internal route, use this Skill to verify that your changes comply with the existing auth-path caches and signal-driven invalidation rules.

Quick Start

Use the freeshard-architecture-contract skill to audit my proposed changes to the auth middleware and ensure they do not violate the existing Traefik forwardAuth design.

Frequently Asked Questions about freeshard-architecture-contract

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit FastAPI endpoint changes for Traefik forwardAuth security violations?▼

To audit FastAPI endpoint changes for Traefik forwardAuth security violations, validate that route modifications respect the Traefik-gated security model and do not inadvertently expose internal routes outside the established auth-path caches.

What is the correct startup and shutdown order for a FastAPI service lifecycle to prevent boot loops?▼

The correct FastAPI service lifecycle requires strict adherence to the critical startup and shutdown order alongside the app status machine, which prevents deadlocks and boot loops during signal-driven state synchronization.

How do I enforce architectural invariants when modifying Docker network topology and auth middleware?▼

Enforce architectural invariants when modifying Docker network topology and auth middleware by validating changes against established design constraints, ensuring Traefik-based auth enforcement and signal-driven invalidation rules remain uncompromised.

Does the shard_core architecture contract support code reviews for signal-driven state synchronization protocols?▼

Yes, the shard_core architecture contract supports code reviews for signal-driven state synchronization protocols by applying strict compliance checks to design changes involving authentication and service lifecycle management.

Why does my FastAPI app_factory.py modification break the existing auth-path cache?▼

Your app_factory.py modification likely breaks the existing auth-path cache by violating the Traefik forwardAuth design or bypassing the signal-driven invalidation rules that maintain architectural invariants and security constraints.