Skip to content

Commit f4aaf35

Browse files
authored
docs: add live MCP vs headless harness guidance (#74)
Documents the two execution paths for Blender work: the official Blender Lab MCP server (machine-local, optional, exploration only) versus the headless harness, which remains the only source of truth for witnesses, checks, and CI evidence. Adds a one-line pointer in AGENTS.md canonical references. Signed-off-by: fOuttaMyPaint <TMhospitalitystrategies@gmail.com>
1 parent fdb9ea9 commit f4aaf35

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ way, and a one-paragraph rationale. 30 to 80 lines is the right size.
179179
- Blender 4.5 LTS Python API: https://docs.blender.org/api/4.5/
180180
- Extensions Platform reference: https://docs.blender.org/manual/en/latest/advanced/extensions/index.html
181181
- Release notes (`developer.blender.org`): https://developer.blender.org/
182+
- Live MCP session vs headless harness policy: `CLAUDE.md` § "Live MCP vs Headless Harness" — headless is the only source of truth for evidence.
182183

183184
When information conflicts, prefer the docs over Stack Overflow or older
184185
add-on source. The 2.x to 4.x to 5.x churn around Actions, Extensions, and

‎CLAUDE.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,15 @@ Renders must conform to the gallery look spec at `docs/VISUAL-STYLE.md`.
102102
- If `.scratch/` lacks a needed version, download an official release from download.blender.org into it. `.scratch` is gitignored.
103103
- In scripts, version-branch on the `bpy.app.version` tuple, never on `bpy.app.version_string` — it reads e.g. `"4.5.11 LTS"`, not bare semver.
104104

105+
## Live MCP vs Headless Harness
106+
107+
Two execution paths exist for Blender work. The headless harness (`.scratch/` or system binaries, check-only scripts, CI smoke) is the **only source of truth for correctness** — every witness, check, and CI gate runs headless. The official Blender Lab MCP server ([lab/blender_mcp](https://projects.blender.org/lab/blender_mcp)), when registered on the local machine, provides a live interactive session for exploration.
108+
109+
- **Use the live MCP for:** interactively inspecting a scene while designing a render, querying data relations, diagnosing why staged geometry or lighting looks wrong, and prototyping API calls before committing them to a script.
110+
- **Never use the live MCP for:** anything a check depends on, anything reported as verification evidence, or anything CI must reproduce. A behavior observed in the live session must be re-proven in the headless script before it counts. Examples must never import from, depend on, or assume the MCP server.
111+
- **Safety:** the server executes generated code in the running Blender instance without guards. Only attach it to scratch scenes, never to files you cannot afford to mutate.
112+
- **Availability is machine-local and optional:** if the server is not registered, proceed headless without comment.
113+
105114
## Git Staging
106115

107116
Stage with **explicit paths only** — never `git add -A` or `git add .`. Cursor agent sessions inject a local guidance block into the working-copy `CLAUDE.md`; a bulk add sweeps it into the commit. It manifests as a `CLAUDE.md` hunk in `git diff` that you did not author (the file can be dirty before you touch anything). Leave it unstaged, and never stage `CLAUDE.md` unless you deliberately edited it.

0 commit comments

Comments
 (0)