Skip to content

Commit 0c8b3bd

Browse files
miparnisarigithub-actions[bot]
authored andcommitted
[create-pull-request] automated change
1 parent f9c65d4 commit 0c8b3bd

File tree

1 file changed

+85
-5
lines changed

1 file changed

+85
-5
lines changed

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

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

662731
Query the permissions in a permissions system
@@ -682,16 +751,16 @@ Query the permissions in a permissions system
682751

683752
### Children commands
684753

685-
- [zed permission bulk](#reference-zed-permission-bulk) - Check a permissions in bulk exists for a resource-subject pairs
754+
- [zed permission bulk](#reference-zed-permission-bulk) - Check permissions in bulk exist for resource-subject pairs
686755
- [zed permission check](#reference-zed-permission-check) - Check that a permission exists for a subject
687756
- [zed permission expand](#reference-zed-permission-expand) - Expand the structure of a permission
688-
- [zed permission lookup-resources](#reference-zed-permission-lookup-resources) - Enumerates resources of a given type for which the subject has permission
757+
- [zed permission lookup-resources](#reference-zed-permission-lookup-resources) - Enumerates the resources of a given type for which the subject has permission
689758
- [zed permission lookup-subjects](#reference-zed-permission-lookup-subjects) - Enumerates the subjects of a given type for which the subject has permission on the resource
690759

691760

692761
## Reference: `zed permission bulk`
693762

694-
Check a permissions in bulk exists for a resource-subject pairs
763+
Check permissions in bulk exist for resource-subject pairs
695764

696765
```
697766
zed permission bulk <resource:id#permission@subject:id> <resource:id#permission@subject:id> ... [flags]
@@ -816,7 +885,7 @@ zed permission expand <permission> <resource:id> [flags]
816885

817886
## Reference: `zed permission lookup-resources`
818887

819-
Enumerates resources of a given type for which the subject has permission
888+
Enumerates the resources of a given type for which the subject has permission
820889

821890
```
822891
zed permission lookup-resources <type> <permission> <subject:id> [flags]
@@ -1351,6 +1420,17 @@ Write a schema file (.zed or stdin) to the current permissions system
13511420
zed schema write <file?> [flags]
13521421
```
13531422

1423+
### Examples
1424+
1425+
```
1426+
1427+
Write from a file:
1428+
zed schema write schema.zed
1429+
Write from stdin:
1430+
cat schema.zed | zed schema write
1431+
1432+
```
1433+
13541434
### Options
13551435

13561436
```

0 commit comments

Comments
 (0)