Skip to content

refactor(help): update engram --help output to show the right configuration example for engram mcp addition#89

Open
pablon wants to merge 2 commits intoGentleman-Programming:mainfrom
pablon:main
Open

refactor(help): update engram --help output to show the right configuration example for engram mcp addition#89
pablon wants to merge 2 commits intoGentleman-Programming:mainfrom
pablon:main

Conversation

@pablon
Copy link

@pablon pablon commented Mar 16, 2026

The confusing part is engram --help text output, not the setup flow itself.

engram setup opencode already writes the correct OpenCode configuration format. The proposed fix aligns engram --help text output with the actually supported OpenCode config.

🔗 Linked Issue

Closes #88


🏷️ PR Type

  • type:bug — Bug fix
  • type:feature — New feature
  • type:docs — Documentation only
  • type:refactor — Code refactoring (no behavior change)
  • type:chore — Maintenance, dependencies, tooling
  • type:breaking-change — Breaking change

📝 Summary

engram --help currently shows wrong directions to the user.

This PR makes engram --help show the correct format for the user to configure mcp.engram in opencode.json without errors.

📂 Changes

File Change
cmd/engram/main.go Shows correct directions to configure mcp.engram in engram --help output

🧪 Test Plan

  • Unit tests pass locally: go test ./...
  • E2E tests pass locally: go test -tags e2e ./internal/server/...
  • Manually tested the affected functionality
  1. Without the suggested change opencode mcp list shows:
┌  MCP Servers
Error: Configuration is invalid at ~/.config/opencode/opencode.json
↳ Invalid input mcp.engram

opencode does not open and also shows the above error ❌

  1. With the suggested change opencode mcp list shows:
┌  MCP Servers

●  ✓ engram connected
│      engram mcp --tools=agent
...

opencode opens without errors ✅


🤖 Automated Checks

These run automatically and all must pass before merge:

Check What it verifies Status
Check Issue Reference PR body contains Closes #N / Fixes #N / Resolves #N
Check Issue Has status:approved Linked issue has status:approved label
Check PR Has type:* Label PR has exactly one type:* label
Unit Tests go test ./... passes
E2E Tests go test -tags e2e ./internal/server/... passes

✅ Contributor Checklist

  • I linked an approved issue above (Closes #N)
  • I added exactly one type:* label to this PR
  • I ran unit tests locally: go test ./...
  • I ran e2e tests locally: go test -tags e2e ./internal/server/...
  • Docs updated (if behavior changed)
  • Commits follow conventional commits format
  • No Co-Authored-By trailers in commits

💬 Notes for Reviewers

- 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>
Copy link
Collaborator

@Alan-TheGentleman Alan-TheGentleman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@pablon pablon changed the title fix(mcp): update MCP configuration example to use array command format refactor(help): update engram --help output to show the right configuration example for engram mcp addition Mar 22, 2026
@pablon
Copy link
Author

pablon commented Mar 22, 2026

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.

Reviewed and re-edited 👍🏻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

refactor(help): update engram --help output to show the right configuration example for engram mcp addition

2 participants