aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1e79700
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# 🏠 Supermemory MCP (Local)
+
+> Supermemory MCP, Rewritten From Scratch as a Minimal Local Process
+
+## Setup
+
+```bash
+bun install
+```
+
+## Usage
+
+```json
+{
+ "mcpServers": {
+ "supermemory": {
+ "command": "bun",
+ "args": ["run", "/path/to/supermemory-mcp-local/index.ts"],
+ "env": {
+ "SUPERMEMORY_API_KEY": "sm_..."
+ }
+ }
+ }
+}
+```
+
+## Tools
+
+- `memory` - Save or forget information
+- `recall` - Search memories
+- `listProjects` - List available projects
+- `whoAmI` - Get current user information
+
+## Prompts
+
+- `context` - Get user profile for system context
+
+## License
+
+This project is licensed under the [MIT License](./LICENSE.txt).