Skip to content

Commit 1ddd815

Browse files
committed
Add MCP docs section
1 parent 61d40e8 commit 1ddd815

File tree

6 files changed

+619
-0
lines changed

6 files changed

+619
-0
lines changed

pages/_meta.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,9 @@
1414
"best-practices": {
1515
"title": "Best Practices",
1616
"type": "page"
17+
},
18+
"mcp": {
19+
"title": "MCP",
20+
"type": "page"
1721
}
1822
}

pages/mcp/_meta.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"index": {
3+
"title": "Model Context Protocol",
4+
"theme": {
5+
"breadcrumb": true,
6+
"sidebar": true,
7+
"toc": true,
8+
"pagination": false
9+
}
10+
},
11+
"authzed": "AuthZed MCP",
12+
"mcp-reference": {
13+
"title": "MCP Reference Implementations",
14+
"href": "https://github.com/authzed/mcp-server-reference"
15+
}
16+
}

pages/mcp/authzed/_meta.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"authzed-mcp-server": {
3+
"title": "AuthZed MCP Server"
4+
},
5+
"spicedb-dev-mcp-server": {
6+
"title": "SpiceDB Dev MCP Server"
7+
}
8+
}
Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
# AuthZed MCP Server
2+
3+
Connect your AI tools to AuthZed and SpiceDB documentation using the Model Context Protocol (MCP). Access comprehensive documentation, API references, and authorization pattern examples directly from your AI assistant.
4+
5+
## Overview
6+
7+
AuthZed MCP Server is a remote MCP server available at `https://mcp.authzed.com`. It provides tools with searchable access to SpiceDB and AuthZed resources, enabling you to learn about authorization systems, explore APIs, and find implementation examples without leaving your LLM chat or development environment.
8+
9+
### What You Can Do
10+
11+
- **Search Documentation**: Find relevant information across all SpiceDB and AuthZed documentation pages
12+
- **Discover APIs**: Explore all API methods and message types with detailed specifications
13+
- **Find Examples**: Browse authorization pattern examples including RBAC, document sharing, and more with SpiceDB schemas included
14+
- **Learn Concepts**: Access comprehensive guides on schema design, relationships, and permissions
15+
16+
## Supported Clients
17+
18+
Works with any MCP-compatible AI client including:
19+
20+
- ChatGPT
21+
- Claude Code and Claude Desktop
22+
- Cursor
23+
- VS Code with Copilot
24+
- Windsurf
25+
- Zed Editor
26+
- Other MCP-compatible tools
27+
28+
## Setup
29+
30+
### ChatGPT
31+
32+
Available on Pro and Plus accounts.
33+
34+
1. Enable **Developer mode** in Settings
35+
2. Create connector:
36+
- **Name**: AuthZed
37+
- **MCP server URL**: `https://mcp.authzed.com`
38+
- **Authentication**: None
39+
40+
### Claude Code
41+
42+
```bash
43+
claude mcp add --transport http authzed https://mcp.authzed.com
44+
45+
# Start Claude Code
46+
claude
47+
```
48+
49+
### Claude Desktop
50+
51+
Available on Pro, Max, Team, and Enterprise plans.
52+
53+
1. Open **Settings****Connectors**
54+
2. Select **Add custom connector**
55+
3. Configure:
56+
- **Name**: AuthZed
57+
- **URL**: `https://mcp.authzed.com`
58+
59+
### Cursor
60+
61+
Add to `.cursor/mcp.json`:
62+
63+
```json
64+
{
65+
"mcpServers": {
66+
"authzed": {
67+
"url": "https://mcp.authzed.com"
68+
}
69+
}
70+
}
71+
```
72+
73+
### VS Code with Copilot
74+
75+
1. Command Palette → **MCP: Add Server**
76+
2. Select **HTTP**
77+
3. Configure:
78+
- **URL**: `https://mcp.authzed.com`
79+
- **Name**: AuthZed
80+
81+
### Windsurf
82+
83+
Add to `mcp_config.json`:
84+
85+
```json
86+
{
87+
"mcpServers": {
88+
"authzed": {
89+
"serverUrl": "https://mcp.authzed.com"
90+
}
91+
}
92+
}
93+
```
94+
95+
## Using the Server
96+
97+
### Learning SpiceDB
98+
99+
Ask natural language questions about SpiceDB concepts:
100+
101+
- "How do I define a relationship in SpiceDB?"
102+
- "What are the best practices for schema design?"
103+
- "Explain how Zedtokens work"
104+
- "What is the difference between relations and permissions?"
105+
106+
### Exploring the API
107+
108+
Discover API methods and understand their usage:
109+
110+
- "How do I check permissions using the API?"
111+
- "Show me all read-related API methods"
112+
- "What parameters does WriteRelationships accept?"
113+
- "Explain the CheckPermission response structure"
114+
115+
### Finding Examples
116+
117+
Search for authorization patterns and implementation examples:
118+
119+
- "Show me docs sharing examples"
120+
- "How do I implement role-based access control?"
121+
- "Example schema with caveats"
122+
- "Show me the Google IAM pattern in SpiceDB schema language"
123+
124+
### Browsing Resources
125+
126+
List and explore available resources:
127+
128+
- "What example schemas are available?"
129+
- "List all API methods"
130+
- "Show me documentation about caveats"
131+
132+
### Getting Help
133+
134+
Get information about using the server effectively:
135+
136+
- "How does the AuthZed MCP server work?"
137+
- "What can I do with this server?"
138+
139+
Use `system_instructions` to understand server capabilities and usage patterns.
140+
141+
### Providing Feedback
142+
143+
Share your experience to help improve the server:
144+
145+
- "I'd like to provide feedback about the documentation"
146+
- "The search results weren't helpful for my query"
147+
- "I have a suggestion for the MCP server"
148+
149+
The assistant uses `send_feedback` to guide you through submitting structured feedback about the MCP server, documentation quality, tool effectiveness, or your general experience.
150+
151+
## Available Tools
152+
153+
**`search_docs`** - Search documentation pages by content, URL, or path
154+
155+
**`search_api`** - Search API methods and message types with type filtering
156+
157+
**`search_examples`** - Search authorization pattern examples by title or description
158+
159+
**`list_resources`** - List all documentation pages, API methods, messages, and examples
160+
161+
**`send_feedback`** - Send the AuthZed team feedback about the MCP server
162+
163+
## Prompts
164+
165+
**`system_instructions`** - View the system instructions for the AuthZed MCP server, including how it works and how to use it effectively.
166+
167+
**`explain_concept`** - Ask questions about SpiceDB concepts, AuthZed features, schema design, API usage, best practices, or troubleshooting. Returns authoritative answers with documentation references and examples.
168+
169+
**`send_feedback`** - Provide feedback about the AuthZed MCP server, documentation, tools, or your general experience. The prompt guides you through submitting structured feedback.
170+
171+
## Available Resources
172+
173+
- **Documentation**: Doc pages are accessible with `docs://` URIs
174+
- **API Methods**: API methods are accessible with `api://methods/` URIs
175+
- **API Messages**: Message types are accessible `api://messages/` URIs
176+
- **Examples**: Schema examples are accessible with `examples://schemas/` URIs
177+
178+
## Security
179+
180+
### Public Information Only
181+
182+
The server provides access to:
183+
- Public SpiceDB and AuthZed documentation
184+
- Publicly available API specifications
185+
- Open source schema examples
186+
187+
The server does **not** access:
188+
- Your AuthZed or SpiceDB instances
189+
- Your authorization data
190+
- Your application schemas
191+
- Any private information
192+
193+
### Verify the Endpoint
194+
195+
Always confirm you're connecting to:
196+
```
197+
https://mcp.authzed.com
198+
```
199+
200+
When using third-party marketplaces, verify the domain name before connecting.
201+
202+
## Troubleshooting
203+
204+
**Connection issues**: Verify the URL is `https://mcp.authzed.com` and your client supports remote HTTP MCP servers
205+
206+
**No search results**: Try broader terms, check spelling, or use `list_resources` to see available content
207+

0 commit comments

Comments
 (0)