agentleFS
extra-orgextra-org/extra/.claude/skills/project-architecture/SKILL.md

project-architecture

Skill119 starsChanged 5 months agoMITView on GitHub

Foundational rules and layout for the declarative agent platform. Read this before any change, regardless of area; it anchors every other skill.

7 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

6 rules. 0 are common, 4 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 6 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Do not edit this file directly.

    line 10
  2. Distinctive:

    Always. Read this before any change, regardless of area.

    line 18
  3. Very specific:

    Follow the planned package layout in AGENTS.md (src/agentplatform/<layer>).

    line 44
  4. Distinctive:

    No giant single-file modules.

    line 45
  5. Distinctive:

    Keep each module to one architectural responsibility.

    line 46
  6. Distinctive:

    Do not change public contracts (YAML schema, plugin contracts, API shape) without an ADR and approval.

    line 49

“Common” is measured: kept by at least 6 in 10 of the 6 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md
<!-- This file is generated by tools/skills. Do not edit this file directly. Edit .ai/skills/project-architecture.md and run `make generate-ai`. -->

Skill: Project Architecture

When to use this skill

Always. Read this before any change, regardless of area. It anchors every other skill in the project's non-negotiable rules and layout.

Files to read first

  • AGENTS.md
  • docs/ARCHITECTURE.md
  • docs/ROADMAP.md
  • docs/adr/

Architecture rules

  • The pipeline is one-directional: config.yml → validate → compile → CompiledAgentGraph → RuntimeEngine → ExecutionContext (per request) → execution → response + trace.
  • YAML is declarative specification, never executable business logic.
  • Validate before compile; compile before run. The runtime sees only compiled, typed models — never raw YAML dicts.
  • RuntimeEngine is created once at startup; ExecutionContext is per request.
  • Client-specific auth/business logic lives in customer plugins, not the runtime.
  • Prompts are templates rendered per request; security is enforced at the tool/data layer, not via prompt text.
  • Secrets never live in YAML or prompts.

Implementation rules

  • Follow the planned package layout in AGENTS.md (src/agentplatform/<layer>). No giant single-file modules.
  • Keep each module to one architectural responsibility.
  • Respect layer boundaries: a layer depends only on the typed outputs of the layers before it.
  • Do not change public contracts (YAML schema, plugin contracts, API shape) without an ADR and approval.
  • Stay within the current task's scope; propose new tasks for discovered work.

Validation checklist

  • Change fits the layered architecture and the planned layout.
  • No architecture rule from AGENTS.md §3 is violated.
  • No contract changed without an ADR.
  • Tests added for new behavior.
  • make check passes.

Common mistakes to avoid

  • Reading raw YAML in the runtime instead of compiled models.
  • Adding request state to RuntimeEngine or the compiled graph.
  • Putting customer auth/business logic in the runtime.
  • Expanding scope beyond the current task or doing large uncontrolled rewrites.
  • Relying on prompt wording for security.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.