agentleFS
gnegreiros-uxgnegreiros-ux/agentica-design-system/AGENTS.md

agentica-design-system

AGENTS.md2 starsChanged 42 days agoApache-2.0View on GitHub

This file is the entry point for any AI agent interacting with this design system. Read this file first. Always. Type: instruction Logical path: AGENTS.md Author: Guilherme Negreiros Read before: DESIGN.md Relations: DESIGN.md, governance/rules/project-overview.md, governance/instructions/codebase-context.md, How-to-without-agents.md (fallback if agents are unavailable) The human always has the final word. Agents execute, propose, and detect drift. Strategic decisions, exceptions, and values belong to the teams. The orchestrator coordinates the agents. It decides: - Which changes are safe to automate - Which require…

The file

We split this AGENTS.md into the rules it gives an agent

5 rules. About 0 are common, 3 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    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. Distinctive:

    Role: Keep docs in sync with components

    line 36
  2. Distinctive:

    Can: Run accessibility tests, visual regressions, token conformance

    line 43
  3. Distinctive:

    When to escalate to the team

    line 54
  4. Very specific:

    If you're Codex CLI or GitHub Copilot: .agents/skills/ already has working ports of Agentica's 7 core skills (open Agent Skills format — …

    line 112
  5. Very specific:

    Read governance/ai-skills-reference.md for what all of .claude/skills/ automates — including the pipeline checklists that aren't ported …

    line 118

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “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
AGENTS.md

AGENTS.md — Agent Router

This file is the entry point for any AI agent interacting with this design system. Read this file first. Always. Type: instruction Logical path: AGENTS.md Author: Guilherme Negreiros Read before: DESIGN.md Relations: DESIGN.md, governance/rules/project-overview.md, governance/instructions/codebase-context.md, How-to-without-agents.md (fallback if agents are unavailable)


Core principle

The human always has the final word. Agents execute, propose, and detect drift. Strategic decisions, exceptions, and values belong to the teams.


Available agents

Designer Agent

Role: Monitor drift in Figma Can: Detect detached instances, components without a description, inconsistent spacing Cannot: Automatically modify Figma files Produces: Drift reports — human approval required before action

Developer Agent

Role: Detect token misuse in code Can: Detect hardcoded colors, deprecated tokens, duplicated components, open suggestion PRs Cannot: Merge without human approval Produces: Correction PRs — review required

Documentation Agent

Role: Keep docs in sync with components Can: Generate changelogs, migration guides, accessibility notes Cannot: Publish without validation Produces: Documentation drafts — human validation required

QA Agent

Role: Systematic checks before merge Can: Run accessibility tests, visual regressions, token conformance Cannot: Approve a merge Produces: Conformance reports — blocking on critical violations


Orchestrator

The orchestrator coordinates the agents. It decides:

  • Which changes are safe to automate
  • Which require human approval
  • When to escalate to the team

Escalation rule: Any change touching a semantic token or a component contract is automatically escalated.


Files to read before any action

DESIGN.md                                    ← portable contract — always read first
governance/rules/project-overview.md         ← project context
governance/rules/tokens-system.md            ← token rules
governance/rules/ux-patterns-sources.md      ← sources + UX pattern review (before any component)
governance/rules/figma-components.md         ← Figma rules (properties, auto-layout, naming, API)
governance/instructions/codebase-context.md  ← technical context
governance/instructions/verification-standards.md ← how to verify and report your own work
governance/instructions/session-spec.md      ← condensed spec for this session
governance/ai-skills-reference.md            ← for non-Claude tools: what .claude/skills/ automates and how to reproduce it
tokens/semantic.json                         ← source of truth for UX intentions
decisions/                                   ← why decisions were made (ADRs)

What agents must never do

  • ❌ Use a hardcoded color or spacing value
  • ❌ Reference a primitive token directly in a component
  • ❌ Modify a semantic token without an approved TCR
  • ❌ Deploy to production without human validation
  • ❌ Ignore an accessibility violation report
  • ❌ Bypass lint rules
  • ❌ Add a token field outside the annotation schema of ADR-102 — descriptions go in $description; team data goes in $extensions["com.agentica.usage"] (how to use a token) or $extensions["com.agentica.governance"] (contract of a file or component); never a new $-prefixed key

Project tracking and decision documentation

Project management

Task tracking (statuses, backlog, priorities, dependencies) lives exclusively in GitHub Projects — never in a versioned file in the repo. See governance/rules/project-overview.md (ADR-069).

Architectural decisions (ADR)

Decisions are documented in decisions/ (not docs/adr/) — one file per ADR, format ADR-XXX-title.md. Read the ADRs that touch the area you're about to work on before taking any action. See .claude/skills/pipelines/adr-triggers.md to know when to create a new one.

Domain context

No CONTEXT.md at the root — domain context lives in DESIGN.md (portable brand contract), guidelines/ (foundations and components), and the governance/rules/ rules.

Using a non-Claude AI tool

If you're Codex CLI or GitHub Copilot: .agents/skills/ already has working ports of Agentica's 7 core skills (open Agent Skills format — load them the way you normally load project skills, no setup needed). If you're Gemini CLI: .gemini/settings.json + .gemini/hooks/*.js already reproduce the ADR-trigger and UX-pattern-review reminder hooks natively.

Read governance/ai-skills-reference.md for what all of .claude/skills/ automates — including the pipeline checklists that aren't ported anywhere yet — and how to reproduce a control your tool doesn't have a working port for. If you're the first to wire this repo up for a tool that doesn't already have a governance/tool-parity/*.md file (check that directory first), you must add one (copy governance/tool-parity/ TEMPLATE.md) recording, for every mandatory control, either how it's replaced or why its absence is accepted. scripts/check-tool-parity.js (CI: .github/workflows/ tool-parity.yml) fails until that file exists and every row is signed off — it will not tell you the tool works correctly, only that a human made the call instead of the gap going unnoticed.

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.