190 lines
8.3 KiB
Plaintext
190 lines
8.3 KiB
Plaintext
---
|
|
title: Codex
|
|
description: "Add persistent memory to OpenAI Codex with automatic capture, automatic recall, a search tool, and six memory skills."
|
|
---
|
|
|
|
Add persistent memory to [**OpenAI Codex**](https://openai.com/index/codex/) with the Mem0 plugin. Codex forgets everything between tasks. This plugin fixes that by connecting to Mem0's cloud memory layer via MCP, automatically capturing learnings at key lifecycle points, and retrieving relevant context before every response.
|
|
|
|
<Info>Current plugin version: `0.3.1`.</Info>
|
|
|
|
## Prerequisites
|
|
|
|
Before setting up Mem0 with Codex, ensure you have:
|
|
|
|
1. A Mem0 Platform account and API key:
|
|
- <a href="https://app.mem0.ai?utm_source=oss&utm_medium=integration-codex">Sign up at app.mem0.ai</a>
|
|
- <a href="https://app.mem0.ai/dashboard/api-keys?utm_source=oss&utm_medium=integration-codex">Get your API key</a> (starts with `m0-`)
|
|
|
|
2. OpenAI Codex access
|
|
|
|
3. Python 3.10 or newer available as `python3`
|
|
|
|
4. Your API key added to your shell profile (persists across sessions):
|
|
|
|
<CodeGroup>
|
|
```bash zsh
|
|
echo 'export MEM0_API_KEY="m0-your-api-key"' >> ~/.zshrc
|
|
source ~/.zshrc
|
|
```
|
|
|
|
```bash bash
|
|
echo 'export MEM0_API_KEY="m0-your-api-key"' >> ~/.bashrc
|
|
source ~/.bashrc
|
|
```
|
|
</CodeGroup>
|
|
|
|
## Installation
|
|
|
|
### Option A: Plugin Marketplace (Recommended)
|
|
|
|
Install the full plugin, including automatic capture and recall, the `search_memories` tool, and six memory skills.
|
|
|
|
1. Add the Mem0 marketplace:
|
|
|
|
```bash
|
|
codex plugin marketplace add mem0ai/mem0
|
|
```
|
|
|
|
2. Install the plugin:
|
|
|
|
```bash
|
|
codex plugin add mem0@mem0-plugins
|
|
```
|
|
|
|
Or, in the app: restart Codex, open the Plugin Directory, browse the **Mem0 Plugins** marketplace, and install **Mem0**.
|
|
|
|
<Note>
|
|
Step 1 is required for the app UI. Mem0 isn't in OpenAI's curated directory yet, so **without `codex plugin marketplace add`, Mem0 won't appear in the Codex app's Plugin Directory**: searching for it returns nothing. Adding the marketplace surfaces it (under **Created by you**) and makes it installable.
|
|
</Note>
|
|
|
|
<Info>
|
|
Do not combine with Option B. The plugin manifest auto-registers the `mem0` MCP server, so adding both will create a duplicate registration.
|
|
</Info>
|
|
|
|
### Option B: Direct MCP
|
|
|
|
The fastest way to connect Codex to Mem0 needs no plugin or marketplace. Add the MCP server with a single command:
|
|
|
|
```bash
|
|
codex mcp add mem0 --url https://mcp.mem0.ai/mcp/ --bearer-token-env-var MEM0_API_KEY
|
|
```
|
|
|
|
Or add it manually to `~/.codex/config.toml`:
|
|
|
|
```toml
|
|
[mcp_servers.mem0]
|
|
url = "https://mcp.mem0.ai/mcp/"
|
|
bearer_token_env_var = "MEM0_API_KEY"
|
|
```
|
|
|
|
Make sure `MEM0_API_KEY` is exported in the shell you launch Codex from, then restart Codex.
|
|
|
|
This gives you the MCP tools but not the lifecycle hooks or SDK skill.
|
|
|
|
### Managing the Plugin
|
|
|
|
```bash
|
|
codex plugin marketplace upgrade # pull latest plugin versions
|
|
codex plugin remove mem0@mem0-plugins # uninstall the plugin (keeps the marketplace)
|
|
codex plugin marketplace remove mem0-plugins # unregister the marketplace entirely
|
|
```
|
|
|
|
To update, run `codex plugin marketplace upgrade` to pull the latest from the Mem0 repo.
|
|
|
|
<Info icon="check">
|
|
After Option A, ask Codex to search memory for a recent project decision. After Option B, ask it to list your Mem0 entities. If the matching tool responds, the connection is ready.
|
|
</Info>
|
|
|
|
## Codex Cloud
|
|
|
|
[Codex Cloud](https://developers.openai.com/codex/cloud/environments) tasks run setup scripts and the agent in separate phases with different variable scoping:
|
|
|
|
- **Environment Variables** persist for the full duration of the task, through both the setup script and the agent phase.
|
|
- **Secrets** are only available to the setup script; they are wiped before the agent phase starts, so the agent itself cannot read them.
|
|
|
|
Because the `mem0` MCP server authenticates on every tool call the agent makes (not just during setup), set `MEM0_API_KEY` as an **Environment Variable** in your Codex Cloud environment configuration, not as a Secret. A Secret will let a setup script authenticate but the agent will lose access to `MEM0_API_KEY` once the task phase begins, breaking Mem0 MCP calls.
|
|
|
|
Lifecycle hooks that shell out to local scripts (Option A) are not applicable in Codex Cloud's ephemeral containers; use Option B (Direct MCP) with `MEM0_API_KEY` set as above.
|
|
|
|
## What's Included
|
|
|
|
| Component | Plugin Install | MCP Only |
|
|
|-----------|:--------------:|:--------:|
|
|
| Memory tools | `search_memories` | 9 CRUD tools |
|
|
| Lifecycle hooks | Yes | No |
|
|
| Native subagent memory lifecycle | Yes | No |
|
|
| Memory skills | 6 | No |
|
|
|
|
Codex plugins cannot currently bundle a named custom agent. If you define project or user agents under `.codex/agents/` or `~/.codex/agents/`, the full Mem0 plugin gives every native subagent the parent turn's retrieved memory context and records its completed result.
|
|
|
|
## Direct MCP tools
|
|
|
|
Option B exposes the following hosted tools. The full plugin in Option A uses the focused `search_memories` tool and captures writes through lifecycle hooks.
|
|
|
|
| Tool | Description |
|
|
|------|-------------|
|
|
| `add_memory` | Save text or conversation history for a user/agent |
|
|
| `search_memories` | Semantic search across memories with filters |
|
|
| `get_memories` | List memories with filters and pagination |
|
|
| `get_memory` | Retrieve a specific memory by ID |
|
|
| `update_memory` | Overwrite a memory's text by ID |
|
|
| `delete_memory` | Delete a single memory by ID |
|
|
| `delete_all_memories` | Bulk delete all memories in scope |
|
|
| `delete_entities` | Delete a user/agent/app/run entity and its memories |
|
|
| `list_entities` | List users/agents/apps/runs stored in Mem0 |
|
|
|
|
## Lifecycle hooks
|
|
|
|
Option A registers the hooks with the plugin. No separate hook installer or global `hooks.json` edit is required.
|
|
|
|
| Hook | Event | What it does |
|
|
|------|-------|-------------|
|
|
| **Session start** | `SessionStart` | Loads prior memories and displays status banner |
|
|
| **User prompt** | `UserPromptSubmit` | Searches relevant memories before each message |
|
|
| **Post-tool** | `PostToolUse` | Records useful tool outcomes for the completed exchange |
|
|
| **Subagent start** | `SubagentStart` | Reuses the parent turn's retrieved memory context in the child |
|
|
| **Subagent stop** | `SubagentStop` | Records the child transcript path and completed result |
|
|
| **Stop** | `Stop` | Captures completed work and starts a background flush when needed |
|
|
| **Pre-compact** | `PreCompact` | Flushes pending capture before context compaction |
|
|
| **Session end** | `SessionEnd` | Flushes any remaining capture in the background |
|
|
|
|
What you type is stored as yours. What Codex produces (session summaries and compaction summaries) is stored as the assistant's, so its suggestions never become your stated preferences.
|
|
|
|
## Example Workflow
|
|
|
|
```text
|
|
# Task 1: Setting up a new service
|
|
You: Create a REST API for the notifications service using Express and TypeScript.
|
|
|
|
# Codex searches memories, finds your preferences from prior tasks.
|
|
# Mem0 stores what you said as yours:
|
|
# - Your preference: "Prefers explicit error types over generic catch-all"
|
|
# ...and what Codex did as the assistant's, in the session summary:
|
|
# - Decision: "Notifications service uses Express + TypeScript + Zod validation"
|
|
# - Convention: "All API routes follow /api/v1/{resource} pattern"
|
|
|
|
# Task 2 (days later): Extending the service
|
|
You: Add WebSocket support for real-time notification delivery.
|
|
|
|
# Codex searches memories, retrieves the architecture decisions and conventions.
|
|
# Follows the same patterns established in the first task.
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
- **"Connection failed"**: Verify `MEM0_API_KEY` is set: `echo $MEM0_API_KEY`
|
|
- **No tools appearing**: Restart your Codex session after installation
|
|
- **Duplicate `mem0` MCP / "tool collision" errors**: You combined Option A with Option B. Remove the `[mcp_servers.mem0]` block from `~/.codex/config.toml`; the plugin registers it automatically
|
|
- **Hooks not firing**: Confirm you installed Option A and restart Codex. MCP-only installs (Option B) do not include hooks.
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Mem0 MCP Setup" icon="puzzle-piece" href="/platform/mem0-mcp">
|
|
Detailed MCP configuration for all clients
|
|
</Card>
|
|
<Card title="Claude Code Integration" icon="/images/provider-icons/anthropic.svg" href="/integrations/claude-code">
|
|
Add Mem0 memory to Claude Code workflows
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
<Snippet file="star-on-github.mdx" />
|