admin/basicmachines-co-basic-memory
1
0
Fork 0
mirror of https://github.com/basicmachines-co/basic-memory synced 2026-06-21 13:47:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: cross-link MCP-server prereq with the Claude Code plugin install

Browse Source 
The MCP server is a hard prerequisite for the plugin (its hooks and skills call
it), but the two were in separate README sections with no link between them.

- The "Claude Code plugin" install section now points to "Connect your AI client"
  and states the MCP server must be connected first.
- The "Connect your AI client → Claude Code" section now points to the plugin for
  the full memory bridge.
- /basic-memory:setup's prerequisite check is now concrete: verify the MCP server
  via list_memory_projects, and if absent, walk the user through installing and
  `claude mcp add basic-memory -- uvx basic-memory mcp` before starting the interview.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: phernandez <paul@basicmachines.co>
This commit is contained in:
phernandez
2026-05-31 10:51:06 -05:00
committed by Paul Hernandez
parent df5f0f4c04
commit 451f27cfd9
2 changed files with 21 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -1
View File
@@ -199,7 +199,11 @@ just package-check-openclaw
The Claude Code plugin is the bridge between Claude's working memory and Basic
Memory — session-start briefings, pre-compaction checkpoints, an opt-in capture
output style, and `/basic-memory:setup` · `:remember` · `:share` · `:status`:
output style, and `/basic-memory:setup` · `:remember` · `:share` · `:status`.
**Connect the Basic Memory MCP server first** — see [Connect your AI
client](#connect-your-ai-client). The plugin's hooks and skills call it, so it's a
hard prerequisite. Then add the marketplace and install:
```bash
claude plugin marketplace add basicmachines-co/basic-memory \
@@ -277,6 +281,10 @@ Restart Claude Desktop. Notes live in `~/basic-memory` by default.
claude mcp add basic-memory -- uvx basic-memory mcp
```
For the full memory bridge — session briefings, pre-compaction checkpoints, and
the `/basic-memory:*` commands — also install the [Claude Code
plugin](#claude-code-plugin) on top of this.
### Codex CLI
Add to `~/.codex/config.toml`:
plugins/claude-code/skills/setup/SKILL.md
+12 -4
View File
@@ -15,10 +15,18 @@ the interview is done and you've confirmed the plan.
## Prerequisite check
First confirm Basic Memory is reachable (`list_memory_projects`). If it isn't
installed/configured as an MCP server, say so and stop — point the user at
`uv tool install basic-memory` and connecting it to Claude Code. Everything below
needs it.
First confirm the **Basic Memory MCP server is connected** — call
`list_memory_projects`. If that tool isn't available or errors, Basic Memory isn't
wired into Claude Code yet. **Stop and walk the user through it first** (everything
below depends on it):
1. Install it: `uv tool install basic-memory` (or `pip install basic-memory`),
version `>= 0.19.0`.
2. Connect it: `claude mcp add basic-memory -- uvx basic-memory mcp`, then restart
the session so the MCP server loads.
Re-check `list_memory_projects` before continuing — don't start the interview until
it succeeds.
## Interview