DESIGN.md@packages/api/architectureA

DESIGN.md@packages/api/architecture from constructorfabric/gears-frontx is a DESIGN.md file: the design rules coding agents follow in that repo.

Install it, pinned
mdr add constructorfabric/gears-frontx/packages/api/architecture/DESIGN.md@git:20261019.7303aa4

Pins git:20261019.7303aa4 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 14 of 14 checks passed
Kind
DESIGN.md file
Repository
constructorfabric/gears-frontx
Path
packages/api/architecture/DESIGN.md
Versions recorded
2
Latest version
git:20261019.7303aa4, committed Oct 19, 2026
First version recorded
Aug 10, 2026
Size
19,783 bytes
Repository stars
30
License
Apache-2.0

Technical design of the @gears-frontx/api protocol surface — protocol-separated request/response and streaming communication, plugin chains with short-circuit, and a realm-shared retainer-counted fetch cache.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Technical Design — API Protocol Surface

- [x] `p3` - **ID**: `cpt-frontx-api-design-api-protocol-surface`

<!-- toc -->

- [1. Architecture Overview](#1-architecture-overview)
  - [1.1 Architectural Vision](#11-architectural-vision)
  - [1.2 Architecture Drivers](#12-architecture-drivers)
  - [1.3 Architecture Layers](#13-architecture-layers)
- [2. Principles & Constraints](#2-principles--constraints)
  - [2.1 Design Principles](#21-design-principles)
  - [2.2 Constraints](#22-constraints)
- [3. Technical Architecture](#3-technical-architecture)
  - [3.1 Domain Model](#31-domain-model)
  - [3.2 Component Model](#32-component-model)
  - [3.3 API Contracts](#33-api-contracts)
  - [3.4 Internal Dependencies](#34-internal-dependencies)
  - [3.5 External Dependencies](#35-external-dependencies)
  - [3.6 Interactions & Sequences](#36-interactions--sequences)
  - [3.7 Database schemas & tables](#37-database-schemas--tables)
- [4. Additional context](#4-additional-context)
- [5. Traceability](#5-traceability)

<!-- /toc -->

## 1. Architecture Overview

### 1.1 Architectural Vision
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add constructorfabric/gears-frontx/packages/api/architecture/DESIGN.md@sha256:6be82e80daa5bafe

The line at the top of this page pins the label git:20261019.7303aa4, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_xks5qe74jaznx7hh.svg)](https://markdownregistry.com/a/art_xks5qe74jaznx7hh)

2 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 2 versions of this file, between Aug 10, 2026 and Oct 19, 2026, about one every 70 days.

versioncommittedcommitsizeaudit
git:20261019.7303aa4 latest2026-10-19 7303aa4 19,783 BA view · diff
git:20260810.fb5925a2026-08-10 fb5925a 19,559 BA view

Audit of the latest version

A  14 of 14 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Size between 200 bytes and 200 KB (19783 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

constructorfabric/gears-frontx · 30 stars · license Apache-2.0 · pushed 2026-10-20 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_xks5qe74jaznx7hh
GET https://markdownregistry.com/api/v1/resolve?ref=constructorfabric/gears-frontx/packages/api/architecture/DESIGN.md
GET https://markdownregistry.com/api/v1/blob/6be82e80daa5bafed243da5973f3e6b79a5251c61eb49ad9bb3f0adc3368b120

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: what DESIGN.md is and how agents use it · which agent file does what.

More from constructorfabric/gears-frontx

AGENTS.md@.cf-studio/config AGENTS.md file
constructorfabric/gears-frontx · .cf-studio/config/AGENTS.md
git:20261012.dbc0bcf · audit A · 30 stars
config SKILL.md skill
constructorfabric/gears-frontx · .cf-studio/config/SKILL.md
git:20260724.f63c5ec · audit C · 30 stars
cf-sdlc-change-impact-analysis SKILL.md skill
constructorfabric/gears-frontx · .claude/skills/cf-sdlc-change-impact-analysis/SKILL.md · Invoke when the user intent is analyzing the impact of an upstream artifact change…
git:20261019.3263a3e · audit A · 30 stars
cf-sdlc-decompose SKILL.md skill
constructorfabric/gears-frontx · .claude/skills/cf-sdlc-decompose/SKILL.md · Invoke when the user asks to decompose, break down, or author/revise a DECOMPOSITION — e.g. "decompose", "break into…
git:20261019.3263a3e · audit A · 30 stars
cf-sdlc-doc-adr SKILL.md skill
constructorfabric/gears-frontx · .claude/skills/cf-sdlc-doc-adr/SKILL.md · Invoke when the user asks to author, write, revise, generate, or record an ADR or architecture decision — e.g…
git:20261019.3263a3e · audit A · 30 stars
cf-sdlc-doc-design SKILL.md skill
constructorfabric/gears-frontx · .claude/skills/cf-sdlc-doc-design/SKILL.md · Invoke when the user asks to author, write, revise, generate, or produce a DESIGN or system/technical design — e.g…
git:20261019.3263a3e · audit A · 30 stars
cf-sdlc-doc-feature SKILL.md skill
constructorfabric/gears-frontx · .claude/skills/cf-sdlc-doc-feature/SKILL.md · Invoke when the user asks to author, write, revise, generate, or spec a FEATURE — e.g. "generate FEATURE", "spec the…
git:20261019.3263a3e · audit A · 30 stars
cf-sdlc-doc-prd SKILL.md skill
constructorfabric/gears-frontx · .claude/skills/cf-sdlc-doc-prd/SKILL.md · Invoke when the user asks to author, write, revise, or generate a PRD — e.g. "generate PRD", "write the PRD", "create…
git:20261019.3263a3e · audit A · 30 stars
cf-sdlc-implement SKILL.md skill
constructorfabric/gears-frontx · .claude/skills/cf-sdlc-implement/SKILL.md · Invoke when the user asks to implement, build, or write the code for a FEATURE — e.g. "implement", "write the code"…
git:20261019.3263a3e · audit A · 30 stars
cf-sdlc-reverse-engineer SKILL.md skill
constructorfabric/gears-frontx · .claude/skills/cf-sdlc-reverse-engineer/SKILL.md · Invoke when the user intent is reconstructing SDLC artifacts (PRD/ADR/DESIGN/DECOMPOSITION/FEATURE) from existing code…
git:20261019.3263a3e · audit A · 30 stars
team-lead SKILL.md skill
constructorfabric/gears-frontx · .claude/skills/team-lead/SKILL.md · Use this skill whenever delegating work to subagents — whether a single Task call or a full team via TeamCreate. Guides…
git:20260810.4dc1101 · audit A · 30 stars
frontx Cursor rule
constructorfabric/gears-frontx · .cursor/rules/frontx.mdc · FrontX development guidelines
git:20260730.e46ecc2 · audit A · 30 stars

Every file in constructorfabric/gears-frontx

Browse by kind, by grade A, or by owner.