mirror of
https://github.com/supermemoryai/supermemory.git
synced 2026-08-20 05:54:01 +00:00
4d86b728dd
Updates the Supermemory MCP docs for the revamped tool, space, widget, and OAuth flows. - adds a screenshot-backed ChatGPT Web setup guide with light and dark variants - refreshes the overview, setup, tools, spaces, and widget docs - keeps manual JSON configuration in a dropdown Tested all four local MCP docs routes and image references. for mcp image light mode -> dark mode images and dark mode has light mode (since the background was blending in i made this way to refocus user attention on the screenshots)
173 lines
8.2 KiB
Text
173 lines
8.2 KiB
Text
---
|
|
title: "Overview"
|
|
description: "Give every MCP-compatible assistant shared memory, team spaces, and interactive workflows"
|
|
icon: "brain-circuit"
|
|
---
|
|
|
|
Supermemory MCP gives every MCP-compatible assistant a shared memory layer, so technical and non-technical teams can collaborate with AI using the same authorized context. Connect once to search decisions, save knowledge, upload source material, and explore relationships from the AI tools your team already uses.
|
|
|
|
Engineering and research teams can carry project context across assistants, while finance, legal, medical, and operations teams can work from their own source material. Ask naturally. The assistant selects the right Supermemory tool without requiring code or tool names. See the [tools reference](#tools) for exact inputs and results.
|
|
|
|
## Connect
|
|
|
|
Add this remote MCP server to any compatible client:
|
|
|
|
```text
|
|
https://mcp.supermemory.ai/mcp
|
|
```
|
|
|
|
After you connect, your client opens Supermemory in a browser. Sign in or create an account, then choose which spaces the client can access. Supermemory uses OAuth, so no API key is required.
|
|
|
|
For client-specific instructions, see [Setup and Usage](/supermemory-mcp/setup) or the [Claude Desktop guide](/supermemory-mcp/claude-desktop).
|
|
|
|
<Accordion title="Manual JSON configuration" icon="code">
|
|
MCP clients that use JSON configuration generally accept this shape:
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"supermemory": {
|
|
"url": "https://mcp.supermemory.ai/mcp"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
</Accordion>
|
|
|
|
## How spaces work
|
|
|
|
A **space** keeps a team's documents, memories, and profile context focused, so AI retrieves the right knowledge without mixing unrelated work. Use separate spaces for an engineering launch, research project, finance workflow, legal matter, medical knowledge base, or any other shared initiative. Teammates collaborate within the spaces they are allowed to read or write.
|
|
|
|
Name a space to use it for one request without changing your active space. Otherwise, Supermemory uses your active space or account default. Ask to switch spaces when you want future requests to use a different active space.
|
|
|
|
## Tools
|
|
|
|
Your assistant chooses these tools automatically. Use this table when you need the exact inputs and results.
|
|
|
|
| Tool | Use it for | Inputs | Result |
|
|
| --- | --- | --- | --- |
|
|
| `search_memory` | Semantic recall from one space, with optional profile context | `query` (required), `includeProfile`, `containerTag` | Profile context and matching memories |
|
|
| `add_memory` | Save information or forget outdated information | `content` (required), `action` (`save` or `forget`), `containerTag` | Save or forget confirmation |
|
|
| `listDocuments` | Browse stored source documents and their summaries | `page`, `limit`, `containerTag` | Document IDs, titles, types, status, dates, and summaries |
|
|
| `getDocument` | Read the available content of one document | `documentId` (required) | Document metadata, summary, and available content |
|
|
| `listMemories` | Browse recent extracted memory entries and their source document IDs | `page`, `limit`, `containerTag` | Memory IDs, text, versions, and source document IDs |
|
|
| `listSpaces` | List accessible spaces and resolve a space name to its key | None | Formatted list plus structured `spaces` and `count` fields |
|
|
| `whoAmI` | Inspect the authenticated account, permissions, scope, and active space | None | Account and access context |
|
|
|
|
### Search
|
|
|
|
`search_memory` accepts a natural-language query and returns semantically relevant memories. By default, it also includes stable and recent profile context from the same space. Set `includeProfile` to `false` when only matching memories are needed.
|
|
|
|
Use the retrieval tools for different questions:
|
|
|
|
- Use `search_memory` to answer a question from remembered context.
|
|
- Use `listDocuments` to discover stored sources, then `getDocument` to read one source in full.
|
|
- Use `listMemories` to inspect the extracted memory entries themselves, including their IDs and source document IDs.
|
|
|
|
`listDocuments` and `listMemories` default to 10 results per page and accept up to 50.
|
|
|
|
### Save or forget
|
|
|
|
`add_memory` saves the supplied `content` by default. Set `action` to `forget` when a fact is outdated or should be removed. There is no separate forget tool.
|
|
|
|
If the content is already final, the assistant should use `add_memory`. If you want to review, edit, or choose a space before saving, it should open the `guided-save` widget instead.
|
|
|
|
### Access control
|
|
|
|
`whoAmI` returns the current identity, role, access type, granted scope, and active space. `listSpaces` returns only spaces the authenticated account can access, with names, keys, document and memory counts, and recent activity.
|
|
|
|
## Interactive widgets
|
|
|
|
Clients that support [MCP Apps](https://modelcontextprotocol.io/extensions/apps/overview) can open these Supermemory widgets directly inside the conversation.
|
|
|
|
| Tool | What it opens |
|
|
| --- | --- |
|
|
| `select-space` | A searchable space picker |
|
|
| `guided-save` | An editable memory form with a space selector |
|
|
| `upload-file` | A local file picker and upload form |
|
|
| `memory-graph` | An interactive graph of documents and memories |
|
|
|
|
### Select a space
|
|
|
|
`select-space` opens a searchable space picker and changes the active space for future Supermemory actions. A one-off request in another space does not change the active space.
|
|
|
|
<img
|
|
className="hidden dark:block"
|
|
src="/images/supermemory-mcp/widgets/select-space.png"
|
|
alt="Supermemory MCP searchable space picker"
|
|
/>
|
|
<img
|
|
className="block dark:hidden"
|
|
src="/images/supermemory-mcp/widgets/select-space-dark.png"
|
|
alt="Supermemory MCP searchable space picker"
|
|
/>
|
|
|
|
### Guided save
|
|
|
|
`guided-save` opens a draft with editable memory content and a writable-space selector. The assistant can prefill the draft, but nothing is saved until you submit it.
|
|
|
|
<img
|
|
className="hidden dark:block"
|
|
src="/images/supermemory-mcp/widgets/guided-save-draft.png"
|
|
alt="Supermemory MCP guided save draft with editable memory content and a space selector"
|
|
/>
|
|
<img
|
|
className="block dark:hidden"
|
|
src="/images/supermemory-mcp/widgets/guided-save-dark.png"
|
|
alt="Supermemory MCP guided save draft with editable memory content and a space selector"
|
|
/>
|
|
|
|
### File upload
|
|
|
|
`upload-file` opens a local file picker and uploads one file at a time to a writable space.
|
|
|
|
Supported types include text, Markdown, PDF, Word, CSV, common images, MP3, WAV, M4A, MP4, and WebM.
|
|
|
|
<img
|
|
className="hidden dark:block"
|
|
src="/images/supermemory-mcp/widgets/upload-file.png"
|
|
alt="Supermemory MCP file picker with a writable-space selector"
|
|
/>
|
|
<img
|
|
className="block dark:hidden"
|
|
src="/images/supermemory-mcp/widgets/upload-file-dark.png"
|
|
alt="Supermemory MCP file picker with a writable-space selector"
|
|
/>
|
|
|
|
### Memory graph
|
|
|
|
`memory-graph` renders the selected space as an interactive graph of source documents and extracted memories.
|
|
|
|
When no space is named, the server automatically uses the active space or account default. If you name a specific space, the assistant calls `listSpaces` to resolve its name to a space key, then opens that space's graph.
|
|
|
|
<img
|
|
className="hidden dark:block"
|
|
src="/images/supermemory-mcp/widgets/memory-graph.png"
|
|
alt="Supermemory MCP interactive graph of documents and memories"
|
|
/>
|
|
<img
|
|
className="block dark:hidden"
|
|
src="/images/supermemory-mcp/widgets/memory-graph-dark.png"
|
|
alt="Supermemory MCP interactive graph of documents and memories"
|
|
/>
|
|
|
|
## Resources and context prompt
|
|
|
|
Some MCP clients also expose resources and prompts:
|
|
|
|
| Kind | Name or URI | What it returns |
|
|
| --- | --- | --- |
|
|
| Resource | `supermemory://profile` | Stable and recent profile context for the active space |
|
|
| Resource | `supermemory://spaces` | A compact list of accessible spaces with the active space marked |
|
|
| Prompt | `context` | A ready-to-attach context message for the active space, plus up to three recently active spaces |
|
|
|
|
The `context` prompt takes no arguments. It returns profile context for the active space and up to three recently active spaces.
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Setup and Usage" icon="settings" href="/supermemory-mcp/setup">
|
|
Configure Supermemory in supported MCP clients.
|
|
</Card>
|
|
<Card title="Supermemory MCP on GitHub" icon="/images/github-icon.svg" href="https://github.com/supermemoryai/supermemory/tree/main/apps/mcp">
|
|
View the source code.
|
|
</Card>
|
|
</CardGroup>
|