Skip to content

docs(readme): Improve MCP configuration guide and streamline setup with uvx#109

Closed
nzkdevsaider wants to merge 3 commits intoMemPalace:developfrom
nzkdevsaider:patch-1
Closed

docs(readme): Improve MCP configuration guide and streamline setup with uvx#109
nzkdevsaider wants to merge 3 commits intoMemPalace:developfrom
nzkdevsaider:patch-1

Conversation

@nzkdevsaider
Copy link
Copy Markdown

@nzkdevsaider nzkdevsaider commented Apr 7, 2026

Updated README to reflect new AI tools and configuration details for MCP compatibility.

What does this PR do?

Updates the "How You Actually Use It" section in the README.md to provide explicit MCP configuration guides for a broader set of AI clients. Specifically, it adds detailed JSON snippets and instructions for:

  • Cursor, Claude Desktop, Windsurf, and Google Antigravity (using the standard "mcpServers" key).
  • GitHub Copilot CLI (interactive setup).

It also standardizes the examples to use uvx to execute the MCP server directly from the repository without requiring users to clone it manually.

How to test

  1. Preview the README.md file locally or on GitHub to ensure the markdown renders correctly, particularly the nested JSON blocks and bullet points.
  2. Verify the paths and JSON structures provided for each client (e.g., ensuring Copilot uses the servers object while the others use mcpServers).
  3. (Optional) Copy/paste the configuration into one of the mentioned clients (like Cursor or VS Code) to confirm the MCP server initializes correctly.

Checklist

  • Tests pass (python -m pytest tests/ -v)
  • No hardcoded paths
  • Linter passes (ruff check .)

@nzkdevsaider nzkdevsaider changed the title Improve MCP Server installation and configuration guide with uvx Improve MCP configuration guide and streamline setup with uvx Apr 7, 2026
@nzkdevsaider nzkdevsaider changed the title Improve MCP configuration guide and streamline setup with uvx docs(readme): Improve MCP configuration guide and streamline setup with uvx Apr 7, 2026
Comment thread README.md Outdated
@bensig
Copy link
Copy Markdown
Collaborator

bensig commented Apr 7, 2026

Good addition for Cursor/Windsurf users. README has changed a lot though — can you rebase on main?

Updated README to reflect new AI tools and configuration details for MCP compatibility.
… server setup and enhance configuration instructions for various clients.
…on instructions while maintaining clarity on prerequisites for MCP server
@nzkdevsaider
Copy link
Copy Markdown
Author

Good addition for Cursor/Windsurf users. README has changed a lot though — can you rebase on main?

thank you, done!

Copy link
Copy Markdown

@armujahid armujahid left a comment

Choose a reason for hiding this comment

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

LGTM. Optionally, you can also add an alternative installation command via uv.

Using pip

pip install mempalace

Using uv

uv tool install mempalace

Copy link
Copy Markdown

@web3guru888 web3guru888 left a comment

Choose a reason for hiding this comment

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

📝 Review of #109docs(readme): Improve MCP configuration guide and streamline setup with uvx

Scope: +85/−7 · 1 file(s) · docs-only

  • README.md (modified: +85/−7)

🟢 Approved — clean, well-structured PR. Good work @nzkdevsaider!


🏛️ Reviewed by MemPalace-AGI · Autonomous research system with perfect memory · Showcase: Truth Palace of Atlantis

@bensig bensig changed the base branch from main to develop April 11, 2026 22:23
@igorls igorls added the documentation Improvements or additions to documentation label Apr 14, 2026
@igorls
Copy link
Copy Markdown
Member

igorls commented Apr 21, 2026

Thanks for putting this together — per-client MCP config is a real gap for Cursor / Windsurf / Claude Desktop / Copilot users, and the JSON snippets here are most of what's needed.

Two things have changed since you opened this that make merging against README.md the wrong path:

  1. The README was rewritten to delegate MCP setup entirely to the docs site. Lines 67-68 now point at mempalaceofficial.com/guide/getting-started and lines 133-138 defer tool listings to the docs. The ### With Claude, ChatGPT, Cursor, Gemini (MCP-compatible tools) section this PR edits is gone from develop. Per-client config blocks in README.md would re-introduce content I explicitly moved out.

  2. The MCP invocation changed in fix: add mempalace-mcp entry point for pipx/uv compatibility #340. The canonical command is no longer python -m mempalace.mcp_server — it's the mempalace-mcp entry point registered in pyproject.toml. Every uvx --from mempalace python -m mempalace.mcp_server in this PR would need to become uvx mempalace-mcp (or mempalace-mcp for users who've already pipx installed).

Closing this one, but I'd love to merge the same content in the right place. The natural home is website/guide/mcp-integration.md — it currently has two Claude Code lines and nothing for Cursor, Windsurf, Copilot, or Claude Desktop. If you'd open a fresh PR against that file with:

  • The per-client blocks from this PR
  • Commands updated to uvx mempalace-mcp / mempalace-mcp
  • The truncated "Prerequisite: uvx" sentence finished (link to https://docs.astral.sh/uv/getting-started/installation/ and a one-line install hint)
  • The "19 tools" wording dropped (the count moves over time; point at the docs tool list instead)

…I'll merge it promptly. Thanks again for the contribution.

@igorls igorls closed this Apr 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants