scriptoriumadmin/supermemory
1
0
Fork 0
mirror of https://github.com/supermemoryai/supermemory.git synced 2026-09-30 01:51:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add Muse Code plugin docs (#1674)

Browse source
This commit is contained in:
Dhravya Shah 2026-09-17 09:36:04 -07:00 • committed by GitHub
parent c927c98f2c
commit 69327ca1c6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 149 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -67,7 +67,7 @@ All of this is in our single memory structure and ontology.
<h3>🧑‍💻 I use AI tools</h3>
Give Claude Code, Cursor, Codex and OpenCode **persistent memory across every conversation** with a plugin or the MCP server.
Give Claude Code, Muse Code, Cursor, Codex and OpenCode **persistent memory across every conversation** with a plugin or the MCP server.
Your AI remembers your preferences, projects, past discussions — and gets smarter over time.
@ -111,7 +111,7 @@ Plugins and the MCP server give any compatible AI assistant persistent memory. O
### Supermemory Plugins
Supermemory comes built with plugins for Claude Code, Cursor, Codex, OpenCode, OpenClaw, and Hermes.
Supermemory comes built with plugins for Claude Code, Muse Code, Cursor, Codex, OpenCode, OpenClaw, and Hermes.
<img width="844" height="484" alt="image" src="https://github.com/user-attachments/assets/ecb879a2-8652-495d-9228-f305a97ba603" />
@ -120,6 +120,7 @@ These plugins are implementations of the supermemory API, and they are open sour
You can find them here:
- Claude Code plugin: https://github.com/supermemoryai/claude-supermemory
- Muse Code plugin: https://github.com/supermemoryai/muse-supermemory
- Cursor plugin: https://github.com/supermemoryai/cursor-supermemory
- Codex plugin: https://github.com/supermemoryai/codex-supermemory
- OpenClaw plugin: https://github.com/supermemoryai/openclaw-supermemory

1
apps/docs/docs.json
View file

@ -390,6 +390,7 @@
"integrations/openclaw",
"integrations/hermes",
"integrations/claude-code",
"integrations/muse-code",
"integrations/codex",
"integrations/opencode",
"integrations/cursor",

4
apps/docs/images/muse-code-icon.svg Normal file
View file

@ -0,0 +1,4 @@
<svg viewBox="0 0 40 40" fill="none" xmlns="http://www.w3.org/2000/svg">
<title>Meta</title>
<path fill="#0081FB" d="M27.1942 9.03509C24.4881 9.03509 22.3726 11.0731 20.4574 13.6623C17.8258 10.3114 15.6255 9.03509 12.9925 9.03509C7.62404 9.03509 3.51001 16.0234 3.51001 23.4181C3.51001 28.0453 5.74831 30.9649 9.49831 30.9649C12.1971 30.9649 14.1387 29.693 17.5904 23.6594C17.5904 23.6594 19.029 21.1199 20.0173 19.3699C20.3643 19.9293 20.7298 20.5327 21.1138 21.1798L22.7322 23.902C25.8843 29.1769 27.6416 30.9649 30.8229 30.9649C34.4778 30.9649 36.51 28.0058 36.51 23.2822C36.51 15.538 32.3039 9.03509 27.1942 9.03509ZM14.9574 22.0263C12.1606 26.4123 11.1928 27.3962 9.63574 27.3962C8.03194 27.3962 7.07872 25.9883 7.07872 23.4781C7.07872 18.1096 9.75562 12.6199 12.9471 12.6199C14.6752 12.6199 16.1197 13.617 18.3316 16.7836C16.2308 20.0058 14.9574 22.0263 14.9574 22.0263ZM25.5202 21.4751L23.5831 18.2456C23.0969 17.4514 22.5938 16.6676 22.0743 15.8947C23.8185 13.2032 25.2556 11.8611 26.9676 11.8611C30.5202 11.8611 33.3638 17.095 33.3638 23.5219C33.3638 25.9722 32.5612 27.3947 30.8989 27.3947C29.3053 27.3947 28.5451 26.3421 25.5188 21.4737"/>
</svg>
Side by side

After

Width:  |  Height:  |  Size: 1.1 KiB

2
apps/docs/integrations/cursor.mdx
View file

@ -122,7 +122,7 @@ Every tool that takes a `container` argument accepts:
## Container Tags
Cursor shares one repository tag with the [Claude Code](/integrations/claude-code), [OpenAI Codex](/integrations/codex), and [OpenCode](/integrations/opencode) plugins, so agents working on the same repo read and write the same memory:
Cursor shares one repository tag with the [Claude Code](/integrations/claude-code), [Muse Code](/integrations/muse-code), [OpenAI Codex](/integrations/codex), and [OpenCode](/integrations/opencode) plugins, so agents working on the same repo read and write the same memory:
```text
repo_<project_name>__<project_id>

138
apps/docs/integrations/muse-code.mdx Normal file
View file

@ -0,0 +1,138 @@
---
title: "Muse Code"
sidebarTitle: "Muse Code"
description: "muse-supermemory — persistent memory for Meta Muse Code"
icon: "/images/muse-code-icon.svg"
---
[muse-supermemory](https://github.com/supermemoryai/muse-supermemory) is a native [Muse Code](https://dev.meta.ai/docs/muse-code) plugin that gives your agent persistent memory across sessions. Your agent remembers what you worked on — across sessions, across projects.
<Tip>
**Prefer to keep everything on your machine?** This plugin works with [self-hosted Supermemory](/self-hosting/overview) — run `npx supermemory local`, then set `baseUrl` in `.muse/supermemory.json` (Muse clears hook env, so `SUPERMEMORY_API_URL` may not reach the plugin) and use the API key printed on first boot.
</Tip>
## Install the Plugin
> **Requires Node.js 18+** on your PATH — the memory hooks and MCP proxy run as Node scripts.
In a Muse session, open `/plugins` and install from the marketplace. Or from the CLI:
```bash
export MUSE_EXPERIMENTAL_PLUGINS=1
muse plugins marketplace add supermemory https://github.com/supermemoryai/muse-supermemory
muse plugins install supermemory@supermemory
muse plugins approve supermemory
```
`approve` trusts the runtime capabilities (hooks + MCP). Without it, the plugin is installed but inert.
Local bundle (a clone of the repo):
```bash
export MUSE_EXPERIMENTAL_PLUGINS=1
muse plugins install . --scope user
muse plugins approve supermemory
```
## Authenticate
Muse runs hooks with a **cleared environment**, so an exported API key in your shell does not reach them. Auth is file-based.
The first session opens a browser login and writes `~/.supermemory-muse/credentials.json`.
If you already logged in through the [Claude Code plugin](/integrations/claude-code), that key is reused from `~/.supermemory-claude/credentials.json`.
Or write the file yourself with a key from [API Keys](https://console.supermemory.ai/keys):
```json
{ "apiKey": "sm_..." }
```
Check the connection any time with `/supermemory:status`.
## How It Works
Two layers, same as the other coding plugins:
| Layer | When | What it does |
| --- | --- | --- |
| Session profile | `SessionStart` | Injects up to 5 persistent profile facts and 5 recent memories for this repo |
| Prompt recall | `UserPromptSubmit` | Searches supermemory with the prompt, injects up to 5 new hits (similarity ≥ 0.55) |
| Auto-approve | `PreToolUse` | Allows read-only supermemory MCP tools without a permission prompt |
| Auto-capture | `Stop` | Saves new user prompts and assistant messages from Muse's `session.jsonl` |
| MCP tools | on demand | Search, save, list, and manage memories explicitly |
Recalled lines are marked `◪`. When the model uses one, it keeps that mark and says "from supermemory" — never "from memory".
Slash commands and very short prompts skip recall. Timeouts fail open so a slow network never blocks the turn.
### Memory scope
Container tags match [Claude Code](/integrations/claude-code):
```text
repo_<project_name>__<project_id>
```
The project ID is a hash of the git remote (or the resolved local path if there isn't one). The same repo in Muse and Claude Code shares memory. Override with `repoContainerTag` in project config.
## Commands
| Command | Description |
| --- | --- |
| `/supermemory:index` | Index codebase architecture and patterns |
| `/supermemory:status` | Auth, container tag, API and MCP reachability |
| `/supermemory:logout` | Clear saved Muse credentials |
A bundled skill also tells the agent when to search vs save on its own.
## Configuration
### Global settings
`~/.supermemory-muse/settings.json`
```json
{
"maxProfileItems": 5,
"debug": false
}
```
| Option | Description |
| --- | --- |
| `maxProfileItems` | Max profile facts injected at session start (default: 5) |
| `debug` | Log hook activity to stderr |
| `recallDirective` | Replace prompt-recall injection with a fixed instruction |
### Project config
Per-repo overrides in `.muse/supermemory.json`. A Claude Code config at `.claude/.supermemory-claude/config.json` is also read, so one repo keeps one container tag across tools.
```json
{
"apiKey": "sm_...",
"baseUrl": "https://api.supermemory.ai",
"repoContainerTag": "my-team-project"
}
```
| Option | Description |
| --- | --- |
| `apiKey` | Project-specific API key |
| `baseUrl` | Supermemory API URL (use for self-hosted) |
| `repoContainerTag` | Override the auto-derived project container |
Add the project file to `.gitignore` if it contains an API key.
## Next Steps
<CardGroup cols={2}>
<Card title="GitHub Repository" icon="/images/github-icon.svg" href="https://github.com/supermemoryai/muse-supermemory">
Source code, issues, and detailed README.
</Card>
<Card title="Claude Code Plugin" icon="/images/claude-code-icon.svg" href="/integrations/claude-code">
The same memory in Claude Code.
</Card>
</CardGroup>

2
apps/docs/overview/billing.mdx
View file

@ -182,7 +182,7 @@ Usage meters are shared; **feature gates** differ by tier.
|---|---|---|---|---|
| Memory API, search, profiles | Yes | Yes | Yes | Yes |
| Diff / delta token billing | Yes | Yes | Yes | Yes |
| Plugins (Claude Code, Cursor, Hermes, …) | — | Yes | Yes | Yes |
| Plugins (Claude Code, Muse Code, Cursor, Hermes, …) | — | Yes | Yes | Yes |
| Team management | — | Yes | Yes | Yes |
| Google Drive, OneDrive, Notion connectors | — | Yes | Yes | Yes |
| Gmail, GitHub, S3, Web Crawler connectors | — | — | Yes | Yes |

2
apps/docs/self-hosting/overview.mdx
View file

@ -54,7 +54,7 @@ const client = new Supermemory({
})
```
Everything in the [Memory API docs](/quickstart) works the same way. The coding plugins do too — [Claude Code](/integrations/claude-code), [Codex](/integrations/codex), and [OpenCode](/integrations/opencode) all target your local server with `SUPERMEMORY_API_URL=http://localhost:6767`.
Everything in the [Memory API docs](/quickstart) works the same way. The coding plugins do too — [Claude Code](/integrations/claude-code), [Muse Code](/integrations/muse-code), [Codex](/integrations/codex), and [OpenCode](/integrations/opencode) all target your local server with `SUPERMEMORY_API_URL=http://localhost:6767` (Muse: set `baseUrl` in `.muse/supermemory.json`, because hook env is cleared).
## Self-hosted vs. the platform