You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Anything that matters for development, testing, or operations lives in the repository.
@@ -134,7 +136,8 @@ A skill is a folder that contains:
134
136
135
137
Recommended layout:
136
138
137
-
-`skills/<skill-name>/SKILL.md`
139
+
- Codex: `.codex/skills/<skill-name>/SKILL.md`
140
+
- Claude Code: `.claude/skills/<skill-name>/SKILL.md`
138
141
139
142
Integration principle:
140
143
@@ -615,7 +618,9 @@ Used for:
615
618
To adopt MCAF in a repository:
616
619
617
620
1. A `docs/` directory exists with at least `Architecture/`, `Features/`, `ADR/`, `Testing`, and `Development` (and a `docs/Architecture/Overview.md` entry point).
618
-
2. A `skills/` directory exists with skills used by your agents (each skill has `SKILL.md`).
621
+
2. A skills directory exists in your agent’s supported location (each skill has `SKILL.md`):
622
+
- Codex: `.codex/skills/`
623
+
- Claude Code: `.claude/skills/`
619
624
3. This Guide and a root `AGENTS.md` live at the repository root and are kept current.
620
625
4. Commands for `build`, `test`, `format`, and `analyze` are defined and documented.
621
626
5. Containerized or scripted environments exist for integration/API/UI tests.
@@ -649,4 +654,4 @@ Every significant feature, document, and decision has an accountable owner:
649
654
650
655
-**Onboarding**: New team members read this Guide, the root `AGENTS.md`, and key docs before making changes.
651
656
-**Regular review**: The team periodically reviews `AGENTS.md` and docs to ensure they reflect current practices.
652
-
-**Feedback loops**: Issues with AI agent behaviour are tracked and lead to updates in `AGENTS.md`, skills (`skills/*/SKILL.md`), and docs — not repeated chat corrections.
657
+
-**Feedback loops**: Issues with AI agent behaviour are tracked and lead to updates in `AGENTS.md`, skills (`*/SKILL.md` in your skills directory), and docs — not repeated chat corrections.
Copy file name to clipboardExpand all lines: TUTORIAL.md
+33-9Lines changed: 33 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Get MCAF running in your repository:
8
8
9
9
1. Bootstrap AGENTS.md with AI analysis
10
10
2. Create documentation structure in `docs/` (including `docs/Architecture/Overview.md`)
11
-
3. Add skills in `skills/`
11
+
3. Add skills (agent-specific directory)
12
12
4. Document existing features
13
13
5. Create ADRs for existing decisions
14
14
6. Write feature docs before coding (ongoing workflow)
@@ -90,7 +90,15 @@ Report what you created.
90
90
91
91
Skills are part of MCAF: keep them in-repo so agents and humans share the same workflows, scripts, and standards.
92
92
93
-
Install baseline templates + skills:
93
+
Where to put skills depends on your agent:
94
+
95
+
-**Codex (OpenAI)**: `.codex/skills/`
96
+
-**Claude Code (Anthropic)**: `.claude/skills/`
97
+
-**Gemini Code Assist (Google)**: no documented Agent Skills folders (`SKILL.md`) like Codex/Claude; use `AGENTS.md` + docs, and control context with `.aiexclude`/`.gitignore` (Gemini CLI: `.geminiignore`)
98
+
99
+
Baseline skills in this MCAF repo live under `skills/` (templates). The installer copies them into your chosen skills directory.
100
+
101
+
Install baseline templates + skills (defaults to Codex: `.codex/skills/`):
2. Add baseline MCAF skills (copy `skills/` from the MCAF repo and then adapt to your repo):
121
+
1. Create the agent skills directory at repo root:
122
+
- Codex: `.codex/skills/`
123
+
- Claude Code: `.claude/skills/`
124
+
2. Add baseline MCAF skills (copy from the MCAF repo and then adapt to your repo):
109
125
- `mcaf-architecture-overview`
110
126
- `mcaf-feature-spec`
111
127
- `mcaf-adr-writing`
@@ -119,9 +135,9 @@ Add skills structure to this project:
119
135
4. Generate an “available skills” block for your agent runtime:
120
136
- include only metadata (name, description, location)
121
137
- prefer a simple XML `<available_skills>` block (easy to copy/paste and parse)
122
-
- generate from your repo (recommended): `python3 skills/mcaf-skill-curation/scripts/generate_available_skills.py skills --absolute`
138
+
- generate from your repo (example for Codex): `python3 .codex/skills/mcaf-skill-curation/scripts/generate_available_skills.py .codex/skills --absolute`
Copy file name to clipboardExpand all lines: skills/mcaf-adr-writing/SKILL.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
name: mcaf-adr-writing
3
-
description: Create or update an ADR under `docs/ADR/` using `docs/templates/ADR-Template.md`, capturing context, decision, alternatives, consequences, rollout, and verification. Use when changing architecture, boundaries, dependencies, data model, or cross-cutting patterns; ensure the ADR is self-contained, has a Mermaid diagram, and defines testable invariants.
description: "Create or update an ADR under `docs/ADR/` using `docs/templates/ADR-Template.md`, capturing context, decision, alternatives, consequences, rollout, and verification. Use when changing architecture, boundaries, dependencies, data model, or cross-cutting patterns; ensure the ADR is self-contained, has a Mermaid diagram, and defines testable invariants."
Copy file name to clipboardExpand all lines: skills/mcaf-architecture-overview/SKILL.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
name: mcaf-architecture-overview
3
-
description: Create or update `docs/Architecture/Overview.md` for a repository: map modules and boundaries, add a Mermaid module diagram, document dependency rules, and link to ADRs/features. Use when onboarding, refactoring, adding modules, or when the repo lacks a clear global architecture map.
description: "Create or update `docs/Architecture/Overview.md` for a repository: map modules and boundaries, add a Mermaid module diagram, document dependency rules, and link to ADRs/features. Use when onboarding, refactoring, adding modules, or when the repo lacks a clear global architecture map."
Copy file name to clipboardExpand all lines: skills/mcaf-feature-spec/SKILL.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
name: mcaf-feature-spec
3
-
description: Create or update a feature document under `docs/Features/` using `docs/templates/Feature-Template.md`, including business rules, user flows, system behaviour, Mermaid diagram, verification plan, and Definition of Done. Use before implementing a non-trivial feature or when behaviour changes; make the spec executable (test flows + traceability to tests).
4
-
compatibility: Requires repository write access; produces Markdown docs with Mermaid diagrams and executable verification steps.
3
+
description: "Create or update a feature document under `docs/Features/` using `docs/templates/Feature-Template.md`, including business rules, user flows, system behaviour, Mermaid diagram, verification plan, and Definition of Done. Use before implementing a non-trivial feature or when behaviour changes; make the spec executable (test flows + traceability to tests)."
4
+
compatibility: "Requires repository write access; produces Markdown docs with Mermaid diagrams and executable verification steps."
5
5
---
6
6
7
7
# MCAF: Feature Spec
@@ -26,8 +26,8 @@ Write a spec that can be implemented and verified **without guessing**:
26
26
27
27
1. Start from `docs/Architecture/Overview.md` to pick the affected module(s).
28
28
2. Create/update the feature doc using `docs/templates/Feature-Template.md`.
29
-
- Remove every `TEMPLATE ONLY` note and replace placeholder text before treating it as a real spec.
30
29
- follow `AGENTS.md` scoping rules (do not scan the whole repo; use the architecture map to stay focused)
30
+
- keep the feature’s `## Implementation plan (step-by-step)` updated while executing
Copy file name to clipboardExpand all lines: skills/mcaf-formatting/SKILL.md
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
name: mcaf-formatting
3
-
description: Format code and keep style consistent using the repository’s canonical formatting/lint commands from AGENTS.md. Use after implementing changes or when formatting drift causes noisy diffs; keep formatting changes intentional and verified with build/tests.
4
-
compatibility: Requires the repository’s formatter/linter tools; uses commands from AGENTS.md.
3
+
description: "Format code and keep style consistent using the repository’s canonical formatting/lint commands from AGENTS.md. Use after implementing changes or when formatting drift causes noisy diffs; keep formatting changes intentional and verified with build/tests."
4
+
compatibility: "Requires the repository’s formatter/linter tools; uses commands from AGENTS.md."
Copy file name to clipboardExpand all lines: skills/mcaf-memory/SKILL.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
---
2
2
name: mcaf-memory
3
-
description: Maintain a persistent project memory file (`skills/mcaf-memory/references/memory.md`) with stable facts, constraints, preferences, and glossary so agents don’t re-learn the same context every chat. Use when the user says “remember”, gives repeating feedback, or when important project constraints are discovered.
4
-
compatibility: Requires repository write access; stores memory in Markdown.
3
+
description: "Maintain a persistent project memory file (`references/memory.md` in this skill folder) with stable facts, constraints, preferences, and glossary so agents don’t re-learn the same context every chat. Use when the user says “remember”, gives repeating feedback, or when important project constraints are discovered."
4
+
compatibility: "Requires repository write access; stores memory in Markdown."
0 commit comments