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
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,7 @@ Update the `mcp_config.json` file to include the API server:
"appwrite-api": {
"command": "uvx",
"args": [
"mcp-server-appwrite",
"--users"
"mcp-server-appwrite"
],
"env": {
"APPWRITE_PROJECT_ID": "your-project-id",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ 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","--users"],"env":{"APPWRITE_PROJECT_ID": "your-project-id", "APPWRITE_API_KEY": "your-api-key", "APPWRITE_ENDPOINT": "https://<REGION>.cloud.appwrite.io/v1"}}'
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://<REGION>.cloud.appwrite.io/v1"}}'

```

Expand All @@ -63,12 +63,6 @@ claude mcp add appwrite-docs <https://mcp-for-docs.appwrite.io> -t http
{% /tabsitem %}
{% /tabs %}

{% info title="Enable other API MCP tools" %}

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

{% /info %}

{% /section %}

{% section #step-3 step=3 title="Verify MCP tools" %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,7 @@ Add the API server to your configuration:
"appwrite-api": {
"command": "uvx",
"args": [
"mcp-server-appwrite",
"--users"
"mcp-server-appwrite"
],
"env": {
"APPWRITE_PROJECT_ID": "your-project-id",
Expand Down Expand Up @@ -106,12 +105,6 @@ Unlike other IDEs, Claude Desktop only supports local (stdio) MCP servers and no
{% /tabsitem %}
{% /tabs %}

{% info title="Enable other API MCP tools" %}

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

{% /info %}

{% /section %}

{% section #step-3 step=3 title="Verify MCP tools" %}
Expand Down
9 changes: 1 addition & 8 deletions src/routes/docs/tooling/ai/ai-dev-tools/cursor/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,7 @@ Update the `mcp.json` file to include the API server:
"appwrite-api": {
"command": "uvx",
"args": [
"mcp-server-appwrite",
"--users"
"mcp-server-appwrite"
],
"env": {
"APPWRITE_API_KEY": "your-api-key",
Expand Down Expand Up @@ -151,12 +150,6 @@ You can also **directly add the MCP servers to Cursor** using the following link

Once you save the details, Cursor will connect with the MCP server(s) and load all available tools. You may need to restart Cursor if it is unable to start the MCP server.

{% info title="Enable other API MCP tools" %}

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

{% /info %}

{% /section %}

{% section #step-4 step=4 title="Test the integration" %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ To connect Appwrite MCP servers to Emergent:
"appwrite-api": {
"command": "uvx",
"args": [
"mcp-server-appwrite",
"--users"
"mcp-server-appwrite"
],
"env": {
"APPWRITE_PROJECT_ID": "your-project-id",
Expand Down Expand Up @@ -65,12 +64,6 @@ To connect Appwrite MCP servers to Emergent:
{% /tabsitem %}
{% /tabs %}

{% info title="Enable other API MCP tools" %}

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

{% /info %}

{% /section %}

{% section #test-the-integration step=2 title="Test the integration" %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,7 @@ Use the following configuration in your `opencode.json` file to use the Appwrite
"type": "local",
"command": [
"uvx",
"mcp-server-appwrite",
"--sites"
"mcp-server-appwrite"
],
"enabled": true,
"environment": {
Expand Down Expand Up @@ -96,12 +95,6 @@ Use the following configuration in your `opencode.json` file to use the Appwrite
{% /tabsitem %}
{% /tabs %}

{% info title="Enable other API MCP tools" %}

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

{% /info %}

{% /section %}

{% section #step-3 step=3 title="Test the integration" %}
Expand Down
9 changes: 1 addition & 8 deletions src/routes/docs/tooling/ai/ai-dev-tools/vscode/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@ Update the `mcp.json` file to include the API server:
"appwrite-api": {
"command": "uvx",
"args": [
"mcp-server-appwrite",
"--sites"
"mcp-server-appwrite"
],
"env": {
"APPWRITE_PROJECT_ID": "your-project-id",
Expand Down Expand Up @@ -99,12 +98,6 @@ Update the `mcp.json` file to include the docs server:

Once you save the configuration, Copilot Chat will connect with the MCP server(s) and load all available tools.

{% info title="Enable other API MCP tools" %}

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

{% /info %}

{% /section %}

{% section #test-the-integration step=3 title="Test the integration" %}
Expand Down
10 changes: 1 addition & 9 deletions src/routes/docs/tooling/ai/ai-dev-tools/windsurf/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,7 @@ Update the `mcp_config.json` file to include the API server:
"appwrite-api": {
"command": "uvx",
"args": [
"mcp-server-appwrite",
"--databases",
"--users"
"mcp-server-appwrite"
],
"env": {
"APPWRITE_PROJECT_ID": "your-project-id",
Expand Down Expand Up @@ -101,12 +99,6 @@ Update the `mcp_config.json` file to include the docs server:

Once you save the details, head back to the MCP Servers section in the Windsurf Settings and click on the **Refresh** button.

{% info title="Enable other API MCP tools" %}

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

{% /info %}

{% /section %}

{% section #test-the-integration step=3 title="Test the integration" %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,7 @@ To add the Appwrite MCP server, open Zenflow and go to the **Settings** > **MCP
"appwrite-api": {
"command": "uvx",
"args": [
"mcp-server-appwrite",
"--sites"
"mcp-server-appwrite"
],
"env": {
"APPWRITE_PROJECT_ID": "your-project-id",
Expand Down
26 changes: 6 additions & 20 deletions src/routes/docs/tooling/ai/mcp-servers/api/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Here are some of the key benefits of using the MCP server:
- **Direct API interaction**: Enables LLMs to perform actions directly on your Appwrite project
- **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
- **Customizable tools**: Offers a range of tools for different Appwrite services, which can be enabled as needed
- **Automatic service discovery**: All supported Appwrite services are automatically registered, no configuration needed

# Pre-requisites {% #pre-requisites %}

Expand Down Expand Up @@ -60,28 +60,14 @@ uv

{% partial file="mcp-add-ides-tools.md" /%}

## Command-line arguments
## How it works

Database tools are enabled by default. In addition you can pass arguments to `uvx mcp-server-appwrite [args]` to enable other MCP tools for various Appwrite APIs.
The MCP server starts in a compact workflow where only two MCP tools are exposed to the model:

| Argument | Description |
| --- | --- |
| `--tablesdb` | Enables the TablesDB API |
| `--users` | Enables the Users API |
| `--teams` | Enables the Teams API |
| `--storage` | Enables the Storage API |
| `--functions` | Enables the Functions API |
| `--messaging` | Enables the Messaging API |
| `--locale` | Enables the Locale API |
| `--avatars` | Enables the Avatars API |
| `--databases` | Enables the legacy Databases API |
| `--all` | Enables all Appwrite APIs |
- `appwrite_search_tools` - Searches the full Appwrite tool catalog at runtime
- `appwrite_call_tool` - Calls a specific Appwrite tool by name

{% info title="Enable only necessary MCP tools" %}
When an MCP tool is enabled, the tool's definition is passed to the LLM, using up tokens from the model's available context window. As a result, the effective context window is reduced. Some IDEs may return errors if too many tools are enabled for the same reason.

The default Appwrite MCP server ships with only the Databases tools (our most commonly used API) enabled to stay within these limits. Additional tools can be enabled using the flags above.
{% /info %}
The full Appwrite tool catalog stays internal and is searched at runtime, using less of the model's context.

# Usage {% #usage %}

Expand Down
7 changes: 2 additions & 5 deletions src/routes/integrations/mcp-claude/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,7 @@ To configure the MCP server on Claude Desktop, head to the app's **Settings** pa
"appwrite": {
"command": "uvx",
"args": [
"mcp-server-appwrite",
"--users"
"mcp-server-appwrite"
],
"env": {
"APPWRITE_API_KEY": "<your-api-key>",
Expand All @@ -75,8 +74,6 @@ To configure the MCP server on Claude Desktop, head to the app's **Settings** pa

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.

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).

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.

![Claude MCP Tools](/images/docs/mcp/claude-desktop/claude-mcp-tools.png)
Expand All @@ -85,7 +82,7 @@ Once you have updated and saved the `claude_desktop_config.json` file, restart C
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:

```bash
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"}}'
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://<REGION>.cloud.appwrite.io/v1"}}'
```
{% /info %}

Expand Down
5 changes: 1 addition & 4 deletions src/routes/integrations/mcp-cursor/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,7 @@ To configure the MCP server on Cursor, head to the **Cursor Settings** page, nav
"appwrite": {
"command": "uvx",
"args": [
"mcp-server-appwrite",
"--users"
"mcp-server-appwrite"
],
"env": {
"APPWRITE_API_KEY": "<your-api-key>",
Expand All @@ -74,8 +73,6 @@ To configure the MCP server on Cursor, head to the **Cursor Settings** page, nav

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.

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).

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.

### Skip this step, directly add the server to Cursor
Expand Down
6 changes: 1 addition & 5 deletions src/routes/integrations/mcp-windsurf/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,7 @@ To configure the MCP server on Windsurf Editor, head to the **Windsurf Editor Se
"appwrite": {
"command": "uvx",
"args": [
"mcp-server-appwrite",
"--databases",
"--users"
"mcp-server-appwrite"
],
"env": {
"APPWRITE_API_KEY": "<your-api-key>",
Expand All @@ -75,8 +73,6 @@ To configure the MCP server on Windsurf Editor, head to the **Windsurf Editor Se

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.

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).

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**.

## Step 3: Test the integration
Expand Down
Loading