docs: show an optional local memory server in the config example - #710
docs: show an optional local memory server in the config example#710samvallad33 wants to merge 1 commit into
Conversation
Adds a commented 'memory' MCP server to the mcp_agent.config.yaml example so readers see how to give an agent memory that persists across runs. Uses Vestige, a local-first MCP memory server, as the example.
📝 WalkthroughWalkthroughThe README’s ChangesREADME configuration example
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 438-441: The Vestige setup example has a package-name vs.
binary-name mismatch between the install note and the `memory.command` value.
Update the README section so the install instruction and the executable name
match, or explicitly clarify the package-to-command mapping. Use the `memory`
example and the `vestige-mcp` command reference in this block to make the
guidance consistent and avoid a “command not found” issue.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| # Optional: a local memory server so the agent can remember across runs. | ||
| # Vestige is a local-first MCP memory server (npm install -g vestige-mcp-server). | ||
| memory: | ||
| command: "vestige-mcp" |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Fix the Vestige package name vs. command name mismatch.
The comment instructs users to npm install -g vestige-mcp-server, but the command below is vestige-mcp. If the package and binary names differ, clarify; if they don't, correct one to match the other so users don't get a "command not found" error after following the install step.
📝 Suggested fix
# Optional: a local memory server so the agent can remember across runs.
- # Vestige is a local-first MCP memory server (npm install -g vestige-mcp-server).
+ # Vestige is a local-first MCP memory server (npm install -g vestige-mcp).
memory:
command: "vestige-mcp"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Optional: a local memory server so the agent can remember across runs. | |
| # Vestige is a local-first MCP memory server (npm install -g vestige-mcp-server). | |
| memory: | |
| command: "vestige-mcp" | |
| # Optional: a local memory server so the agent can remember across runs. | |
| # Vestige is a local-first MCP memory server (npm install -g vestige-mcp). | |
| memory: | |
| command: "vestige-mcp" |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 438 - 441, The Vestige setup example has a
package-name vs. binary-name mismatch between the install note and the
`memory.command` value. Update the README section so the install instruction and
the executable name match, or explicitly clarify the package-to-command mapping.
Use the `memory` example and the `vestige-mcp` command reference in this block
to make the guidance consistent and avoid a “command not found” issue.
Small docs addition. The config example shows fetch and filesystem servers, so I added a commented optional memory server alongside them. This gives readers a concrete way to let an agent remember things across runs, which is a common first question.
I used Vestige for the example since it is a local-first MCP memory server that runs with a single command, but the point is the pattern. Happy to swap it for whatever you prefer, or drop it if you would rather keep the example minimal.
It is just a commented YAML block, no code changes. For full transparency I am the author of Vestige, so feel free to push back if this feels like the wrong fit.
Summary by CodeRabbit