Skip to content

docs: show an optional local memory server in the config example - #710

Open
samvallad33 wants to merge 1 commit into
lastmile-ai:mainfrom
samvallad33:feature/vestige-memory-example
Open

docs: show an optional local memory server in the config example#710
samvallad33 wants to merge 1 commit into
lastmile-ai:mainfrom
samvallad33:feature/vestige-memory-example

Conversation

@samvallad33

@samvallad33 samvallad33 commented Jun 27, 2026

Copy link
Copy Markdown

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

  • Documentation
    • Updated the configuration example to include an optional local memory server setup.
    • Refreshed the sample default AI model value in the example config.

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.
@coderabbitai

coderabbitai Bot commented Jun 27, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The README’s mcp_agent.config.yaml example now includes an optional memory block for vestige-mcp and shows gpt-4o-mini as the default OpenAI model.

Changes

README configuration example

Layer / File(s) Summary
Config example update
README.md
The example configuration adds a memory block for vestige-mcp and changes openai.default_model to gpt-4o-mini.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • saqadri

Poem

A tiny memory hop, hop, hop,
With vestige-mcp to keep the logs.
gpt-4o-mini shines in the guide,
A cozy config for the rabbit’s ride.
🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the documentation update adding an optional local memory server to the config example.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5d46eee0-00f0-466b-bec2-40c7643e86e6

📥 Commits

Reviewing files that changed from the base of the PR and between f62d849 and f297726.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
Comment on lines +438 to +441
# 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"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 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.

Suggested change
# 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.

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.

1 participant