docs: update codex integration for local stdio MCP server

- MCP server is now a local stdio process, not remote HTTP
- Remove whoAmI tool (not in local server)
- Update install/uninstall descriptions
- Clarify no separate auth needed
This commit is contained in:
Vorflux AI 2026-04-25 02:48:56 +00:00 committed by Sreeram Sreedhar
parent b43f8b0b19
commit 0db2fe26a4

View file

@ -46,10 +46,10 @@ npx codex-supermemory@latest install
```
This command:
- Copies hook scripts to `~/.codex/supermemory/`
- Copies hook scripts and the MCP server to `~/.codex/supermemory/`
- Enables `codex_hooks = true` in `~/.codex/config.toml`
- Registers `UserPromptSubmit` (recall) and `Stop` (capture) hooks in `~/.codex/hooks.json`
- Registers the `supermemory` MCP server in `~/.codex/config.toml` for explicit memory tools
- Registers the `supermemory` MCP server in `~/.codex/config.toml`
Restart Codex CLI after installing.
@ -72,35 +72,28 @@ Memories are tagged with two container tags per session:
## Explicit Memory Tools (MCP)
The installer also registers Supermemory's MCP server, giving Codex four on-demand tools:
The installer registers a local stdio MCP server that runs alongside Codex — no separate login needed. It uses the same `SUPERMEMORY_CODEX_API_KEY` as the hooks.
Three tools are available directly in your Codex session:
| Tool | Description |
|------|-------------|
| `memory` | Save a new memory or forget an existing one |
| `recall` | Search your memories by natural-language query |
| `listProjects` | List all memory containers (projects) |
| `whoAmI` | Show the current user profile |
These tools let you interact with memory explicitly — for example:
| `memory` | Save a new memory (`mode: "add"`) or forget one by ID (`mode: "forget"`) |
| `recall` | Search memories by natural-language query |
| `listProjects` | List recent memories in the current project or user scope |
Examples:
```
> Remember that this project uses Vitest for unit tests and Playwright for E2E.
> What do you remember about our database schema?
> Forget the memory about the old API endpoint.
```
You can verify the MCP server is registered:
Verify the MCP server is registered:
```bash
codex mcp list
```
Expected output:
```
supermemory https://mcp.supermemory.ai/mcp - enabled
```
## Verify Installation
```bash
@ -116,7 +109,7 @@ codex-supermemory status:
Hook scripts: ✓ installed at ~/.codex/supermemory
hooks.json: ✓ registered
config.toml: ✓ codex_hooks enabled
MCP server: ✓ registered (explicit memory tools)
MCP server: ✓ registered
All good! Memory is active.
```
@ -127,7 +120,7 @@ All good! Memory is active.
npx codex-supermemory uninstall
```
This removes the hook registrations from `~/.codex/hooks.json`, disables `codex_hooks`, and removes the MCP server from `~/.codex/config.toml`. Your existing memories in Supermemory are preserved.
This removes the hook scripts and MCP server from `~/.codex/supermemory/`, the hook registrations from `~/.codex/hooks.json`, and disables `codex_hooks` and the MCP server entry in `~/.codex/config.toml`. Your existing memories in Supermemory are preserved.
## Configuration
@ -155,6 +148,7 @@ Create `~/.codex/supermemory.json` to override defaults:
| `containerTagPrefix` | `"codex"` | Prefix for container tags |
| `debug` | `false` | Write debug logs to `~/.codex-supermemory.log` |
## Logging
Enable debug logging to trace hook activity: