Skip to content

docs: add VS Code Copilot MCP config#622

Open
VIVAAN-DHAWAN wants to merge 1 commit into
rohitg00:mainfrom
VIVAAN-DHAWAN:codex/docs-vscode-copilot-mcp-589
Open

docs: add VS Code Copilot MCP config#622
VIVAAN-DHAWAN wants to merge 1 commit into
rohitg00:mainfrom
VIVAAN-DHAWAN:codex/docs-vscode-copilot-mcp-589

Conversation

@VIVAAN-DHAWAN
Copy link
Copy Markdown

@VIVAAN-DHAWAN VIVAAN-DHAWAN commented May 24, 2026

Summary

  • Add GitHub Copilot / VS Code to the MCP client table.
  • Document VS Code MCP config using the servers shape instead of mcpServers.
  • Note that the agentmemory server should be running first for persistent proxy mode.

Closes #589

Verification

  • rg -n "GitHub Copilot|\"servers\"|\.vscode/mcp.json" README.md
  • git diff --check

Summary by CodeRabbit

  • Documentation
    • Added a GitHub Copilot / VS Code integration entry explaining the different configuration shape, with a concrete configuration example and guidance for using the MCP shim.
    • Clarified startup and proxy behavior: which service to start first when proxying to a persistent server, and when to include or omit environment credentials.

Review Change Stack

@vercel
Copy link
Copy Markdown

vercel Bot commented May 24, 2026

@VIVAAN-DHAWAN is attempting to deploy a commit to the rohitg00's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 24, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f8a15500-deae-4c10-9286-4646b9150415

📥 Commits

Reviewing files that changed from the base of the PR and between c3eff54 and d2acca2.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

Updates README to document GitHub Copilot / VS Code MCP configuration: adds a table row noting VS Code uses the servers JSON shape, provides a servers-based example for @agentmemory/mcp (stdio) with optional env, and clarifies starting the persistent agentmemory server first for proxying.

Changes

Copilot / VS Code MCP Setup Documentation

Layer / File(s) Summary
Copilot / VS Code MCP configuration documentation
README.md
Adds GitHub Copilot / VS Code to the MCP compatibility table, documents that VS Code uses the servers JSON shape (not mcpServers), provides a servers-based example for @agentmemory/mcp using type: "stdio" and optional env, and notes to start the persistent agentmemory server first when proxying.

🎯 1 (Trivial) | ⏱️ ~3 minutes


  • rohitg00/agentmemory#386: Related README change documenting when to include AGENTMEMORY_URL/AGENTMEMORY_SECRET env overrides for MCP plugin configs.

"I'm a rabbit in the docs, nibbling text with care,
Copilot and VS Code now find their server there.
A servers snippet neat, env kept for guarded door,
Start agentmemory first — the proxy purrs once more." 🐇✨

🚥 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 and accurately describes the main change: adding VS Code Copilot MCP configuration documentation to the README.
Linked Issues check ✅ Passed The PR adds VS Code/Copilot MCP configuration documentation addressing issue #589's request for guidance on using agentmemory with GitHub Copilot, including the servers config shape and startup notes.
Out of Scope Changes check ✅ Passed All changes are documentation-focused and directly address the linked issue #589 requirement to document VS Code Copilot MCP configuration with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
README.md (1)

550-563: ⚡ Quick win

Include optional env keys in the VS Code example for parity and remote/protected setups.

This snippet works locally, but adding AGENTMEMORY_URL/AGENTMEMORY_SECRET avoids confusion and aligns with the rest of the MCP docs.

Suggested doc tweak
 {
   "servers": {
     "agentmemory": {
       "type": "stdio",
       "command": "npx",
-      "args": ["-y", "`@agentmemory/mcp`"]
+      "args": ["-y", "`@agentmemory/mcp`"],
+      "env": {
+        "AGENTMEMORY_URL": "http://localhost:3111",
+        "AGENTMEMORY_SECRET": "${AGENTMEMORY_SECRET}"
+      }
     }
   }
 }
🤖 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 550 - 563, Update the VS Code example JSON for the
"servers.agentmemory" entry to include an optional "env" object with keys
AGENTMEMORY_URL and AGENTMEMORY_SECRET so remote/protected setups are
represented; locate the "servers.agentmemory" block (type, command, args) and
add an "env" property documenting that AGENTMEMORY_URL points to the persistent
server URL and AGENTMEMORY_SECRET holds the secret token, making clear these are
optional and used when proxying to a remote MCP instead of the local fallback.
🤖 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.

Nitpick comments:
In `@README.md`:
- Around line 550-563: Update the VS Code example JSON for the
"servers.agentmemory" entry to include an optional "env" object with keys
AGENTMEMORY_URL and AGENTMEMORY_SECRET so remote/protected setups are
represented; locate the "servers.agentmemory" block (type, command, args) and
add an "env" property documenting that AGENTMEMORY_URL points to the persistent
server URL and AGENTMEMORY_SECRET holds the secret token, making clear these are
optional and used when proxying to a remote MCP instead of the local fallback.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 69d9699e-8f32-48ea-9fb4-a5774433c7fe

📥 Commits

Reviewing files that changed from the base of the PR and between 3551241 and c3eff54.

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

@VIVAAN-DHAWAN VIVAAN-DHAWAN force-pushed the codex/docs-vscode-copilot-mcp-589 branch from c3eff54 to d2acca2 Compare May 24, 2026 05:15
@VIVAAN-DHAWAN
Copy link
Copy Markdown
Author

Addressed the CodeRabbit nitpick in d2acca2 by adding optional AGENTMEMORY_URL / AGENTMEMORY_SECRET env keys to the VS Code example and clarifying when to keep or omit the env block. Re-ran rg checks and git diff --check.

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.

How to use it with github copilot

1 participant