docs: mcp project override, VS Code/WSL, EXDEV, topic_key guide, Task Scheduler#456
Merged
Conversation
…EXDEV fix (#419, #109) Hosts that don't inherit cwd (VS Code, WSL, CI, Docker) need an explicit --project flag or ENGRAM_PROJECT env var to avoid wrong project detection. Add a worked example with both forms and explain when to use each. Also document the EXDEV cross-device link error that appears on Linux when /tmp and /home are on separate filesystems, with a one-shot TMPDIR workaround and a permanent shell-rc fix.
…158, #421) #158: Rewrite the Topic Key Workflow section in ARCHITECTURE.md into a complete guide covering the upsert semantics, format convention with FTS5 rationale, anti-patterns, decision table, mem_suggest_topic_key workflow, hierarchy limit, lifecycle/pruning, and scope interaction. #421: Add a Windows Task Scheduler template to the Running as a Service section in DOCS.md, parallel to the existing systemd and launchd blocks. Includes PowerShell setup snippet, note on persistent env vars for cloud token, UTF-8 log guidance, and stop/remove instructions.
There was a problem hiding this comment.
Pull request overview
Documentation-only batch addressing four issues: corrects misleading docs about MCP --project/ENGRAM_PROJECT overrides (#394), adds a VS Code/WSL/CI .mcp.json pinning example (#419), documents the Linux EXDEV TMPDIR workaround for Claude Code plugin install (#109), expands the topic_key guide with format, decision table, hierarchy, lifecycle, and scope interaction (#158), and adds a Windows Task Scheduler service template (#421).
Changes:
- Update
DOCS.mdenv-var table, MCP project resolution paragraph, README CLI table, andprintUsageCLI help to reflect thatengram mcpsupports--project/ENGRAM_PROJECT. - Add VS Code/WSL/CI MCP setup guidance and a Linux EXDEV troubleshooting section in
docs/AGENT-SETUP.md; expand the topic_key guide indocs/ARCHITECTURE.md. - Add a Windows Task Scheduler service template to the "Running as a Service" section of
DOCS.md.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates CLI command table to include [--project NAME] for engram mcp. |
| DOCS.md | Rewrites ENGRAM_PROJECT env-var row, corrects MCP project resolution paragraph, and adds Windows Task Scheduler template. |
| docs/AGENT-SETUP.md | Adds Linux EXDEV troubleshooting and VS Code/WSL/CI project-pinning guidance for MCP. |
| docs/ARCHITECTURE.md | Expands topic_key guide: format, anti-patterns, decision table, suggest-first workflow, hierarchy, lifecycle, scope interaction. |
| cmd/engram/main.go | Updates printUsage to document the --project flag and the new ENGRAM_PROJECT semantics for engram mcp. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Both `--project=my-project` and `ENGRAM_PROJECT=my-project` set `MCPConfig.DefaultProject`, which takes precedence over cwd detection for every read and write tool for the lifetime of that MCP process. | ||
|
|
||
| > The `--project` flag and `ENGRAM_PROJECT` env var are the same mechanism. If both are supplied, the flag wins. The value must match an existing project name in your Engram store; unknown names are rejected so typos fail loudly instead of silently creating a new project bucket. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation batch. Closes #394, Closes #109, Closes #158, Closes #419. Refs #421 (adds the Windows Task Scheduler template; the code portion ships in its own PR — do not auto-close #421 until both merge).
Changes
DOCS.mdwrongly statedengram mcpdoes not support--project/ENGRAM_PROJECToverrides. It does (wired in commitb094052). Corrected the body text + env-var table, README CLI table, andprintUsagehelp..mcp.jsonsetup example (flag form + env-var form) todocs/AGENT-SETUP.mdfor hosts that don't inherit cwd.cross-device link not permitted) troubleshooting subsection with theTMPDIRworkaround.docs/ARCHITECTURE.md: upsert semantics, naming convention (+ FTS5 rationale), when-to-use decision table,mem_suggest_topic_keyworkflow, hierarchy limit, lifecycle, scope interaction.DOCS.md("Running as a Service").Test plan
Docs only.
go build ./...clean after theprintUsageedit. Facts in #394/#419 verified againstcmd/engram/main.go(cmdMCPreadsENGRAM_PROJECT/--projectintoMCPConfig.DefaultProject).