Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ config:
no-hard-tabs: false
no-inline-html: false
no-multiple-blanks: false
no-trailing-spaces: false
max-one-sentence-per-line: false
customRules:
- "markdownlint-rule-max-one-sentence-per-line"
Expand Down
90 changes: 85 additions & 5 deletions pages/spicedb/getting-started/installing-zed.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ sudo chmod 644 /etc/apt/sources.list.d/authzed.list # helps tools such as comma

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

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

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


## Reference: `zed`

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



## Reference: `zed mcp`

MCP (Model Context Protocol) server commands.

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.

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.

### Options Inherited From Parent Flags

```
--certificate-path string path to certificate authority used to verify secure connections
--endpoint string spicedb gRPC API endpoint
--hostname-override string override the hostname used in the connection to the endpoint
--insecure connect over a plaintext connection
--log-format string format of logs ("auto", "console", "json") (default "auto")
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
--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
--max-retries uint maximum number of sequential retries to attempt when a request fails (default 10)
--no-verify-ca do not attempt to verify the server's certificate chain and host name
--permissions-system string permissions system to query
--proxy string specify a SOCKS5 proxy address
--request-id string optional id to send along with SpiceDB requests for tracing
--skip-version-check if true, no version check is performed against the server
--token string token used to authenticate to SpiceDB
```

### Children commands

- [zed mcp experimental-run](#reference-zed-mcp-experimental-run) - Run the Experimental MCP server


## Reference: `zed mcp experimental-run`

Run the Experimental MCP server

```
zed mcp experimental-run [flags]
```

### Options

```
-p, --port int port for the HTTP streaming server (default 9999)
```

### Options Inherited From Parent Flags

```
--certificate-path string path to certificate authority used to verify secure connections
--endpoint string spicedb gRPC API endpoint
--hostname-override string override the hostname used in the connection to the endpoint
--insecure connect over a plaintext connection
--log-format string format of logs ("auto", "console", "json") (default "auto")
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
--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
--max-retries uint maximum number of sequential retries to attempt when a request fails (default 10)
--no-verify-ca do not attempt to verify the server's certificate chain and host name
--permissions-system string permissions system to query
--proxy string specify a SOCKS5 proxy address
--request-id string optional id to send along with SpiceDB requests for tracing
--skip-version-check if true, no version check is performed against the server
--token string token used to authenticate to SpiceDB
```



## Reference: `zed permission`

Query the permissions in a permissions system
Expand All @@ -682,16 +751,16 @@ Query the permissions in a permissions system

### Children commands

- [zed permission bulk](#reference-zed-permission-bulk) - Check a permissions in bulk exists for a resource-subject pairs
- [zed permission bulk](#reference-zed-permission-bulk) - Check permissions in bulk exist for resource-subject pairs
- [zed permission check](#reference-zed-permission-check) - Check that a permission exists for a subject
- [zed permission expand](#reference-zed-permission-expand) - Expand the structure of a permission
- [zed permission lookup-resources](#reference-zed-permission-lookup-resources) - Enumerates resources of a given type for which the subject has permission
- [zed permission lookup-resources](#reference-zed-permission-lookup-resources) - Enumerates the resources of a given type for which the subject has permission
- [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


## Reference: `zed permission bulk`

Check a permissions in bulk exists for a resource-subject pairs
Check permissions in bulk exist for resource-subject pairs

```
zed permission bulk <resource:id#permission@subject:id> <resource:id#permission@subject:id> ... [flags]
Expand Down Expand Up @@ -816,7 +885,7 @@ zed permission expand <permission> <resource:id> [flags]

## Reference: `zed permission lookup-resources`

Enumerates resources of a given type for which the subject has permission
Enumerates the resources of a given type for which the subject has permission

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

### Examples

```

Write from a file:
zed schema write schema.zed
Write from stdin:
cat schema.zed | zed schema write

```

### Options

```
Expand Down