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
docs: Update CLAUDE.md for supplementary modules and Module 11
Update module range references from 1-9 to 1-11. Add documentation of
the supplementary modules pattern (MaaS, MCP Gateway, MemoryHub) with
their RHOAI version requirements and how they differ from core modules.
Assisted-by: Claude Code (Opus 4.6)
Copy file name to clipboardExpand all lines: CLAUDE.md
+14-4Lines changed: 14 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,9 +9,9 @@ A **tutorial repository** that teaches building, deploying, and extending AI age
9
9
Four top-level concerns coexist here:
10
10
11
11
1.**MkDocs tutorial site** (`docs/`, `mkdocs.yml`) — published to https://fips-agents.github.io/examples/ via `.github/workflows/pages.yml` on every push to `main`.
12
-
2.**`calculus-agent/`** — finished BaseAgent-based agent (the "Module 1–9" worked example). Has its own `CLAUDE.md` with BaseAgent-specific guidance.
12
+
2.**`calculus-agent/`** — finished BaseAgent-based agent (the "Module 1–11" worked example). Has its own `CLAUDE.md` with BaseAgent-specific guidance.
13
13
3.**`calculus-helper/`** — finished FastMCP v3 server providing 8 SymPy-powered calculus tools. Has its own `CLAUDE.md` with FastMCP-specific guidance.
14
-
4.**`calculus-coordinator/`** — demo of the **subagent-as-tool** feature shipped in fipsagents 0.22.0 (agent-template PR #173). A tutor-role coordinator that delegates calculus computation to a registered peer agent (`calculus_specialist`, which in production points at the deployed `calculus-agent` route). Pins `fipsagents>=0.22.0`, so it is *ahead* of the tutorial's currently pinned version — it is a forward-looking demo, not part of the Module 1–9 sequence.
14
+
4.**`calculus-coordinator/`** — demo of the **subagent-as-tool** feature shipped in fipsagents 0.22.0 (agent-template PR #173). A tutor-role coordinator that delegates calculus computation to a registered peer agent (`calculus_specialist`, which in production points at the deployed `calculus-agent` route). Pins `fipsagents>=0.22.0`, so it is *ahead* of the tutorial's currently pinned version — it is a forward-looking demo, not part of the Module 1–11 sequence.
15
15
16
16
When working inside `calculus-agent/`, `calculus-helper/`, or `calculus-coordinator/`, that sub-project's `CLAUDE.md` is authoritative — it covers the agent or MCP server's structure, decorators, deployment, and common mistakes. This top-level file is only for cross-cutting tutorial-repo work.
17
17
@@ -29,12 +29,22 @@ The `--strict` flag is what GitHub Actions uses, so always reproduce CI behavior
29
29
30
30
## Tutorial structure
31
31
32
-
`mkdocs.yml` defines the canonical module ordering. The tutorial is sequential: each module assumes the previous one is complete. When editing:
32
+
`mkdocs.yml` defines the canonical module ordering. The tutorial has two tiers:
33
33
34
-
- Modules 1–9 live in `docs/0N-*.md` and are referenced by number in cross-links.
34
+
**Core modules (0–11)** are sequential — each assumes the previous one is complete:
35
+
36
+
- Modules 0–9 live in `docs/0N-*.md`, Modules 10–11 in `docs/1N-*.md`.
35
37
- Reference pages live in `docs/reference/` and are linked from multiple modules.
36
38
- The tutorial pins a specific fipsagents version (currently v0.11.0 — see `docs/index.md`). Bumping that version requires a coordinated re-test of every module.
37
39
40
+
**Supplementary modules** (`docs/supplementary/`) are standalone add-ons that extend the tutorial with optional platform features. They are independent of each other and can be completed in any order after their listed prerequisites:
41
+
42
+
-**Agent Memory with MemoryHub** — cross-session memory via semantic search (RHOAI 3.x)
43
+
-**Models as a Service** — subscription-based model governance, API key auth, token quotas (RHOAI 3.4+). Delegates platform setup to the [official Red Hat guide](https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/3.4/html/govern_llm_access_with_models-as-a-service/deploy-and-manage-models-as-a-service_maas), then teaches CRD anatomy and hands-on governance.
44
+
-**MCP Gateway** — centralized MCP server access with auth and rate limiting via Kuadrant (RHOAI 3.4+, Tech Preview)
45
+
46
+
Supplementary modules require RHOAI 3.4 unless noted otherwise. They follow a different pattern than core modules: they include their own infrastructure setup rather than relying on Setup Guides.
47
+
38
48
When fixing issues found by tutorial walk-throughs, file them at `fips-agents/examples` on GitHub and link the issue from the commit.
0 commit comments