Skip to content

Commit 1e14a48

Browse files
committed
Update README.md to include instructions for read-only mode and clarify path changes
1 parent d787e32 commit 1e14a48

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ A Model Context Protocol server that provides access to Kuzu databases. This ser
4040
}
4141
}
4242
```
43+
Change the `{Absolute Path to the Kuzu database}` to the actual path
44+
- Restart Claude Desktop
4345

4446
### With Node.js and npm (for Development)
4547
- Install dependencies: `npm install`
@@ -63,6 +65,24 @@ A Model Context Protocol server that provides access to Kuzu databases. This ser
6365
Change the `{Absolute Path to this repository}` and `{Absolute Path to the Kuzu database}` to the actual paths
6466
- Restart Claude Desktop
6567

66-
67-
Change the `{Absolute Path to the Kuzu database}` to the actual path
68-
- Restart Claude Desktop
68+
### Read-Only Mode
69+
The server can be run in read-only mode by setting the `KUZU_READ_ONLY` environment variable to `true`. In this mode, running any query that attempts to modify the database will result in an error. This flag can be set in the configuration file as follows:
70+
```json
71+
{
72+
"mcpServers": {
73+
"kuzu": {
74+
"command": "docker",
75+
"args": [
76+
"run",
77+
"-v",
78+
"{Absolute Path to the Kuzu database}:/database",
79+
"-e",
80+
"KUZU_READ_ONLY=true",
81+
"--rm",
82+
"-i",
83+
"kuzudb/mcp-server"
84+
],
85+
}
86+
}
87+
}
88+
```

0 commit comments

Comments
 (0)