-
Notifications
You must be signed in to change notification settings - Fork 326
Add Zed AI docs #3035
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+174
−0
Merged
Add Zed AI docs #3035
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| --- | ||
| layout: article | ||
| title: Zed | ||
| description: Learn how you can use Zed with Appwrite by adding Appwrite MCP servers and installing Appwrite skills for AI-assisted development. | ||
| --- | ||
|
|
||
| {% section #quick-start-prompts step=1 title="Quick start prompts" %} | ||
|
|
||
| Get started quickly with these pre-built prompts for common Appwrite integrations: | ||
|
|
||
| {% cards %} | ||
| {% cards_item href="/docs/tooling/ai/quickstart-prompts/nextjs" title="Next.js" icon="icon-nextjs" %} | ||
| {% /cards_item %} | ||
| {% cards_item href="/docs/tooling/ai/quickstart-prompts/tanstack-start" title="TanStack Start" icon="web-icon-tanstack" %} | ||
| {% /cards_item %} | ||
| {% /cards %} | ||
|
|
||
| {% arrow_link href="/docs/tooling/ai/quickstart-prompts" %} | ||
| Browse all quick start prompts | ||
| {% /arrow_link %} | ||
|
|
||
| {% /section %} | ||
|
|
||
| {% section #step-2 step=2 title="Add MCP servers" %} | ||
|
|
||
| Connect Appwrite MCP servers to Zed for deeper integration with the Appwrite API and documentation. | ||
|
|
||
| Before you begin, ensure you have the following **pre-requisites** installed on your system: | ||
|
|
||
| {% tabs %} | ||
| {% tabsitem #api-server-prerequisites title="API server" %} | ||
|
|
||
| [uv](https://docs.astral.sh/uv/getting-started/installation/) must be installed on your system. | ||
|
|
||
| {% /tabsitem %} | ||
|
|
||
| {% tabsitem #docs-server-prerequisites title="Docs server" %} | ||
|
|
||
| No additional prerequisites. The docs server runs as a remote HTTP endpoint. | ||
|
|
||
| {% /tabsitem %} | ||
| {% /tabs %} | ||
|
|
||
| In Zed, open the **Command Palette** (press `CMD + Shift + P` on MacOS or `CTRL + Shift + P` on Linux), run the `agent: add context server` action, and choose which MCP server you want to configure: | ||
|
|
||
| {% tabs %} | ||
| {% tabsitem #api-only title="API server" %} | ||
|
|
||
| In the **Local** tab, update the JSON configuration to include the API server: | ||
|
|
||
| ```json | ||
| { | ||
| "appwrite-api": { | ||
| "command": "uvx", | ||
| "args": [ | ||
| "mcp-server-appwrite" | ||
| ], | ||
| "env": { | ||
| "APPWRITE_PROJECT_ID": "your-project-id", | ||
| "APPWRITE_API_KEY": "your-api-key", | ||
| "APPWRITE_ENDPOINT": "https://<REGION>.cloud.appwrite.io/v1" | ||
| } | ||
| } | ||
| } | ||
|
|
||
| ``` | ||
|
|
||
| **Configuration:** | ||
|
|
||
| - Replace `your-project-id` with your actual Appwrite project ID | ||
| - Replace `your-api-key` with your Appwrite API key | ||
| - Replace `<REGION>` with your Appwrite Cloud region (e.g., `nyc`, `fra`) | ||
|
|
||
| {% /tabsitem %} | ||
|
|
||
| {% tabsitem #docs-only title="Docs server" %} | ||
|
|
||
| In the **Remote** tab, update the JSON configuration to include the docs server: | ||
|
|
||
| ```json | ||
| { | ||
| "appwrite-docs": { | ||
| "url": "https://mcp-for-docs.appwrite.io" | ||
| } | ||
| } | ||
|
|
||
| ``` | ||
|
|
||
| {% /tabsitem %} | ||
| {% /tabs %} | ||
|
|
||
| Click **Add Server** after adding each configuration. You can also review the configured servers in the **Model Context Protocol (MCP) Servers** section of Zed's Agent settings. | ||
|
|
||
| {% /section %} | ||
|
|
||
| {% section #step-3 step=3 title="Install Appwrite skills" %} | ||
|
|
||
| Install Appwrite skills to give Zed's agent SDK-specific knowledge about Appwrite. | ||
|
|
||
| Run the following command in your project directory: | ||
|
|
||
| ```bash | ||
| npx skills add appwrite/agent-skills | ||
| ``` | ||
|
|
||
| When prompted: | ||
|
|
||
| 1. Select the Appwrite skills that match the SDKs you use in your project. | ||
| 2. Select **Zed** as one of the AI tools that should use the installed skills. | ||
| 3. Choose whether to install the skills at the project level or globally. | ||
| 4. Select **symlink** as the installation method. | ||
|
|
||
| Zed loads skills from `~/.agents/skills/` for global installs and `<worktree>/.agents/skills/` for project-local installs. Each skill must be a direct child of the `skills` folder and include a `SKILL.md` file. | ||
|
|
||
| {% /section %} | ||
|
|
||
| {% section #step-4 step=4 title="Test the integration" %} | ||
|
|
||
| Open the Agent panel in Zed and test your MCP integrations. You can try out the following example prompts based on the MCP server you have configured: | ||
|
|
||
| {% tabs %} | ||
| {% tabsitem #test-api title="API server" %} | ||
|
|
||
| **Example prompts:** | ||
|
|
||
| - `Create a new user in my Appwrite project` | ||
| - `List all databases in my project` | ||
| - `Show me the tables in my database` | ||
| - `Create a new row in my table` | ||
| - `Delete a specific user by ID` | ||
|
|
||
| {% /tabsitem %} | ||
|
|
||
| {% tabsitem #test-docs title="Docs server" %} | ||
|
|
||
| **Example prompts:** | ||
|
|
||
| - `How do I set up real-time subscriptions in Appwrite?` | ||
| - `Show me how to authenticate users with OAuth` | ||
| - `What are the best practices for database queries?` | ||
| - `How do I implement file uploads with Appwrite Storage?` | ||
| - `Show me an example of using Appwrite Functions` | ||
|
|
||
| {% /tabsitem %} | ||
|
|
||
| {% /tabs %} | ||
|
|
||
|  | ||
|
|
||
| {% /section %} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.