Skip to content

Commit 3cbaa8f

Browse files
samkimgithub-actions[bot]
authored andcommitted
[create-pull-request] automated change
1 parent 61d40e8 commit 3cbaa8f

File tree

1 file changed

+72
-1
lines changed

1 file changed

+72
-1
lines changed

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

Lines changed: 72 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- markdownlint-disable-next-line MD041 -->
12
import { Callout } from 'nextra/components'
23

34
# Installing Zed
@@ -28,7 +29,7 @@ sudo chmod 644 /etc/apt/sources.list.d/authzed.list # helps tools such as comma
2829

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

31-
```
32+
```sh
3233
Types: deb
3334
URIs: https://pkg.authzed.com/apt/
3435
Suites: *
@@ -123,6 +124,7 @@ You can find more commands for tasks such as testing, linting in the repository'
123124

124125
[CONTRIBUTING.md]: https://github.com/authzed/zed/blob/main/CONTRIBUTING.md
125126

127+
126128
## Reference: `zed`
127129

128130
A command-line client for managing SpiceDB clusters.
@@ -163,6 +165,7 @@ zed permission check --explain document:firstdoc writer user:emilia
163165
- [zed backup](#reference-zed-backup) - Create, restore, and inspect permissions system backups
164166
- [zed context](#reference-zed-context) - Manage configurations for connecting to SpiceDB deployments
165167
- [zed import](#reference-zed-import) - Imports schema and relationships from a file or url
168+
- [zed mcp](#reference-zed-mcp) - MCP (Model Context Protocol) server commands
166169
- [zed permission](#reference-zed-permission) - Query the permissions in a permissions system
167170
- [zed relationship](#reference-zed-relationship) - Query and mutate the relationships in a permissions system
168171
- [zed schema](#reference-zed-schema) - Manage schema for a permissions system
@@ -657,6 +660,74 @@ zed import <url> [flags]
657660

658661

659662

663+
## Reference: `zed mcp`
664+
665+
MCP (Model Context Protocol) server commands.
666+
667+
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.
668+
669+
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.
670+
671+
672+
### Options Inherited From Parent Flags
673+
674+
```
675+
--certificate-path string path to certificate authority used to verify secure connections
676+
--endpoint string spicedb gRPC API endpoint
677+
--hostname-override string override the hostname used in the connection to the endpoint
678+
--insecure connect over a plaintext connection
679+
--log-format string format of logs ("auto", "console", "json") (default "auto")
680+
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
681+
--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
682+
--max-retries uint maximum number of sequential retries to attempt when a request fails (default 10)
683+
--no-verify-ca do not attempt to verify the server's certificate chain and host name
684+
--permissions-system string permissions system to query
685+
--proxy string specify a SOCKS5 proxy address
686+
--request-id string optional id to send along with SpiceDB requests for tracing
687+
--skip-version-check if true, no version check is performed against the server
688+
--token string token used to authenticate to SpiceDB
689+
```
690+
691+
### Children commands
692+
693+
- [zed mcp experimental-run](#reference-zed-mcp-experimental-run) - Run the Experimental MCP server
694+
695+
696+
## Reference: `zed mcp experimental-run`
697+
698+
Run the Experimental MCP server
699+
700+
```
701+
zed mcp experimental-run [flags]
702+
```
703+
704+
### Options
705+
706+
```
707+
-p, --port int port for the HTTP streaming server (default 9999)
708+
```
709+
710+
### Options Inherited From Parent Flags
711+
712+
```
713+
--certificate-path string path to certificate authority used to verify secure connections
714+
--endpoint string spicedb gRPC API endpoint
715+
--hostname-override string override the hostname used in the connection to the endpoint
716+
--insecure connect over a plaintext connection
717+
--log-format string format of logs ("auto", "console", "json") (default "auto")
718+
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
719+
--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
720+
--max-retries uint maximum number of sequential retries to attempt when a request fails (default 10)
721+
--no-verify-ca do not attempt to verify the server's certificate chain and host name
722+
--permissions-system string permissions system to query
723+
--proxy string specify a SOCKS5 proxy address
724+
--request-id string optional id to send along with SpiceDB requests for tracing
725+
--skip-version-check if true, no version check is performed against the server
726+
--token string token used to authenticate to SpiceDB
727+
```
728+
729+
730+
660731
## Reference: `zed permission`
661732

662733
Query the permissions in a permissions system

0 commit comments

Comments
 (0)