Skip to content

Commit 694e53f

Browse files
authored
docs: add CLAUDE.md/AGENTS.md guidance to AI tooling page (#20975)
## Summary - Adds a "Project-level instructions" section to the AI tooling docs page recommending developers create `CLAUDE.md` / `AGENTS.md` files in their Aztec projects - Includes a copy-paste template with the critical `aztec compile` vs `nargo compile` distinction - Explains why LLMs default to `nargo` and how project-level instructions fix this - Applied to both nightly source and devnet.2 versioned docs ## Context AI tools consistently confuse `nargo compile` with `aztec compile` because training data heavily favors standalone Noir tooling. MCP servers and skills help but don't always trigger at the right time. Project-level instruction files (CLAUDE.md, AGENTS.md) are read automatically at conversation start, making them the most reliable fix. ## Test plan - [ ] Verify docs build with `yarn build` in `docs/` - [ ] Review rendered page at `/developers/ai_tooling`
2 parents 4ac0870 + aa5bbab commit 694e53f

2 files changed

Lines changed: 52 additions & 0 deletions

File tree

docs/developer_versioned_docs/version-v4.0.0-devnet.2-patch.1/ai_tooling.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,32 @@ Aztec is new, rapidly evolving, and spans novel concepts like private state, not
1111
LLMs have limited training data for zero-knowledge circuit development. Noir and Aztec.nr are newer languages with smaller codebases than mainstream languages, so AI tools will make more mistakes than you might be used to. The tools on this page help by providing up-to-date context, but you should always verify generated code and test thoroughly.
1212
:::
1313

14+
## Project-level instructions (CLAUDE.md / AGENTS.md files)
15+
16+
MCP servers and skills provide context on demand, but AI tools don't always invoke them at the right time. The most reliable way to prevent common mistakes is to add **project-level instruction files** that your AI tool reads automatically at the start of every conversation. You can add to these files over time as you discover new gotchas or best practices. They ensure your AI tool always has the critical context it needs, without relying on you to remember to invoke the right skills or MCP servers.
17+
18+
For Claude Code, create a `CLAUDE.md` file in your project root. For Codex, create an `AGENTS.md` file in your project root. For other tools, check their documentation for equivalent configuration.
19+
20+
### Recommended CLAUDE.md / AGENTS.md
21+
22+
```markdown
23+
# Aztec Project
24+
25+
## Critical: Use `aztec` CLI, not `nargo` directly
26+
27+
This is an Aztec smart contract project. Always use the `aztec` CLI wrapper instead of calling `nargo` directly:
28+
29+
- **Compile**: `aztec compile` (NOT `nargo compile`). Using `nargo compile` alone produces incomplete artifacts.
30+
- **Test**: `aztec test` (NOT `nargo test`).
31+
- **Other nargo commands** like `nargo fmt` and `nargo doc` are fine to use directly.
32+
```
33+
34+
This prevents the most common AI mistake: using `nargo compile` and `nargo test` instead of their Aztec wrappers.
35+
36+
### Why this matters
37+
38+
LLMs have extensive training data for `nargo` (the standalone Noir compiler) but limited exposure to the `aztec` CLI wrapper. Without explicit instructions, they default to `nargo compile`, which produces artifacts missing the AVM transpilation step.
39+
1440
## MCP servers
1541

1642
The highest-leverage tools are the Aztec and Noir MCP servers. They clone reference repositories locally and give your AI tool code search, documentation search, and example discovery across the Aztec and Noir ecosystems. They work with any AI coding tool that supports MCP (Claude Code, Cursor, Windsurf, Codex, and others).

docs/docs-developers/ai_tooling.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,32 @@ Aztec is new, rapidly evolving, and spans novel concepts like private state, not
1111
LLMs have limited training data for zero-knowledge circuit development. Noir and Aztec.nr are newer languages with smaller codebases than mainstream languages, so AI tools will make more mistakes than you might be used to. The tools on this page help by providing up-to-date context, but you should always verify generated code and test thoroughly.
1212
:::
1313

14+
## Project-level instructions (CLAUDE.md / AGENTS.md files)
15+
16+
MCP servers and skills provide context on demand, but AI tools don't always invoke them at the right time. The most reliable way to prevent common mistakes is to add **project-level instruction files** that your AI tool reads automatically at the start of every conversation. You can add to these files over time as you discover new gotchas or best practices. They ensure your AI tool always has the critical context it needs, without relying on you to remember to invoke the right skills or MCP servers.
17+
18+
For Claude Code, create a `CLAUDE.md` file in your project root. For Codex, create an `AGENTS.md` file in your project root. For other tools, check their documentation for equivalent configuration.
19+
20+
### Recommended CLAUDE.md / AGENTS.md
21+
22+
```markdown
23+
# Aztec Project
24+
25+
## Critical: Use `aztec` CLI, not `nargo` directly
26+
27+
This is an Aztec smart contract project. Always use the `aztec` CLI wrapper instead of calling `nargo` directly:
28+
29+
- **Compile**: `aztec compile` (NOT `nargo compile`). Using `nargo compile` alone produces incomplete artifacts.
30+
- **Test**: `aztec test` (NOT `nargo test`).
31+
- **Other nargo commands** like `nargo fmt` and `nargo doc` are fine to use directly.
32+
```
33+
34+
This prevents the most common AI mistake: using `nargo compile` and `nargo test` instead of their Aztec wrappers.
35+
36+
### Why this matters
37+
38+
LLMs have extensive training data for `nargo` (the standalone Noir compiler) but limited exposure to the `aztec` CLI wrapper. Without explicit instructions, they default to `nargo compile`, which produces artifacts missing the AVM transpilation step.
39+
1440
## MCP servers
1541

1642
The highest-leverage tools are the Aztec and Noir MCP servers. They clone reference repositories locally and give your AI tool code search, documentation search, and example discovery across the Aztec and Noir ecosystems. They work with any AI coding tool that supports MCP (Claude Code, Cursor, Windsurf, Codex, and others).

0 commit comments

Comments
 (0)