@@ -5,16 +5,20 @@ A Model Context Protocol server that provides access to Kuzu databases. This ser
5
5
## Components
6
6
### Tools
7
7
- getSchema
8
- - Fetch the full schema of the Kuzu database, including all nodes and relationships tables and their properties.
8
+ - Fetch the full schema of the Kuzu database, including all nodes and relationships tables and their properties
9
9
- Input: None
10
10
11
11
- query
12
12
- Run a Cypher query on the Kuzu database.
13
- - Input: ` cypher ` (string): The Cypher query to run.
13
+ - Input: ` cypher ` (string): The Cypher query to run
14
+
15
+ ### Prompt
16
+ - generateKuzuCypher
17
+ - Generate a Cypher query for Kuzu
18
+ - Argument: ` question ` (string): The question in natural language to generate the Cypher query for
14
19
15
20
## Usage with Claude Desktop
16
- ### With Node.js and npm
17
- - Install dependencies: ` npm install `
21
+ ### With Docker (Recommended)
18
22
- Edit the configuration file ` config.json ` :
19
23
- on macOS: ` ~/Library/Application Support/Claude/claude_desktop_config.json `
20
24
- on Windows: ` %APPDATA%\Claude\claude_desktop_config.json `
@@ -23,20 +27,22 @@ A Model Context Protocol server that provides access to Kuzu databases. This ser
23
27
{
24
28
"mcpServers" : {
25
29
"kuzu" : {
26
- "command" : " node " ,
30
+ "command" : " docker " ,
27
31
"args" : [
28
- " {Absolute Path to this repository}/index.js" ,
29
- " {Absolute Path to the Kuzu database}" ,
32
+ " run" ,
33
+ " -v" ,
34
+ " {Absolute Path to the Kuzu database}:/database" ,
35
+ " --rm" ,
36
+ " -i" ,
37
+ " kuzudb/mcp-server"
30
38
]
31
39
}
32
40
}
33
41
}
34
42
```
35
- Change the ` {Absolute Path to this repository} ` and ` {Absolute Path to the Kuzu database} ` to the actual paths
36
- - Restart Claude Desktop
37
43
38
- ### With Docker
39
- - Build the Docker image : ` docker build -t kuzu-mcp-server . `
44
+ ### With Node.js and npm (for Development)
45
+ - Install dependencies : ` npm install `
40
46
- Edit the configuration file ` config.json ` :
41
47
- on macOS: ` ~/Library/Application Support/Claude/claude_desktop_config.json `
42
48
- on Windows: ` %APPDATA%\Claude\claude_desktop_config.json `
@@ -45,18 +51,18 @@ A Model Context Protocol server that provides access to Kuzu databases. This ser
45
51
{
46
52
"mcpServers" : {
47
53
"kuzu" : {
48
- "command" : " docker " ,
54
+ "command" : " node " ,
49
55
"args" : [
50
- " run" ,
51
- " -v" ,
52
- " {Absolute Path to the Kuzu database}:/database" ,
53
- " --rm" ,
54
- " -i" ,
55
- " kuzu-mcp-server"
56
+ " {Absolute Path to this repository}/index.js" ,
57
+ " {Absolute Path to the Kuzu database}" ,
56
58
]
57
59
}
58
60
}
59
61
}
60
62
```
63
+ Change the ` {Absolute Path to this repository} ` and ` {Absolute Path to the Kuzu database} ` to the actual paths
64
+ - Restart Claude Desktop
65
+
66
+
61
67
Change the ` {Absolute Path to the Kuzu database} ` to the actual path
62
68
- Restart Claude Desktop
0 commit comments