memvid-mcp-server 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +68 -0
- package/dist/index.js +21 -0
- package/package.json +50 -0
package/README.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# Memvid MCP Server
|
|
2
|
+
|
|
3
|
+
An [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server for [Memvid](https://memvid.com/), enabling AI agents to use persistent, file-based memory.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Project-based Memory**: Create and manage isolated memory files (`.mv2`) for different projects.
|
|
8
|
+
- **Add Content**: Store text documents, code snippets, and metadata.
|
|
9
|
+
- **Semantic Search**: Find relevant content using Memvid's hybrid search (lexical + semantic).
|
|
10
|
+
- **Ask Memory (Optional)**: Ask natural language questions about your stored data (requires OpenAI API Key).
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm install -g memvid-mcp-server
|
|
16
|
+
# or
|
|
17
|
+
bun add -g memvid-mcp-server
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Configuration
|
|
21
|
+
|
|
22
|
+
This server can be used with any MCP-compliant client (e.g., Claude Desktop, Cursor).
|
|
23
|
+
|
|
24
|
+
### Environment Variables
|
|
25
|
+
|
|
26
|
+
| Variable | Description | Required |
|
|
27
|
+
| ---------------- | -------------------------------------------------------------------------------------------------------- | ------------- |
|
|
28
|
+
| `OPENAI_API_KEY` | Your OpenAI API Key. Required to enable the `ask_memory` tool and for semantic embeddings in some modes. | No (Optional) |
|
|
29
|
+
|
|
30
|
+
### Claude Desktop Configuration
|
|
31
|
+
|
|
32
|
+
Add the following to your `claude_desktop_config.json`:
|
|
33
|
+
|
|
34
|
+
```json
|
|
35
|
+
{
|
|
36
|
+
"mcpServers": {
|
|
37
|
+
"memvid": {
|
|
38
|
+
"command": "npx",
|
|
39
|
+
"args": ["-y", "memvid-mcp-server"],
|
|
40
|
+
"env": {
|
|
41
|
+
"OPENAI_API_KEY": "sk-..."
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
> **Note:** If you do not provide `OPENAI_API_KEY`, the `ask_memory` tool will not be available, but you can still use `create_or_open_memory`, `add_content`, and `search_memory` (lexical mode).
|
|
49
|
+
|
|
50
|
+
## Tools
|
|
51
|
+
|
|
52
|
+
1. **`create_or_open_memory`**: Initialize a new project memory or open an existing one.
|
|
53
|
+
2. **`add_content`**: Add text and metadata to the memory.
|
|
54
|
+
3. **`search_memory`**: Search your memory.
|
|
55
|
+
4. **`ask_memory`**: (Optional) Ask questions about your memory using an LLM.
|
|
56
|
+
|
|
57
|
+
## Development
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
# Install dependencies
|
|
61
|
+
bun install
|
|
62
|
+
|
|
63
|
+
# Run locally
|
|
64
|
+
bun run src/index.ts
|
|
65
|
+
|
|
66
|
+
# Build
|
|
67
|
+
bun build ./src/index.ts --compile --outfile server
|
|
68
|
+
```
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
// src/index.ts
|
|
4
|
+
import"dotenv/config";
|
|
5
|
+
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
6
|
+
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
|
7
|
+
import { registerAllTools } from "./tools/index.js";
|
|
8
|
+
var server = new McpServer({
|
|
9
|
+
name: "memvid-mcp-server",
|
|
10
|
+
version: "1.0.0"
|
|
11
|
+
});
|
|
12
|
+
registerAllTools(server);
|
|
13
|
+
async function main() {
|
|
14
|
+
const transport = new StdioServerTransport;
|
|
15
|
+
await server.connect(transport);
|
|
16
|
+
console.error("Memvid MCP Server running on stdio");
|
|
17
|
+
}
|
|
18
|
+
main().catch((error) => {
|
|
19
|
+
console.error("Fatal error in main loop:", error);
|
|
20
|
+
process.exit(1);
|
|
21
|
+
});
|
package/package.json
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "memvid-mcp-server",
|
|
3
|
+
"module": "index.ts",
|
|
4
|
+
"description": "MCP Server for Memvid",
|
|
5
|
+
"version": "1.0.0",
|
|
6
|
+
"logo": "https://memvid.io/logo.png",
|
|
7
|
+
"keywords": [
|
|
8
|
+
"mcp",
|
|
9
|
+
"memvid",
|
|
10
|
+
"server",
|
|
11
|
+
"ai",
|
|
12
|
+
"agent"
|
|
13
|
+
],
|
|
14
|
+
"author": "Memvid",
|
|
15
|
+
"license": "MIT",
|
|
16
|
+
"homepage": "https://memvid.io",
|
|
17
|
+
"repository": {
|
|
18
|
+
"type": "git",
|
|
19
|
+
"url": "git+https://github.com/memvid/memvid-mcp-server.git"
|
|
20
|
+
},
|
|
21
|
+
"bugs": {
|
|
22
|
+
"url": "https://github.com/memvid/memvid-mcp-server/issues"
|
|
23
|
+
},
|
|
24
|
+
"main": "dist/index.js",
|
|
25
|
+
"bin": {
|
|
26
|
+
"memvid-mcp-server": "./dist/index.js"
|
|
27
|
+
},
|
|
28
|
+
"files": [
|
|
29
|
+
"dist"
|
|
30
|
+
],
|
|
31
|
+
"scripts": {
|
|
32
|
+
"build": "bun build ./src/index.ts --outdir ./dist --target node --external '*'",
|
|
33
|
+
"prepublishOnly": "bun run build"
|
|
34
|
+
},
|
|
35
|
+
"type": "module",
|
|
36
|
+
"private": false,
|
|
37
|
+
"devDependencies": {
|
|
38
|
+
"@types/bun": "latest",
|
|
39
|
+
"@types/node": "^25.0.3"
|
|
40
|
+
},
|
|
41
|
+
"peerDependencies": {
|
|
42
|
+
"typescript": "^5.9.3"
|
|
43
|
+
},
|
|
44
|
+
"dependencies": {
|
|
45
|
+
"@memvid/sdk": "^2.0.146",
|
|
46
|
+
"@modelcontextprotocol/sdk": "^1.25.1",
|
|
47
|
+
"dotenv": "^17.2.3",
|
|
48
|
+
"zod": "^3.23.8"
|
|
49
|
+
}
|
|
50
|
+
}
|