Skip to content

Commit 610ca92

Browse files
authored
Merge pull request #2146 from appwrite/add-mcp-integration-guides
Add MCP integration guides for Cursor, Windsurf, and Claude Desktop
2 parents 93b2da2 + 022416a commit 610ca92

File tree

16 files changed

+326
-4
lines changed

16 files changed

+326
-4
lines changed

src/lib/constants.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,11 @@ export type SearchableCategory = {
6666
};
6767

6868
export const integrationCategoryDescriptions: SearchableCategory[] = [
69+
{
70+
slug: 'mcp',
71+
heading: 'MCP',
72+
description: 'Platforms with Model Context Protocol support'
73+
},
6974
{
7075
slug: 'ai',
7176
heading: 'AI',

src/routes/docs/tooling/mcp/claude/+page.markdoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ After opening the file, add the following info:
4141
}
4242
```
4343

44+
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:
45+
46+
```bash
47+
claude mcp add-json appwrite '{"command":"uvx","args":["mcp-server-appwrite","--users"],"env":{"APPWRITE_PROJECT_ID": "your-project-id", "APPWRITE_API_KEY": "your-api-key", "APPWRITE_ENDPOINT": "https://<REGION>.cloud.appwrite.io/v1"}}'
48+
```
49+
4450
{% info title="Enable other MCP tools" %}
4551

4652
To enable additional tools, learn more about [command-line arguments](/docs/tooling/mcp#command-line-arguments).

src/routes/integrations/ai-openai/+page.markdoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: integration
33
title: Prompt ChatGPT
44
description: Send text prompts to OpenAI GPT-3.5 and receive text generations
55
date: 2024-07-30
6-
featured: true
6+
featured: false
77
isPartner: true
88
isNew: false
99
cover: /images/integrations/ai-openai/cover.png

src/routes/integrations/flutterflow-auth-kit/+page.markdoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: integration
3-
title: Appwrite Authentication Kit
4-
description: Seamlessly integrate secure user authentication into your FlutterFlow appswithout writing complex code.
3+
title: Auth Kit for FlutterFlow
4+
description: Integrate Appwrite Auth into your FlutterFlow apps without writing complex code
55
date: 2024-03-01
66
featured: true
77
isPartner: true
@@ -11,7 +11,7 @@ category: auth
1111
product:
1212
avatar: '/images/integrations/avatars/flutterflow.png'
1313
vendor: FlutterFlow
14-
description: 'Appwrite is a secure, open-source backend server for web, mobile, and Flutter developers.'
14+
description: 'FlutterFlow is a low-code platform that lets you visually build and deploy mobile and web apps using Flutter.'
1515
platform:
1616
- 'Self-hosted'
1717
- 'Cloud'
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
layout: integration
3+
title: MCP with Claude
4+
description: Connect to Appwrite project with the MCP within Claude Desktop.
5+
date: 2025-07-01
6+
featured: false
7+
isPartner: true
8+
isNew: true
9+
cover: /images/integrations/mcp-claude/cover.png
10+
category: mcp
11+
product:
12+
avatar: '/images/integrations/avatars/claude.png'
13+
vendor: Anthropic
14+
description: 'Claude Desktop is a native AI assistant app by Anthropic that brings the Claude large language model to your devices.'
15+
platform:
16+
- 'Self-hosted'
17+
- 'Cloud'
18+
images:
19+
- /images/integrations/mcp-claude/cover.png
20+
- /images/integrations/mcp-claude/appwrite-api-key.png
21+
- /images/docs/mcp/claude/claude-mcp-tools.png
22+
- /images/docs/mcp/claude/claude-list-users.png
23+
---
24+
25+
Claude Desktop is a standalone application by Anthropic that allows users to interact with the Claude large language model directly from their Mac or Windows desktops. Designed for convenience and speed, it offers a distraction-free chat experience, supports multiple conversations, and runs natively for faster performance and system integration. Whether you're brainstorming, coding, summarizing documents, or automating workflows, Claude Desktop makes it easy to harness AI assistance without relying on a browser.
26+
27+
# How does the integration work?
28+
29+
The Appwrite MCP server integrates with Claude Desktop using the Model Context Protocol (MCP), allowing you to connect your Appwrite project to Claude Desktop.
30+
31+
This integration enables you to perform various operations on your Appwrite resources, such as creating users, managing databases, and more, directly from Claude Desktop using natural language commands.
32+
33+
# How to implement
34+
35+
To implement the MCP with Claude Desktop integration, there are several steps you must complete:
36+
37+
## Step 1: Create an Appwrite API key
38+
39+
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.
40+
41+
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.
42+
43+
![Create API Key](/images/integrations/mcp-claude/appwrite-api-key.png)
44+
45+
Then, head to the **Settings** page from the left sidebar, and copy the **Project ID** and **API Endpoint** for future usage.
46+
47+
## Step 2: Configure the MCP server on Cursor
48+
49+
{% info title="Pre-requisite: Install uv" %}
50+
51+
You must install [uv](https://docs.astral.sh/uv/getting-started/installation/) on your system to use the MCP server.
52+
53+
{% /info %}
54+
55+
To configure the MCP server on Claude Desktop, head to the app's **Settings** page (press `CTRL + ,` on Windows or `CMD + ,` on MacOS), navigate to the **Developer** tab, and click on **Edit Config**. This will open the `claude_desktop_config.json` file, where you must add the following:
56+
57+
```json
58+
{
59+
"mcpServers": {
60+
"appwrite": {
61+
"command": "uvx",
62+
"args": [
63+
"mcp-server-appwrite",
64+
"--users"
65+
],
66+
"env": {
67+
"APPWRITE_API_KEY": "<your-api-key>",
68+
"APPWRITE_PROJECT_ID": "<your-project-id>",
69+
"APPWRITE_ENDPOINT": "https://<REGION>.cloud.appwrite.io/v1"
70+
}
71+
}
72+
}
73+
}
74+
```
75+
76+
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.
77+
78+
You may have noticed the `--users` argument, which enables Claude Desktop to interact with the Appwrite Users API. To enable other Appwrite services, you can add their respective [command-line arguments](/docs/tooling/mcp#command-line-arguments).
79+
80+
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.
81+
82+
![Claude MCP Tools](/images/docs/mcp/claude/claude-mcp-tools.png)
83+
84+
{% info title="Claude Code" %}
85+
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:
86+
87+
```bash
88+
claude mcp add-json appwrite '{"command":"uvx","args":["mcp-server-appwrite","--users"],"env":{"APPWRITE_PROJECT_ID": "your-project-id", "APPWRITE_API_KEY": "your-api-key", "APPWRITE_ENDPOINT": "https://<REGION>.cloud.appwrite.io/v1"}}'
89+
```
90+
{% /info %}
91+
92+
## Step 3: Test the integration
93+
94+
Finally, you can test the integration by asking Claude Desktop to list all the users in your Appwrite project.
95+
96+
![Claude Desktop](/images/docs/mcp/claude/claude-list-users.png)
97+
98+
# Read more about MCP with Claude Desktop
99+
100+
If you would like to learn more about MCP with Claude Desktop, we have some resources that you should visit:
101+
102+
- [Appwrite MCP documentation](/docs/tooling/mcp)
103+
- [What exactly is MCP, and why is it trending?](/blog/post/what-is-mcp)
104+
- [Download Claude Desktop](https://claude.ai/download)
Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
---
2+
layout: integration
3+
title: MCP with Cursor
4+
description: Connect to Appwrite project with the MCP within Cursor.
5+
date: 2025-07-01
6+
featured: true
7+
isPartner: true
8+
isNew: true
9+
cover: /images/integrations/mcp-cursor/cover.png
10+
category: mcp
11+
product:
12+
avatar: '/images/integrations/avatars/cursor.png'
13+
vendor: Cursor
14+
description: 'Cursor is an AI-powered code editor based on VS Code, designed for context-aware development and seamless collaboration with large language models.'
15+
platform:
16+
- 'Self-hosted'
17+
- 'Cloud'
18+
images:
19+
- /images/integrations/mcp-cursor/cover.png
20+
- /images/integrations/mcp-cursor/appwrite-api-key.png
21+
- /images/docs/mcp/cursor/cursor-create-user.png
22+
---
23+
24+
Cursor is an AI-powered code editor built on VS Code, designed to enhance developer workflows with intelligent, context-aware assistance. It offers features like inline code generation, natural language explanations, and project-aware chat, enabling developers to prototype, debug, and refactor code faster with the help of integrated large language models such as Anthropic's Claude 4.0 Sonnet, Google's Gemini 2.5 Pro, and OpenAI's GPT-4.1.
25+
26+
# How does the integration work?
27+
28+
The Appwrite MCP server integrates with Cursor Agent using the Model Context Protocol (MCP), allowing you to connect your Appwrite project to Cursor.
29+
30+
This integration enables you to perform various operations on your Appwrite resources, such as creating users, managing databases, and more, directly from the Cursor editor using natural language commands.
31+
32+
# How to implement
33+
34+
To implement the MCP with Cursor integration, there are several steps you must complete:
35+
36+
## Step 1: Create an Appwrite API key
37+
38+
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.
39+
40+
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.
41+
42+
![Create API Key](/images/integrations/mcp-cursor/appwrite-api-key.png)
43+
44+
Then, head to the **Settings** page from the left sidebar, and copy the **Project ID** and **API Endpoint** for future usage.
45+
46+
## Step 2: Configure the MCP server on Cursor
47+
48+
{% info title="Pre-requisite: Install uv" %}
49+
50+
You must install [uv](https://docs.astral.sh/uv/getting-started/installation/) on your system to use the MCP server.
51+
52+
{% /info %}
53+
54+
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:
55+
56+
```json
57+
{
58+
"mcpServers": {
59+
"appwrite": {
60+
"command": "uvx",
61+
"args": [
62+
"mcp-server-appwrite",
63+
"--users"
64+
],
65+
"env": {
66+
"APPWRITE_API_KEY": "<your-api-key>",
67+
"APPWRITE_PROJECT_ID": "<your-project-id>",
68+
"APPWRITE_ENDPOINT": "https://<REGION>.cloud.appwrite.io/v1"
69+
}
70+
}
71+
}
72+
}
73+
```
74+
75+
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.
76+
77+
You may have noticed the `--users` argument, which enables Cursor to interact with the Appwrite Users API. To enable other Appwrite services, you can add their respective [command-line arguments](/docs/tooling/mcp#command-line-arguments).
78+
79+
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.
80+
81+
### Skip this step, directly add the server to Cursor
82+
83+
Once you have understood how the Appwrite MCP server is configured in Cursor, you can skip this step by directly adding the MCP server using the following link.
84+
85+
{% only_light %}
86+
{% cards %}
87+
{% cards_item href="https://cursor.com/install-mcp?name=appwrite&config=eyJjb21tYW5kIjoidXZ4IG1jcC1zZXJ2ZXItYXBwd3JpdGUgLS11c2VycyIsImVudiI6eyJBUFBXUklURV9BUElfS0VZIjoiPHlvdXItYXBpLWtleT4iLCJBUFBXUklURV9QUk9KRUNUX0lEIjoiPHlvdXItcHJvamVjdC1pZD4iLCJBUFBXUklURV9FTkRQT0lOVCI6Imh0dHBzOi8vPFJFR0lPTj4uY2xvdWQuYXBwd3JpdGUuaW8vdjEifX0%3D" title="Add to Cursor" image="/images/docs/mcp/logos/cursor-ai.svg" %}
88+
{% /cards_item %}
89+
{% /cards %}
90+
{% /only_light %}
91+
92+
{% only_dark %}
93+
{% cards %}
94+
{% cards_item href="https://cursor.com/install-mcp?name=appwrite&config=eyJjb21tYW5kIjoidXZ4IG1jcC1zZXJ2ZXItYXBwd3JpdGUgLS11c2VycyIsImVudiI6eyJBUFBXUklURV9BUElfS0VZIjoiPHlvdXItYXBpLWtleT4iLCJBUFBXUklURV9QUk9KRUNUX0lEIjoiPHlvdXItcHJvamVjdC1pZD4iLCJBUFBXUklURV9FTkRQT0lOVCI6Imh0dHBzOi8vPFJFR0lPTj4uY2xvdWQuYXBwd3JpdGUuaW8vdjEifX0%3D" title="Add to Cursor" image="/images/docs/mcp/logos/dark/cursor-ai.svg" %}
95+
{% /cards_item %}
96+
{% /cards %}
97+
{% /only_dark %}
98+
99+
This will automatically configure the MCP server, and you will only need to update your Appwrite API key, project ID, and endpoint.
100+
101+
## Step 3: Test the integration
102+
103+
Finally, you can test the integration by asking Cursor Agent to create a new user in your Appwrite project.
104+
105+
![Cursor Agent](/images/docs/mcp/cursor/cursor-create-user.png)
106+
107+
# Read more about MCP with Cursor
108+
109+
If you would like to learn more about MCP with Cursor, we have some resources that you should visit:
110+
111+
- [Appwrite MCP documentation](/docs/tooling/mcp)
112+
- [What exactly is MCP, and why is it trending?](/blog/post/what-is-mcp)
113+
- [Download Cursor](https://www.cursor.com/)
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
layout: integration
3+
title: MCP with Windsurf
4+
description: Connect to Appwrite project with the MCP within Windsurf Editor.
5+
date: 2025-07-01
6+
featured: false
7+
isPartner: true
8+
isNew: true
9+
cover: /images/integrations/mcp-windsurf/cover.png
10+
category: mcp
11+
product:
12+
avatar: '/images/integrations/avatars/windsurf.png'
13+
vendor: Windsurf
14+
description: 'Windsurf Editor is an AI-native, agent-powered IDE that enhances developer productivity with AI-driven code generation, debugging, and refactoring capabilities.'
15+
platform:
16+
- 'Self-hosted'
17+
- 'Cloud'
18+
images:
19+
- /images/integrations/mcp-windsurf/cover.png
20+
- /images/integrations/mcp-windsurf/appwrite-api-key.png
21+
- /images/docs/mcp/windsurf/windsurf-cascade-chat.png
22+
---
23+
24+
Windsurf Editor is a next-gen IDE that embeds a powerful AI agent called Cascade directly into your coding workflow. Unlike tools limited to autocomplete or single-file assistance, Cascade understands your entire project context and can generate code across files, run terminal commands, debug issues, and even deploy applications, all triggered by natural language prompts. With features like Supercomplete, inline AI chat, memories, and live previews, Windsurf aims to keep you in a deep focus state by eliminating context switching and handling repetitive tasks automatically, while still giving you full control over what gets merged or executed.
25+
26+
# How does the integration work?
27+
28+
The Appwrite MCP server integrates with Windsurf Editor's Cascade chat using the Model Context Protocol (MCP), allowing you to connect your Appwrite project to Windsurf Editor.
29+
30+
This integration enables you to perform various operations on your Appwrite resources, such as creating users, managing databases, and more, directly from the Windsurf Editor using natural language commands.
31+
32+
# How to implement
33+
34+
To implement the MCP with Windsurf Editor integration, there are several steps you must complete:
35+
36+
## Step 1: Create an Appwrite API key
37+
38+
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.
39+
40+
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.
41+
42+
![Create API Key](/images/integrations/mcp-windsurf/appwrite-api-key.png)
43+
44+
Then, head to the **Settings** page from the left sidebar, and copy the **Project ID** and **API Endpoint** for future usage.
45+
46+
## Step 2: Configure the MCP server on Windsurf Editor
47+
48+
{% info title="Pre-requisite: Install uv" %}
49+
50+
You must install [uv](https://docs.astral.sh/uv/getting-started/installation/) on your system to use the MCP server.
51+
52+
{% /info %}
53+
54+
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:
55+
56+
```json
57+
{
58+
"mcpServers": {
59+
"appwrite": {
60+
"command": "uvx",
61+
"args": [
62+
"mcp-server-appwrite",
63+
"--databases",
64+
"--users"
65+
],
66+
"env": {
67+
"APPWRITE_API_KEY": "<your-api-key>",
68+
"APPWRITE_PROJECT_ID": "<your-project-id>",
69+
"APPWRITE_ENDPOINT": "https://<REGION>.cloud.appwrite.io/v1"
70+
}
71+
}
72+
}
73+
}
74+
```
75+
76+
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.
77+
78+
You may have noticed the `--databases` and `--users` arguments, which enables Windsurf Editor to interact with the Appwrite Users and Databases APIs. To enable other Appwrite services, you can add their respective [command-line arguments](/docs/tooling/mcp#command-line-arguments).
79+
80+
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**.
81+
82+
## Step 3: Test the integration
83+
84+
Finally, you can test the integration by asking the Cascade chat in the Windsurf Editor to query your database.
85+
86+
![Windsurf Editor Cascade Chat](/images/docs/mcp/windsurf/windsurf-cascade-chat.png)
87+
88+
# Read more about MCP with Windsurf Editor
89+
90+
If you would like to learn more about MCP with Cursor, we have some resources that you should visit:
91+
92+
- [Appwrite MCP documentation](/docs/tooling/mcp)
93+
- [What exactly is MCP, and why is it trending?](/blog/post/what-is-mcp)
94+
- [Download Windsurf Editor](https://windsurf.com/download)
15 KB
Loading
21.5 KB
Loading
9.82 KB
Loading

0 commit comments

Comments
 (0)