Skip to content

Commit 98c85c3

Browse files
authored
Update README.md
1 parent 3b14d94 commit 98c85c3

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,20 @@ A Model Context Protocol server that provides access to Kuzu databases. This ser
55
## Components
66
### Tools
77
- 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
99
- Input: None
1010

1111
- query
1212
- 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
1419

1520
## Usage with Claude Desktop
16-
### With Node.js and npm
17-
- Install dependencies: `npm install`
21+
### With Docker (Recommended)
1822
- Edit the configuration file `config.json`:
1923
- on macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
2024
- 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
2327
{
2428
"mcpServers": {
2529
"kuzu": {
26-
"command": "node",
30+
"command": "docker",
2731
"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"
3038
]
3139
}
3240
}
3341
}
3442
```
35-
Change the `{Absolute Path to this repository}` and `{Absolute Path to the Kuzu database}` to the actual paths
36-
- Restart Claude Desktop
3743

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`
4046
- Edit the configuration file `config.json`:
4147
- on macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
4248
- 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
4551
{
4652
"mcpServers": {
4753
"kuzu": {
48-
"command": "docker",
54+
"command": "node",
4955
"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}",
5658
]
5759
}
5860
}
5961
}
6062
```
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+
6167
Change the `{Absolute Path to the Kuzu database}` to the actual path
6268
- Restart Claude Desktop

0 commit comments

Comments
 (0)