Skip to content

Latest commit

History

44 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

FlossWare Engineering Standards

This repository defines shared engineering standards, architecture decisions, and development conventions for the FlossWare ecosystem.

Core Principles

  • Configuration is the source of truth.
  • Defaults are minimal; capabilities are explicitly enabled.
  • Components are modular and composable.
  • Provider- and pricing-neutral: no AI provider, model vendor, hosting topology, or pricing tier is an architectural default.
  • Avoid unnecessary coupling.
  • Favor automation, repeatability, and infrastructure-as-code.
  • Agent-neutral: capabilities and infrastructure, not a required agent runtime or UI.
  • Capability before protocol; security at capability boundaries.
  • Released artifacts are derived, reproducible delivery outputs, not sources of truth.

See ADR-0009, ADR-0016, ADR-0021, ADR-0022, and ADR-0023 for normative statements.

Architecture Decisions

Architecture decisions are documented as ADRs under adr/.

ADRTopic
ADR-0001Explicit Opt-In Cross-Cutting Behavior
ADR-0002AI Provider Abstraction
ADR-0003No Local Inference by Default
ADR-0004MCP and Tool Contracts
ADR-0005Event-Driven Internal Bus
ADR-0006Cross-Cutting Decorators
ADR-0007Unified Client-Service Contract
ADR-0008Historical Free-First Platform Policy (Superseded)
ADR-0009Core Architecture Principles
ADR-0010REST Service Boundaries and Integration
ADR-0011Stored Procedure Database Access Policy
ADR-0012Multi-Model Consensus for Quality Gates
ADR-0013Bandit-Based Model Selection
ADR-0014Token Budget Management
ADR-0015Dynamic AI Model Inventory
ADR-0016Configuration as Source of Truth
ADR-0017Agent-Neutral Architecture
ADR-0018MCP Capability Exposure
ADR-0019Agent Tool Security and Authorization
ADR-0020Capability and Protocol Separation
ADR-0021Provider-Neutral AI Selection
ADR-0022Reproducible Build Artifacts and Distribution
ADR-0023Canonical FlossWare AI Persistent State Root

New ADRs SHOULD use adr/TEMPLATE.md.

Suggested read order (MCP / capability cluster)

  1. ADR-0020 — capability vs protocol
  2. ADR-0004 — MCP preference for agents
  3. ADR-0018 — MCP exposure rules
  4. ADR-0019 — tool security
  5. ADR-0017 — agent-neutral posture
  6. ADR-0021 — provider and pricing neutrality
  7. ADR-0022 — reproducible artifact distribution
  8. ADR-0023 — persistent AI state ownership

Reference architecture

ADR Process

All ADRs should include:

  • Status
  • Date
  • Context
  • Scope and Non-goals (recommended; required for new ADRs)
  • Decision
  • Consequences (positive and negative)
  • Alternatives considered
  • Related ADRs

RFC 2119 keywords are used consistently:

  • SHALL / SHALL NOT: mandatory requirements (MUST is treated as equivalent to SHALL)
  • SHOULD / SHOULD NOT: strong recommendation
  • MAY: optional behavior

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors