From b767928971a2140ac4f964b0e75ab97019bbde84 Mon Sep 17 00:00:00 2001 From: adityaoberai Date: Sat, 11 Jul 2026 00:31:17 +0530 Subject: [PATCH] Add remote mcp docs --- .../ai/agents/antigravity/+page.markdoc | 36 ++------- .../ai/agents/claude-code/+page.markdoc | 24 ++---- .../tooling/ai/agents/codex/+page.markdoc | 34 ++------- .../tooling/ai/agents/cursor/+page.markdoc | 40 +--------- .../tooling/ai/agents/opencode/+page.markdoc | 44 ++--------- .../tooling/ai/agents/vscode/+page.markdoc | 37 ++------- .../tooling/ai/agents/windsurf/+page.markdoc | 36 +-------- .../docs/tooling/ai/agents/zed/+page.markdoc | 36 +-------- .../tooling/ai/mcp-servers/api/+page.markdoc | 75 +++++++++++++------ .../vibe-coding/claude-desktop/+page.markdoc | 42 +++-------- .../ai/vibe-coding/emergent/+page.markdoc | 20 ++--- .../ai/vibe-coding/zenflow/+page.markdoc | 33 +------- .../integrations/mcp-claude/+page.markdoc | 43 +++++------ .../integrations/mcp-cursor/+page.markdoc | 37 +++------ .../integrations/mcp-windsurf/+page.markdoc | 35 +++------ 15 files changed, 156 insertions(+), 416 deletions(-) diff --git a/src/routes/docs/tooling/ai/agents/antigravity/+page.markdoc b/src/routes/docs/tooling/ai/agents/antigravity/+page.markdoc index 3c32208631a..b435cd62e04 100644 --- a/src/routes/docs/tooling/ai/agents/antigravity/+page.markdoc +++ b/src/routes/docs/tooling/ai/agents/antigravity/+page.markdoc @@ -25,21 +25,7 @@ Browse all quick start prompts Connect Appwrite MCP servers to Antigravity 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" %} - -[Node.js](https://nodejs.org/en/download) and npm must be installed on your system. - -{% /tabsitem %} -{% /tabs %} +Before you begin, ensure you have [Node.js](https://nodejs.org/en/download) and npm installed on your system. Antigravity connects to the remote MCP servers through the `mcp-remote` package. To add the Appwrite MCP server, open Antigravity and go to the drop-down (...) menu in the Agent window . From there, navigate to Manage MCP Servers in the MCP Store, and then click View raw config in the main panel to add your custom MCP server. @@ -52,26 +38,18 @@ Update the `mcp_config.json` file to include the API server: { "mcpServers": { "appwrite-api": { - "command": "uvx", + "command": "npx", "args": [ - "mcp-server-appwrite" - ], - "env": { - "APPWRITE_PROJECT_ID": "your-project-id", - "APPWRITE_API_KEY": "your-api-key", - "APPWRITE_ENDPOINT": "https://.cloud.appwrite.io/v1" - } + "mcp-remote", + "https://mcp.appwrite.io/mcp" + ] } } } ``` -**Configuration:** - -- Replace `your-project-id` with your actual Appwrite project ID -- Replace `your-api-key` with your Appwrite API key -- Replace `` with your Appwrite Cloud region (e.g., `nyc`, `fra`) +The API server uses OAuth for authentication. When Antigravity first connects to the server, your browser opens so you can sign in to your Appwrite account and authorize access. {% /tabsitem %} @@ -86,7 +64,7 @@ Update the `mcp_config.json` file to include the docs server: "command": "npx", "args": [ "mcp-remote", - "" + "https://mcp-for-docs.appwrite.io" ] } } diff --git a/src/routes/docs/tooling/ai/agents/claude-code/+page.markdoc b/src/routes/docs/tooling/ai/agents/claude-code/+page.markdoc index e19e48de687..35322e01675 100644 --- a/src/routes/docs/tooling/ai/agents/claude-code/+page.markdoc +++ b/src/routes/docs/tooling/ai/agents/claude-code/+page.markdoc @@ -55,23 +55,7 @@ Browse all quick start prompts If you installed the Appwrite plugin in [Step 1](#install-plugin), MCP servers are already configured and you can skip to [Step 4](#step-4). -Connect Appwrite MCP servers to Claude Code 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" %} - -[Node.js](https://nodejs.org/en/download) and npm must be installed on your system. - -{% /tabsitem %} -{% /tabs %} +Connect Appwrite MCP servers to Claude Code for deeper integration with the Appwrite API and documentation. Both servers are remote HTTP servers, so there are no additional pre-requisites to install. Run the following commands in your terminal to add the MCP servers: @@ -79,16 +63,18 @@ Run the following commands in your terminal to add the MCP servers: {% tabsitem #api-only title="API server" %} ```bash -claude mcp add-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://.cloud.appwrite.io/v1"}}' +claude mcp add --transport http appwrite-api https://mcp.appwrite.io/mcp ``` +The API server uses OAuth for authentication. Run `/mcp` in Claude Code, select **appwrite-api**, and choose **Authenticate**. Your browser opens so you can sign in to your Appwrite account and authorize access. + {% /tabsitem %} {% tabsitem #docs-only title="Docs server" %} ```bash -claude mcp add appwrite-docs -t http +claude mcp add --transport http appwrite-docs https://mcp-for-docs.appwrite.io ``` diff --git a/src/routes/docs/tooling/ai/agents/codex/+page.markdoc b/src/routes/docs/tooling/ai/agents/codex/+page.markdoc index d3899251ef1..debe0411782 100644 --- a/src/routes/docs/tooling/ai/agents/codex/+page.markdoc +++ b/src/routes/docs/tooling/ai/agents/codex/+page.markdoc @@ -22,7 +22,7 @@ Then run `codex` and open the plugins menu to install the Appwrite plugin: Once installed, the language and deployment skills load automatically based on your task, and the `appwrite-docs` MCP server is registered for documentation lookups. -The Appwrite API MCP server isn't bundled in the plugin: it needs your endpoint, project ID, and API key, and Codex plugins don't currently expose a way to prompt for per-install configuration in the CLI. Add it manually in [Step 3](#step-3). +The Appwrite API MCP server isn't bundled in the plugin. Add it manually in [Step 3](#step-3). {% info title="Prefer manual setup?" %} @@ -53,23 +53,7 @@ Browse all quick start prompts If you installed the Appwrite plugin in [Step 1](#install-plugin), the docs MCP server is already configured and you can skip to [Step 4](#step-4). -Connect Appwrite MCP servers to Codex 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 %} +Connect Appwrite MCP servers to Codex for deeper integration with the Appwrite API and documentation. Both servers are remote HTTP servers, so there are no additional pre-requisites to install. Run the following commands in your terminal to add the MCP servers: @@ -77,18 +61,14 @@ Run the following commands in your terminal to add the MCP servers: {% tabsitem #api-only title="API server" %} ```bash -codex mcp add appwrite-api \ - --env APPWRITE_PROJECT_ID=your-project-id \ - --env APPWRITE_API_KEY=your-api-key \ - --env APPWRITE_ENDPOINT=https://.cloud.appwrite.io/v1 \ - -- uvx mcp-server-appwrite +codex mcp add appwrite-api --url https://mcp.appwrite.io/mcp ``` -**Configuration:** +The API server uses OAuth for authentication. In case Codex does not automatically prompt you to login, run the following command to sign in to your Appwrite account and authorize access: -- Replace `your-project-id` with your actual Appwrite project ID -- Replace `your-api-key` with your Appwrite API key -- Replace `` with your Appwrite Cloud region (e.g., `nyc`, `fra`) +```bash +codex mcp login appwrite-api +``` {% /tabsitem %} diff --git a/src/routes/docs/tooling/ai/agents/cursor/+page.markdoc b/src/routes/docs/tooling/ai/agents/cursor/+page.markdoc index 158212065cb..209a7f5ce41 100644 --- a/src/routes/docs/tooling/ai/agents/cursor/+page.markdoc +++ b/src/routes/docs/tooling/ai/agents/cursor/+page.markdoc @@ -46,23 +46,7 @@ Browse all quick start prompts If you installed the Appwrite plugin in [Step 1](#install-plugin), MCP servers are already configured and you can skip to [Step 4](#step-4). -Connect Appwrite MCP servers to Cursor 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" %} - -[Node.js](https://nodejs.org/en/download) and npm must be installed on your system. - -{% /tabsitem %} -{% /tabs %} +Connect Appwrite MCP servers to Cursor for deeper integration with the Appwrite API and documentation. Both servers are remote HTTP servers, so there are no additional pre-requisites to install. Open the **Cursor Settings** page, head to the **MCP** tab, and click on the **Add new global MCP server** button. This will open an `mcp.json` file in your editor. @@ -77,26 +61,14 @@ Update the `mcp.json` file to include the API server: { "mcpServers": { "appwrite-api": { - "command": "uvx", - "args": [ - "mcp-server-appwrite" - ], - "env": { - "APPWRITE_API_KEY": "your-api-key", - "APPWRITE_PROJECT_ID": "your-project-id", - "APPWRITE_ENDPOINT": "https://.cloud.appwrite.io/v1" - } + "url": "https://mcp.appwrite.io/mcp" } } } ``` -**Configuration:** - -- Replace `your-project-id` with your actual Appwrite project ID -- Replace `your-api-key` with your Appwrite API key -- Replace `` with your Appwrite Cloud region (e.g., `nyc`, `fra`) +The API server uses OAuth for authentication. After you save the file, click **Needs login** next to the server in the MCP settings. Your browser opens so you can sign in to your Appwrite account and authorize access. {% /tabsitem %} @@ -108,11 +80,7 @@ Update the `mcp.json` file to include the docs server: { "mcpServers": { "appwrite-docs": { - "command": "npx", - "args": [ - "mcp-remote", - "" - ] + "url": "https://mcp-for-docs.appwrite.io" } } } diff --git a/src/routes/docs/tooling/ai/agents/opencode/+page.markdoc b/src/routes/docs/tooling/ai/agents/opencode/+page.markdoc index ab5cf9bfddf..2c613f36723 100644 --- a/src/routes/docs/tooling/ai/agents/opencode/+page.markdoc +++ b/src/routes/docs/tooling/ai/agents/opencode/+page.markdoc @@ -23,23 +23,7 @@ Browse all quick start prompts {% section #step-2 step=2 title="Add MCP servers" %} -Connect Appwrite MCP servers to OpenCode 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" %} - -[Node.js](https://nodejs.org/en/download) and npm must be installed on your system. - -{% /tabsitem %} -{% /tabs %} +Connect Appwrite MCP servers to OpenCode for deeper integration with the Appwrite API and documentation. Both servers are remote HTTP servers, so there are no additional pre-requisites to install. Use the following configuration in your `opencode.json` file to use the Appwrite MCP servers. @@ -48,31 +32,19 @@ Use the following configuration in your `opencode.json` file to use the Appwrite ```json { - "$schema": "", + "$schema": "https://opencode.ai/config.json", "mcp": { - "appwrite": { - "type": "local", - "command": [ - "uvx", - "mcp-server-appwrite" - ], + "appwrite-api": { + "type": "remote", "enabled": true, - "environment": { - "APPWRITE_PROJECT_ID": "your-project-id", - "APPWRITE_API_KEY": "your-api-key", - "APPWRITE_ENDPOINT": "https://.cloud.appwrite.io/v1" - } + "url": "https://mcp.appwrite.io/mcp" } } } ``` -**Configuration:** - -- Replace `your-project-id` with your actual Appwrite project ID -- Replace `your-api-key` with your Appwrite API key -- Replace `` with your Appwrite Cloud region (e.g., `nyc`, `fra`) +The API server uses OAuth for authentication. When OpenCode first connects to the server, complete the sign-in flow in your browser to sign in to your Appwrite account and authorize access. {% /tabsitem %} @@ -80,12 +52,12 @@ Use the following configuration in your `opencode.json` file to use the Appwrite ```json { - "$schema": "", + "$schema": "https://opencode.ai/config.json", "mcp": { "appwrite-docs": { "type": "remote", "enabled": true, - "url": "" + "url": "https://mcp-for-docs.appwrite.io" } } } diff --git a/src/routes/docs/tooling/ai/agents/vscode/+page.markdoc b/src/routes/docs/tooling/ai/agents/vscode/+page.markdoc index 551f7939f7c..884be61fc88 100644 --- a/src/routes/docs/tooling/ai/agents/vscode/+page.markdoc +++ b/src/routes/docs/tooling/ai/agents/vscode/+page.markdoc @@ -23,23 +23,7 @@ Browse all quick start prompts {% section #add-mcp-servers step=2 title="Add MCP servers" %} -Connect Appwrite MCP servers to VS Code 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" %} - -[Node.js](https://nodejs.org/en/download) and npm must be installed on your system. - -{% /tabsitem %} -{% /tabs %} +Connect Appwrite MCP servers to VS Code for deeper integration with the Appwrite API and documentation. Both servers are remote HTTP servers, so there are no additional pre-requisites to install. In VS Code, open the **Command Palette** (press `CTRL + Shift + P` on Windows or `CMD + Shift + P` on MacOS) and run the `MCP: Open User Configuration` command. @@ -54,26 +38,15 @@ Update the `mcp.json` file to include the API server: { "servers": { "appwrite-api": { - "command": "uvx", - "args": [ - "mcp-server-appwrite" - ], - "env": { - "APPWRITE_PROJECT_ID": "your-project-id", - "APPWRITE_API_KEY": "your-api-key", - "APPWRITE_ENDPOINT": "https://.cloud.appwrite.io/v1" - } + "url": "https://mcp.appwrite.io/mcp", + "type": "http" } } } ``` -**Configuration:** - -- Replace `your-project-id` with your actual Appwrite project ID -- Replace `your-api-key` with your Appwrite API key -- Replace `` with your Appwrite Cloud region (e.g., `nyc`, `fra`) +The API server uses OAuth for authentication. When the server starts, VS Code prompts you to authenticate, and your browser opens so you can sign in to your Appwrite account and authorize access. {% /tabsitem %} @@ -85,7 +58,7 @@ Update the `mcp.json` file to include the docs server: { "servers": { "appwrite-docs": { - "url": "", + "url": "https://mcp-for-docs.appwrite.io", "type": "http" } } diff --git a/src/routes/docs/tooling/ai/agents/windsurf/+page.markdoc b/src/routes/docs/tooling/ai/agents/windsurf/+page.markdoc index 8d22ff02593..0ea613dd1fa 100644 --- a/src/routes/docs/tooling/ai/agents/windsurf/+page.markdoc +++ b/src/routes/docs/tooling/ai/agents/windsurf/+page.markdoc @@ -23,23 +23,7 @@ Browse all quick start prompts {% section #add-mcp-servers step=2 title="Add MCP servers" %} -Connect Appwrite MCP servers to Windsurf 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" %} - -[Node.js](https://nodejs.org/en/download) and npm must be installed on your system. - -{% /tabsitem %} -{% /tabs %} +Connect Appwrite MCP servers to Windsurf for deeper integration with the Appwrite API and documentation. Both servers are remote HTTP servers, so there are no additional pre-requisites to install. Open the **Windsurf Settings** page, head to the **Cascade** tab, find the **Model Context Protocol (MCP) Servers** section, and click on the **View raw config** button. @@ -56,26 +40,14 @@ Update the `mcp_config.json` file to include the API server: { "mcpServers": { "appwrite-api": { - "command": "uvx", - "args": [ - "mcp-server-appwrite" - ], - "env": { - "APPWRITE_PROJECT_ID": "your-project-id", - "APPWRITE_API_KEY": "your-api-key", - "APPWRITE_ENDPOINT": "https://.cloud.appwrite.io/v1" - } + "serverUrl": "https://mcp.appwrite.io/mcp" } } } ``` -**Configuration:** - -- Replace `your-project-id` with your actual Appwrite project ID -- Replace `your-api-key` with your Appwrite API key -- Replace `` with your Appwrite Cloud region (e.g., `nyc`, `fra`) +The API server uses OAuth for authentication. When Windsurf first connects to the server, you are prompted to log in, and your browser opens so you can sign in to your Appwrite account and authorize access. {% /tabsitem %} @@ -87,7 +59,7 @@ Update the `mcp_config.json` file to include the docs server: { "mcpServers": { "appwrite-docs": { - "serverUrl": "" + "serverUrl": "https://mcp-for-docs.appwrite.io" } } } diff --git a/src/routes/docs/tooling/ai/agents/zed/+page.markdoc b/src/routes/docs/tooling/ai/agents/zed/+page.markdoc index d5a50cd532a..2d60ac47f79 100644 --- a/src/routes/docs/tooling/ai/agents/zed/+page.markdoc +++ b/src/routes/docs/tooling/ai/agents/zed/+page.markdoc @@ -23,53 +23,25 @@ Browse all quick start prompts {% 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 %} +Connect Appwrite MCP servers to Zed for deeper integration with the Appwrite API and documentation. Both servers are remote HTTP servers, so there are no additional pre-requisites to install. 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: +In the **Remote** 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://.cloud.appwrite.io/v1" - } + "url": "https://mcp.appwrite.io/mcp" } } ``` -**Configuration:** - -- Replace `your-project-id` with your actual Appwrite project ID -- Replace `your-api-key` with your Appwrite API key -- Replace `` with your Appwrite Cloud region (e.g., `nyc`, `fra`) +The API server uses OAuth for authentication. When Zed first connects to the server, your browser opens so you can sign in to your Appwrite account and authorize access. {% /tabsitem %} diff --git a/src/routes/docs/tooling/ai/mcp-servers/api/+page.markdoc b/src/routes/docs/tooling/ai/mcp-servers/api/+page.markdoc index 15382a615f0..236fce4481a 100644 --- a/src/routes/docs/tooling/ai/mcp-servers/api/+page.markdoc +++ b/src/routes/docs/tooling/ai/mcp-servers/api/+page.markdoc @@ -12,12 +12,40 @@ Here are some of the key benefits of using the MCP server: - **Real-time data access**: Allows LLMs to fetch and manipulate live data from your Appwrite instance - **Simplified workflows**: Facilitates complex operations through simple natural language prompts - **Automatic service discovery**: All supported Appwrite services are automatically registered, no configuration needed +- **No local setup**: Runs as a hosted HTTP service, so there is nothing to install or keep updated + +# Connection details {% #connection-details %} + +The MCP server for Appwrite API is a remote server that uses the HTTP transport. It is available at the following URL: + +``` +https://mcp.appwrite.io/mcp +``` + +The server uses OAuth for authentication. When you add the server to an AI tool and connect for the first time, your browser opens so you can sign in to your Appwrite account and authorize access. You don't need to create or manage API keys. # Pre-requisites {% #pre-requisites %} -## Appwrite API key +Before connecting to the MCP server, you must [set up an Appwrite project](https://cloud.appwrite.io) on Appwrite Cloud. No additional software needs to be installed on your system. + +# Installation {% #installation %} + +{% partial file="mcp-add-ides-tools.md" /%} + +## How it works + +The MCP server starts in a compact workflow where only two MCP tools are exposed to the model: + +- `appwrite_search_tools` - Searches the full Appwrite tool catalog at runtime +- `appwrite_call_tool` - Calls a specific Appwrite tool by name + +The full Appwrite tool catalog stays internal and is searched at runtime, using less of the model's context. -Before launching the MCP server, you must [set up an Appwrite project](https://cloud.appwrite.io) and create an **API key** with the necessary scopes enabled. +# Self-hosted Appwrite {% #self-hosted %} + +The hosted MCP server authenticates against Appwrite Cloud. If you are running a [self-hosted Appwrite instance](/docs/advanced/self-hosting), use the local MCP server instead. It runs on your machine over the stdio transport and connects to your instance with an API key. + +First, create an **API key** with the necessary scopes enabled in your Appwrite project. {% only_light %} ![Appwrite API key](/images/docs/mcp/appwrite/appwrite-api-secret.avif) @@ -26,11 +54,9 @@ Before launching the MCP server, you must [set up an Appwrite project](https://c ![Appwrite API key](/images/docs/mcp/appwrite/dark/appwrite-api-secret.avif) {% /only_dark %} -Ensure you save the **API key** along with the **project ID**, **region** and **endpoint URL** from the Settings page of your project as you'll need them later. - -## Install uv +Ensure you save the **API key** along with the **project ID** and **endpoint URL** from the Settings page of your project. -Install [uv](https://docs.astral.sh/uv/getting-started/installation/) on your system with: +Next, install [uv](https://docs.astral.sh/uv/getting-started/installation/) on your system with: {% tabs %} {% tabsitem #uv-linux-macos title="Linux and MacOS" %} @@ -45,29 +71,32 @@ curl -LsSf https://astral.sh/uv/install.sh | sh ```powershell powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" -``` +``` {% /tabsitem %} {% /tabs %} -You can verify the installation by running the following command in your terminal: - -```bash -uv +Then, add the local MCP server to your AI tool's MCP configuration: + +```json +{ + "mcpServers": { + "appwrite-api": { + "command": "uvx", + "args": [ + "mcp-server-appwrite" + ], + "env": { + "APPWRITE_PROJECT_ID": "your-project-id", + "APPWRITE_API_KEY": "your-api-key", + "APPWRITE_ENDPOINT": "https://your-appwrite-domain/v1" + } + } + } +} ``` -# Installation {% #installation %} - -{% partial file="mcp-add-ides-tools.md" /%} - -## How it works - -The MCP server starts in a compact workflow where only two MCP tools are exposed to the model: - -- `appwrite_search_tools` - Searches the full Appwrite tool catalog at runtime -- `appwrite_call_tool` - Calls a specific Appwrite tool by name - -The full Appwrite tool catalog stays internal and is searched at runtime, using less of the model's context. +Replace `your-project-id` and `your-api-key` with the values from your project, and point `APPWRITE_ENDPOINT` to your instance's API endpoint. # Usage {% #usage %} diff --git a/src/routes/docs/tooling/ai/vibe-coding/claude-desktop/+page.markdoc b/src/routes/docs/tooling/ai/vibe-coding/claude-desktop/+page.markdoc index 6f300d9618c..da306d28f72 100644 --- a/src/routes/docs/tooling/ai/vibe-coding/claude-desktop/+page.markdoc +++ b/src/routes/docs/tooling/ai/vibe-coding/claude-desktop/+page.markdoc @@ -25,21 +25,9 @@ Browse all quick start prompts Connect Appwrite MCP servers to Claude Desktop for deeper integration with the Appwrite API and documentation. -Before you begin, ensure you have the following **pre-requisites** installed on your system: +Before you begin, ensure you have [Node.js](https://nodejs.org/en/download) and npm 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" %} - -[Node.js](https://nodejs.org/en/download) and npm must be installed on your system. - -{% /tabsitem %} -{% /tabs %} +Unlike other IDEs, Claude Desktop only supports local (stdio) MCP servers and not remote servers. The `mcp-remote` package acts as a proxy to connect to the remote Appwrite MCP servers. In the Claude Desktop app, open the app's **Settings** page (press `CTRL + ,` on Windows or `CMD + ,` on MacOS) and head to the **Developer** tab. @@ -58,25 +46,17 @@ Add the API server to your configuration: { "mcpServers": { "appwrite-api": { - "command": "uvx", + "command": "npx", "args": [ - "mcp-server-appwrite" - ], - "env": { - "APPWRITE_PROJECT_ID": "your-project-id", - "APPWRITE_API_KEY": "your-api-key", - "APPWRITE_ENDPOINT": "https://.cloud.appwrite.io/v1" - } + "mcp-remote", + "https://mcp.appwrite.io/mcp" + ] } } } ``` -**Configuration:** - -- Replace `your-project-id` with your actual Appwrite project ID -- Replace `your-api-key` with your Appwrite API key -- Replace `` with your Appwrite Cloud region (e.g., `nyc`, `fra`) +The API server uses OAuth for authentication. When Claude Desktop first connects to the server, your browser opens so you can sign in to your Appwrite account and authorize access. {% /tabsitem %} @@ -98,10 +78,6 @@ Add the docs server to your configuration: } ``` -**Why do we use the `mcp-remote` package?** - -Unlike other IDEs, Claude Desktop only supports local (stdio) MCP servers and not remote servers. The `mcp-remote` package acts as a proxy to connect to the docs MCP server. - {% /tabsitem %} {% /tabs %} @@ -113,9 +89,9 @@ Restart the Claude Desktop app, click on the MCP tools button (at the bottom rig ![Appwrite MCP tools](/images/docs/mcp/claude-desktop/claude-mcp-tools.avif) -{% info title="uvx ENOENT error" %} +{% info title="npx ENOENT error" %} -In case you see a `uvx ENOENT` error, ensure that you either add `uvx` to the `PATH` environment variable on your system or use the full path to your `uvx` installation in the config file. +In case you see an `npx ENOENT` error, ensure that you either add `npx` to the `PATH` environment variable on your system or use the full path to your `npx` installation in the config file. {% /info %} diff --git a/src/routes/docs/tooling/ai/vibe-coding/emergent/+page.markdoc b/src/routes/docs/tooling/ai/vibe-coding/emergent/+page.markdoc index 54a749c8615..e0ab5673eea 100644 --- a/src/routes/docs/tooling/ai/vibe-coding/emergent/+page.markdoc +++ b/src/routes/docs/tooling/ai/vibe-coding/emergent/+page.markdoc @@ -21,26 +21,18 @@ To connect Appwrite MCP servers to Emergent: { "mcpServers": { "appwrite-api": { - "command": "uvx", + "command": "npx", "args": [ - "mcp-server-appwrite" - ], - "env": { - "APPWRITE_PROJECT_ID": "your-project-id", - "APPWRITE_API_KEY": "your-api-key", - "APPWRITE_ENDPOINT": "https://.cloud.appwrite.io/v1" - } + "mcp-remote", + "https://mcp.appwrite.io/mcp" + ] } } } ``` -**Configuration:** - -- Replace `your-project-id` with your actual Appwrite project ID -- Replace `your-api-key` with your Appwrite API key -- Replace `` with your Appwrite Cloud region (e.g., `fra`, `nyc`) +The API server uses OAuth for authentication. When Emergent first connects to the server, complete the sign-in flow in your browser to sign in to your Appwrite account and authorize access. {% /tabsitem %} @@ -53,7 +45,7 @@ To connect Appwrite MCP servers to Emergent: "command": "npx", "args": [ "mcp-remote", - "" + "https://mcp-for-docs.appwrite.io" ] } } diff --git a/src/routes/docs/tooling/ai/vibe-coding/zenflow/+page.markdoc b/src/routes/docs/tooling/ai/vibe-coding/zenflow/+page.markdoc index 228da1ef771..83afb712534 100644 --- a/src/routes/docs/tooling/ai/vibe-coding/zenflow/+page.markdoc +++ b/src/routes/docs/tooling/ai/vibe-coding/zenflow/+page.markdoc @@ -23,22 +23,7 @@ Browse all quick start prompts {% section #step-2 step=2 title="Add MCP servers" %} -Connect Appwrite MCP servers to Zenflow 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" %} - -[Node.js](https://nodejs.org/en/download) and npm must be installed on your system. - -{% /tabsitem %} -{% /tabs %} +Connect Appwrite MCP servers to Zenflow for deeper integration with the Appwrite API and documentation. Both servers are remote HTTP servers, so there are no additional pre-requisites to install. To add the Appwrite MCP server, open Zenflow and go to the **Settings** > **MCP servers**. From there, select your agent you want to configure MCP for, and then add your custom MCP server. @@ -49,24 +34,14 @@ To add the Appwrite MCP server, open Zenflow and go to the **Settings** > **MCP { "mcpServers": { "appwrite-api": { - "command": "uvx", - "args": [ - "mcp-server-appwrite" - ], - "env": { - "APPWRITE_PROJECT_ID": "your-project-id", - "APPWRITE_API_KEY": "your-api-key", - "APPWRITE_ENDPOINT": "https://.cloud.appwrite.io/v1" - } + "url": "https://mcp.appwrite.io/mcp", + "type": "http" } } } ``` -**Configuration:** -- Replace `your-project-id` with your actual Appwrite project ID -- Replace `your-api-key` with your Appwrite API key -- Replace `` with your Appwrite Cloud region (e.g., `nyc`, `fra`) +The API server uses OAuth for authentication. When Zenflow first connects to the server, complete the sign-in flow in your browser to sign in to your Appwrite account and authorize access. {% /tabsitem %} diff --git a/src/routes/integrations/mcp-claude/+page.markdoc b/src/routes/integrations/mcp-claude/+page.markdoc index 52c1a92ad73..5e6c6416550 100644 --- a/src/routes/integrations/mcp-claude/+page.markdoc +++ b/src/routes/integrations/mcp-claude/+page.markdoc @@ -15,9 +15,8 @@ product: platform: - 'Self-hosted' - 'Cloud' -images: +images: - /images/integrations/mcp-claude/cover.avif - - /images/integrations/mcp-claude/appwrite-api-key.avif - /images/docs/mcp/claude-desktop/claude-mcp-tools.avif - /images/docs/mcp/claude-desktop/claude-list-users.avif --- @@ -34,21 +33,23 @@ This integration enables you to perform various operations on your Appwrite reso To implement the MCP with Claude Desktop integration, there are several steps you must complete: -## Step 1: Create an Appwrite API key +## Step 1: Set up your Appwrite project -First, you must [create an account on Appwrite Cloud](https://cloud.appwrite.io/register) or [self-host Appwrite](https://appwrite.io/docs/advanced/self-hosting) if you haven't already. +First, you must [create an account on Appwrite Cloud](https://cloud.appwrite.io/register) if you haven't already, and create a project. -Select your project (or create a new one), and head to the **Overview** page from the left sidebar. Under the **Integrations** section, click on the **API Keys** tab, and then click on **Create API Key**. Select the scopes for whichever Appwrite services you want to work with, set the duration, and create the API key. You must then copy it for future usage. +The MCP server is a remote server that uses the HTTP transport and OAuth for authentication, so you don't need to create an API key. -![Create API Key](/images/integrations/mcp-claude/appwrite-api-key.avif) +{% info title="Self-hosted Appwrite" %} -Then, head to the **Settings** page from the left sidebar, and copy the **Project ID** and **API Endpoint** for future usage. +The hosted MCP server authenticates against Appwrite Cloud. If you run a [self-hosted Appwrite instance](https://appwrite.io/docs/advanced/self-hosting), follow the [self-hosted setup](/docs/tooling/ai/mcp-servers/api#self-hosted) in the MCP documentation instead. -## Step 2: Configure the MCP server on Cursor +{% /info %} + +## Step 2: Configure the MCP server on Claude Desktop -{% info title="Pre-requisite: Install uv" %} +{% info title="Pre-requisite: Install Node.js" %} -You must install [uv](https://docs.astral.sh/uv/getting-started/installation/) on your system to use the MCP server. +Claude Desktop only supports local (stdio) MCP servers, so the configuration uses the `mcp-remote` package as a proxy to connect to the remote MCP server. You must install [Node.js](https://nodejs.org/en/download) and npm on your system. {% /info %} @@ -58,32 +59,28 @@ To configure the MCP server on Claude Desktop, head to the app's **Settings** pa { "mcpServers": { "appwrite": { - "command": "uvx", + "command": "npx", "args": [ - "mcp-server-appwrite" - ], - "env": { - "APPWRITE_API_KEY": "", - "APPWRITE_PROJECT_ID": "", - "APPWRITE_ENDPOINT": "https://.cloud.appwrite.io/v1" - } + "mcp-remote", + "https://mcp.appwrite.io/mcp" + ] } } } ``` -This configuration will set up the MCP server to connect to your Appwrite project using the API key, project ID, and endpoint, which you must update before saving and exiting the file. - -Once you have updated and saved the `claude_desktop_config.json` file, restart Claude Desktop and click on the MCP tools button (at the bottom right section of the prompt input) to view the available MCP tools. +Once you have updated and saved the `claude_desktop_config.json` file, restart Claude Desktop. When the app first connects to the server, your browser opens so you can sign in to your Appwrite account and authorize access. You can then click on the MCP tools button (at the bottom right section of the prompt input) to view the available MCP tools. ![Claude MCP Tools](/images/docs/mcp/claude-desktop/claude-mcp-tools.avif) {% info title="Claude Code" %} -If you are using the Claude Code CLI, you can use the following command in your terminal to configure the MCP server in the exact same manner: +If you are using the Claude Code CLI, you can use the following command in your terminal to configure the MCP server: ```bash -claude mcp add-json appwrite '{"command":"uvx","args":["mcp-server-appwrite"],"env":{"APPWRITE_PROJECT_ID": "your-project-id", "APPWRITE_API_KEY": "your-api-key", "APPWRITE_ENDPOINT": "https://.cloud.appwrite.io/v1"}}' +claude mcp add --transport http appwrite https://mcp.appwrite.io/mcp ``` + +Then, run `/mcp` in Claude Code, select **appwrite**, and choose **Authenticate** to sign in to your Appwrite account. {% /info %} ## Step 3: Test the integration diff --git a/src/routes/integrations/mcp-cursor/+page.markdoc b/src/routes/integrations/mcp-cursor/+page.markdoc index de53eb70d73..eb8990984f4 100644 --- a/src/routes/integrations/mcp-cursor/+page.markdoc +++ b/src/routes/integrations/mcp-cursor/+page.markdoc @@ -15,9 +15,8 @@ product: platform: - 'Self-hosted' - 'Cloud' -images: +images: - /images/integrations/mcp-cursor/cover.avif - - /images/integrations/mcp-cursor/appwrite-api-key.avif - /images/docs/mcp/cursor/cursor-create-user.avif --- @@ -33,47 +32,33 @@ This integration enables you to perform various operations on your Appwrite reso To implement the MCP with Cursor integration, there are several steps you must complete: -## Step 1: Create an Appwrite API key +## Step 1: Set up your Appwrite project -First, you must [create an account on Appwrite Cloud](https://cloud.appwrite.io/register) or [self-host Appwrite](https://appwrite.io/docs/advanced/self-hosting) if you haven't already. +First, you must [create an account on Appwrite Cloud](https://cloud.appwrite.io/register) if you haven't already, and create a project. -Select your project (or create a new one), and head to the **Overview** page from the left sidebar. Under the **Integrations** section, click on the **API Keys** tab, and then click on **Create API Key**. Select the scopes for whichever Appwrite services you want to work with, set the duration, and create the API key. You must then copy it for future usage. +The MCP server is a remote server that uses the HTTP transport and OAuth for authentication, so you don't need to create an API key or install anything on your system. -![Create API Key](/images/integrations/mcp-cursor/appwrite-api-key.avif) +{% info title="Self-hosted Appwrite" %} -Then, head to the **Settings** page from the left sidebar, and copy the **Project ID** and **API Endpoint** for future usage. - -## Step 2: Configure the MCP server on Cursor - -{% info title="Pre-requisite: Install uv" %} - -You must install [uv](https://docs.astral.sh/uv/getting-started/installation/) on your system to use the MCP server. +The hosted MCP server authenticates against Appwrite Cloud. If you run a [self-hosted Appwrite instance](https://appwrite.io/docs/advanced/self-hosting), follow the [self-hosted setup](/docs/tooling/ai/mcp-servers/api#self-hosted) in the MCP documentation instead. {% /info %} +## Step 2: Configure the MCP server on Cursor + To configure the MCP server on Cursor, head to the **Cursor Settings** page, navigate to the **MCP** tab, and click on **Add new global MCP server**. This will open the `mcp.json` file, where you must add the following: ```json { "mcpServers": { "appwrite": { - "command": "uvx", - "args": [ - "mcp-server-appwrite" - ], - "env": { - "APPWRITE_API_KEY": "", - "APPWRITE_PROJECT_ID": "", - "APPWRITE_ENDPOINT": "https://.cloud.appwrite.io/v1" - } + "url": "https://mcp.appwrite.io/mcp" } } } ``` -This configuration will set up the MCP server to connect to your Appwrite project using the API key, project ID, and endpoint, which you must update before saving and exiting the file. - -Once you have updated and saved the `mcp.json` file, Cursor will connect with the Appwrite MCP server and load all available tools. You may need to restart Cursor if it is unable to start the MCP server. +Once you have updated and saved the `mcp.json` file, click **Needs login** next to the server in the MCP settings. Your browser opens so you can sign in to your Appwrite account and authorize access. Cursor will then connect with the Appwrite MCP server and load all available tools. ### Skip this step, directly add the server to Cursor @@ -93,7 +78,7 @@ Once you have understood how the Appwrite MCP server is configured in Cursor, yo {% /cards %} {% /only_dark %} -This will automatically configure the MCP server, and you will only need to update your Appwrite API key, project ID, and endpoint. +This will automatically configure the MCP server, and you will only need to complete the OAuth sign-in with your Appwrite account. ## Step 3: Test the integration diff --git a/src/routes/integrations/mcp-windsurf/+page.markdoc b/src/routes/integrations/mcp-windsurf/+page.markdoc index cc5c3f8cd37..3b406318cb8 100644 --- a/src/routes/integrations/mcp-windsurf/+page.markdoc +++ b/src/routes/integrations/mcp-windsurf/+page.markdoc @@ -15,9 +15,8 @@ product: platform: - 'Self-hosted' - 'Cloud' -images: +images: - /images/integrations/mcp-windsurf/cover.avif - - /images/integrations/mcp-windsurf/appwrite-api-key.avif - /images/docs/mcp/windsurf/windsurf-cascade-chat.avif --- @@ -33,47 +32,33 @@ This integration enables you to perform various operations on your Appwrite reso To implement the MCP with Windsurf Editor integration, there are several steps you must complete: -## Step 1: Create an Appwrite API key +## Step 1: Set up your Appwrite project -First, you must [create an account on Appwrite Cloud](https://cloud.appwrite.io/register) or [self-host Appwrite](https://appwrite.io/docs/advanced/self-hosting) if you haven't already. +First, you must [create an account on Appwrite Cloud](https://cloud.appwrite.io/register) if you haven't already, and create a project. -Select your project (or create a new one), and head to the **Overview** page from the left sidebar. Under the **Integrations** section, click on the **API Keys** tab, and then click on **Create API Key**. Select the scopes for whichever Appwrite services you want to work with, set the duration, and create the API key. You must then copy it for future usage. +The MCP server is a remote server that uses the HTTP transport and OAuth for authentication, so you don't need to create an API key or install anything on your system. -![Create API Key](/images/integrations/mcp-windsurf/appwrite-api-key.avif) +{% info title="Self-hosted Appwrite" %} -Then, head to the **Settings** page from the left sidebar, and copy the **Project ID** and **API Endpoint** for future usage. - -## Step 2: Configure the MCP server on Windsurf Editor - -{% info title="Pre-requisite: Install uv" %} - -You must install [uv](https://docs.astral.sh/uv/getting-started/installation/) on your system to use the MCP server. +The hosted MCP server authenticates against Appwrite Cloud. If you run a [self-hosted Appwrite instance](https://appwrite.io/docs/advanced/self-hosting), follow the [self-hosted setup](/docs/tooling/ai/mcp-servers/api#self-hosted) in the MCP documentation instead. {% /info %} +## Step 2: Configure the MCP server on Windsurf Editor + To configure the MCP server on Windsurf Editor, head to the **Windsurf Editor Settings** page, navigate to the **Model Context Protocol (MCP) Servers** section, and click on **View raw config**. This will open the `mcp_config.json` file, where you must add the following: ```json { "mcpServers": { "appwrite": { - "command": "uvx", - "args": [ - "mcp-server-appwrite" - ], - "env": { - "APPWRITE_API_KEY": "", - "APPWRITE_PROJECT_ID": "", - "APPWRITE_ENDPOINT": "https://.cloud.appwrite.io/v1" - } + "serverUrl": "https://mcp.appwrite.io/mcp" } } } ``` -This configuration will set up the MCP server to connect to your Appwrite project using the API key, project ID, and endpoint, which you must update before saving and exiting the file. - -Once you have updated and saved the `mcp_config.json` file, return to the MCP Servers section in the Windsurf Settings and click on **Refresh**. +Once you have updated and saved the `mcp_config.json` file, return to the MCP Servers section in the Windsurf Settings and click on **Refresh**. When Windsurf first connects to the server, you are prompted to log in, and your browser opens so you can sign in to your Appwrite account and authorize access. ## Step 3: Test the integration