refactor(help): update engram --help output to show the right configuration example for engram mcp addition#89
refactor(help): update engram --help output to show the right configuration example for engram mcp addition#89pablon wants to merge 2 commits intoGentleman-Programming:mainfrom
engram --help output to show the right configuration example for engram mcp addition#89Conversation
- Replace separate command/args fields with combined command array - Add enabled field to match current MCP schema Fixes Gentleman-Programming#88 Signed-off-by: pablon <73798198+pablon@users.noreply.github.com>
Alan-TheGentleman
left a comment
There was a problem hiding this comment.
Thanks for jumping on a real problem. I am requesting changes because the current fix is not solid enough to merge as-is: the proposed example mixes format assumptions, introduces an extra field that should not be documented casually, and does not fully resolve the OpenCode-facing confusion. Rework this from the actual supported config examples and then we can review it again.
engram --help output to show the right configuration example for engram mcp addition
Reviewed and re-edited 👍🏻 |
The confusing part is
engram --helptext output, not the setup flow itself.engram setup opencode already writes the correct OpenCode configuration format. The proposed fix aligns
engram --helptext output with the actually supported OpenCode config.🔗 Linked Issue
Closes #88
🏷️ PR Type
type:bug— Bug fixtype:feature— New featuretype:docs— Documentation onlytype:refactor— Code refactoring (no behavior change)type:chore— Maintenance, dependencies, toolingtype:breaking-change— Breaking change📝 Summary
engram --helpcurrently shows wrong directions to the user.This PR makes
engram --helpshow the correct format for the user to configuremcp.engraminopencode.jsonwithout errors.📂 Changes
cmd/engram/main.gomcp.engraminengram --helpoutput🧪 Test Plan
go test ./...go test -tags e2e ./internal/server/...opencode mcp listshows:opencodedoes not open and also shows the above error ❌opencode mcp listshows:opencodeopens without errors ✅🤖 Automated Checks
These run automatically and all must pass before merge:
Closes #N/Fixes #N/Resolves #Nstatus:approvedlabeltype:*labelgo test ./...passesgo test -tags e2e ./internal/server/...passes✅ Contributor Checklist
Closes #N)type:*label to this PRgo test ./...go test -tags e2e ./internal/server/...Co-Authored-Bytrailers in commits💬 Notes for Reviewers