Skip to content

Commit 24b5ab2

Browse files
tstirrat15github-actions[bot]
authored andcommitted
[create-pull-request] automated change
1 parent 3ab7b81 commit 24b5ab2

File tree

1 file changed

+71
-1
lines changed

1 file changed

+71
-1
lines changed

pages/spicedb/getting-started/installing-zed.mdx

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ sudo chmod 644 /etc/apt/sources.list.d/authzed.list # helps tools such as comma
2828

2929
Alternatively, if you want to use the new `deb822`-style `authzed.sources` format, put the following in `/etc/apt/sources.list.d/authzed.sources`:
3030

31-
```
31+
```sh
3232
Types: deb
3333
URIs: https://pkg.authzed.com/apt/
3434
Suites: *
@@ -123,6 +123,7 @@ You can find more commands for tasks such as testing, linting in the repository'
123123

124124
[CONTRIBUTING.md]: https://github.com/authzed/zed/blob/main/CONTRIBUTING.md
125125

126+
126127
## Reference: `zed`
127128

128129
A command-line client for managing SpiceDB clusters.
@@ -163,6 +164,7 @@ zed permission check --explain document:firstdoc writer user:emilia
163164
- [zed backup](#reference-zed-backup) - Create, restore, and inspect permissions system backups
164165
- [zed context](#reference-zed-context) - Manage configurations for connecting to SpiceDB deployments
165166
- [zed import](#reference-zed-import) - Imports schema and relationships from a file or url
167+
- [zed mcp](#reference-zed-mcp) - MCP (Model Context Protocol) server commands
166168
- [zed permission](#reference-zed-permission) - Query the permissions in a permissions system
167169
- [zed relationship](#reference-zed-relationship) - Query and mutate the relationships in a permissions system
168170
- [zed schema](#reference-zed-schema) - Manage schema for a permissions system
@@ -657,6 +659,74 @@ zed import <url> [flags]
657659

658660

659661

662+
## Reference: `zed mcp`
663+
664+
MCP (Model Context Protocol) server commands.
665+
666+
The MCP server provides tooling and resources for developing and debugging SpiceDB schema and relationships. The server runs an in-memory development instance of SpiceDB and does not connect to a running instance of SpiceDB.
667+
668+
To use with Claude Code, run "zed mcp experimental-run" to start the SpiceDB Dev MCP server and then run "claude mcp add --transport http spicedb http://localhost:9999/mcp" to add the server to your Claude Code integrations.
669+
670+
671+
### Options Inherited From Parent Flags
672+
673+
```
674+
--certificate-path string path to certificate authority used to verify secure connections
675+
--endpoint string spicedb gRPC API endpoint
676+
--hostname-override string override the hostname used in the connection to the endpoint
677+
--insecure connect over a plaintext connection
678+
--log-format string format of logs ("auto", "console", "json") (default "auto")
679+
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
680+
--max-message-size int maximum size *in bytes* (defaults to 4_194_304 bytes ~= 4MB) of a gRPC message that can be sent or received by zed
681+
--max-retries uint maximum number of sequential retries to attempt when a request fails (default 10)
682+
--no-verify-ca do not attempt to verify the server's certificate chain and host name
683+
--permissions-system string permissions system to query
684+
--proxy string specify a SOCKS5 proxy address
685+
--request-id string optional id to send along with SpiceDB requests for tracing
686+
--skip-version-check if true, no version check is performed against the server
687+
--token string token used to authenticate to SpiceDB
688+
```
689+
690+
### Children commands
691+
692+
- [zed mcp experimental-run](#reference-zed-mcp-experimental-run) - Run the Experimental MCP server
693+
694+
695+
## Reference: `zed mcp experimental-run`
696+
697+
Run the Experimental MCP server
698+
699+
```
700+
zed mcp experimental-run [flags]
701+
```
702+
703+
### Options
704+
705+
```
706+
-p, --port int port for the HTTP streaming server (default 9999)
707+
```
708+
709+
### Options Inherited From Parent Flags
710+
711+
```
712+
--certificate-path string path to certificate authority used to verify secure connections
713+
--endpoint string spicedb gRPC API endpoint
714+
--hostname-override string override the hostname used in the connection to the endpoint
715+
--insecure connect over a plaintext connection
716+
--log-format string format of logs ("auto", "console", "json") (default "auto")
717+
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
718+
--max-message-size int maximum size *in bytes* (defaults to 4_194_304 bytes ~= 4MB) of a gRPC message that can be sent or received by zed
719+
--max-retries uint maximum number of sequential retries to attempt when a request fails (default 10)
720+
--no-verify-ca do not attempt to verify the server's certificate chain and host name
721+
--permissions-system string permissions system to query
722+
--proxy string specify a SOCKS5 proxy address
723+
--request-id string optional id to send along with SpiceDB requests for tracing
724+
--skip-version-check if true, no version check is performed against the server
725+
--token string token used to authenticate to SpiceDB
726+
```
727+
728+
729+
660730
## Reference: `zed permission`
661731

662732
Query the permissions in a permissions system

0 commit comments

Comments
 (0)