From 385fc1825c4529a3a5bae06eecd938cc95c09f4e Mon Sep 17 00:00:00 2001 From: Ivan Dergachev Date: Sun, 10 May 2026 17:06:36 +0400 Subject: [PATCH] docs: make Codex MCP setup discoverable --- mempalace/cli.py | 2 ++ mempalace/instructions/init.md | 6 +++++- tests/test_cli.py | 3 +++ website/guide/getting-started.md | 4 ++-- website/guide/mcp-integration.md | 3 +++ 5 files changed, 15 insertions(+), 3 deletions(-) diff --git a/mempalace/cli.py b/mempalace/cli.py index 395130d..86a3147 100644 --- a/mempalace/cli.py +++ b/mempalace/cli.py @@ -977,12 +977,14 @@ def cmd_mcp(args): print("MemPalace MCP quick setup:") print(f" claude mcp add mempalace -- {server_cmd}") + print(f" codex mcp add mempalace -- {server_cmd}") print("\nRun the server directly:") print(f" {server_cmd}") if not args.palace: print("\nOptional custom palace:") print(f" claude mcp add mempalace -- {base_server_cmd} --palace /path/to/palace") + print(f" codex mcp add mempalace -- {base_server_cmd} --palace /path/to/palace") print(f" {base_server_cmd} --palace /path/to/palace") diff --git a/mempalace/instructions/init.md b/mempalace/instructions/init.md index 347367a..c2fdf0b 100644 --- a/mempalace/instructions/init.md +++ b/mempalace/instructions/init.md @@ -59,10 +59,14 @@ If this fails, report the error and stop. ## Step 6: Configure MCP server -Run the following command to register the MemPalace MCP server with Claude: +Run the command for the AI client the user is configuring: + # Claude Code claude mcp add mempalace -- mempalace-mcp + # Codex CLI + codex mcp add mempalace -- mempalace-mcp + If this fails, report the error but continue to the next step (MCP configuration can be done manually later). diff --git a/tests/test_cli.py b/tests/test_cli.py index 547286d..22db2ef 100644 --- a/tests/test_cli.py +++ b/tests/test_cli.py @@ -701,6 +701,7 @@ def test_mcp_command_prints_setup_guidance(monkeypatch, capsys): captured = capsys.readouterr() assert "MemPalace MCP quick setup:" in captured.out assert "claude mcp add mempalace -- mempalace-mcp" in captured.out + assert "codex mcp add mempalace -- mempalace-mcp" in captured.out assert "\nOptional custom palace:\n" in captured.out assert "mempalace-mcp --palace /path/to/palace" in captured.out assert "[--palace /path/to/palace]" not in captured.out @@ -717,6 +718,8 @@ def test_mcp_command_uses_custom_palace_path_when_provided(monkeypatch, capsys): assert "mempalace-mcp --palace" in captured.out assert expanded in captured.out + assert "claude mcp add mempalace -- mempalace-mcp --palace" in captured.out + assert "codex mcp add mempalace -- mempalace-mcp --palace" in captured.out assert "Optional custom palace:" not in captured.out assert "[--palace /path/to/palace]" not in captured.out assert captured.err == "" diff --git a/website/guide/getting-started.md b/website/guide/getting-started.md index 8a3dff9..b9cddd3 100644 --- a/website/guide/getting-started.md +++ b/website/guide/getting-started.md @@ -80,7 +80,7 @@ That gives you a working local memory index. ## What Happens Next -After the one-time setup, you don't run MemPalace commands manually. Your AI uses it for you through [MCP integration](/guide/mcp-integration) or a [Claude Code plugin](/guide/claude-code). +After the one-time setup, you don't run MemPalace commands manually. Your AI uses it for you through [MCP integration](/guide/mcp-integration), the bundled Codex plugin, or a [Claude Code plugin](/guide/claude-code). Ask your AI anything: @@ -91,5 +91,5 @@ It calls `mempalace_search` automatically, gets verbatim results, and answers yo ## Next Steps - [Mining Your Data](/guide/mining) — deep dive into mining modes -- [MCP Integration](/guide/mcp-integration) — connect to Claude, ChatGPT, Cursor, Gemini +- [MCP Integration](/guide/mcp-integration) — connect to Claude, Codex, ChatGPT, Cursor, Gemini - [The Palace](/concepts/the-palace) — understand wings, rooms, halls, and tunnels diff --git a/website/guide/mcp-integration.md b/website/guide/mcp-integration.md index 528fe83..182bfae 100644 --- a/website/guide/mcp-integration.md +++ b/website/guide/mcp-integration.md @@ -16,12 +16,14 @@ mempalace mcp ```bash claude mcp add mempalace -- python -m mempalace.mcp_server +codex mcp add mempalace -- python -m mempalace.mcp_server ``` ### With Custom Palace Path ```bash claude mcp add mempalace -- python -m mempalace.mcp_server --palace /path/to/palace +codex mcp add mempalace -- python -m mempalace.mcp_server --palace /path/to/palace ``` Now your AI has all 29 tools available. Ask it anything: @@ -35,6 +37,7 @@ Claude calls `mempalace_search` automatically, gets verbatim results, and answer MemPalace works with any tool that supports MCP: - **Claude Code** — native via plugin or manual MCP +- **Codex CLI** — native via bundled Codex plugin or manual MCP - **OpenClaw** — via official skill, see [OpenClaw Skill](/guide/openclaw) - **ChatGPT** — via MCP bridge - **Cursor** — native MCP support