Appwrite MCP server for AI agents

The Appwrite MCP server provides a Model Context Protocol implementation for interacting with Appwrite's API services, enabling AI-assisted management of databases, users, functions, teams, and other Appwrite project components.

Installation

Setting Up Environment Variables

Before installing the server, you need to configure your Appwrite credentials:

Create a .env file in your working directory with:

APPWRITE_PROJECT_ID=your-project-id
APPWRITE_API_KEY=your-api-key
APPWRITE_ENDPOINT=https://<REGION>.cloud.appwrite.io/v1

Apply these environment variables:

For Linux/MacOS:

source .env

For Windows Command Prompt:

for /f "tokens=1,2 delims==" %A in (.env) do set %A=%B

For Windows PowerShell:

Get-Content .\.env | ForEach-Object {
  if ($_ -match '^(.*?)=(.*)$') {
    [System.Environment]::SetEnvironmentVariable($matches[1], $matches[2], "Process")
  }
}

Installation Methods

Using uv (Recommended)

uvx mcp-server-appwrite [args]

Using pip

pip install mcp-server-appwrite
python -m mcp_server_appwrite [args]

Command-line Arguments

Enable specific Appwrite API tools with these arguments:

Argument	Description
`--databases`	Enables the Databases 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
`--sites`	Enables the Sites API
`--all`	Enables all Appwrite APIs

Note: Only the Databases tools are enabled by default to minimize token usage. Each additional tool uses more of the model's context window.

Integration with AI Tools

Claude Desktop Integration

Open Settings in Claude Desktop (press CTRL + , on Windows or CMD + , on MacOS)
Go to the Developer tab
Click Edit Config and add:

{
  "mcpServers": {
    "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"
      }
    }
  }
}

Cursor Integration

Go to Settings > MCP
Click Add new MCP server
Choose Command type
Add the appropriate command:

For MacOS:

env APPWRITE_API_KEY=your-api-key env APPWRITE_PROJECT_ID=your-project-id uvx mcp-server-appwrite

For Windows:

cmd /c SET APPWRITE_PROJECT_ID=your-project-id && SET APPWRITE_API_KEY=your-api-key && uvx mcp-server-appwrite

Windsurf Editor Integration

Go to Settings > Cascade > Model Context Protocol (MCP) Servers
Click View raw config
Update mcp_config.json:

{
  "mcpServers": {
    "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"
      }
    }
  }
}

VS Code Integration

Open Command Palette (Ctrl+Shift+P or Cmd+Shift+P)
Run MCP: Open User Configuration
Add to mcp.json:

{
  "servers": {
    "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"
      }
    }
  }
}

Run MCP: List Servers, select appwrite and click Start Server
Use in Copilot Chat by switching to Agent Mode

Debugging

You can use the MCP inspector for debugging:

npx @modelcontextprotocol/inspector \
  uv \
  --directory . \
  run mcp-server-appwrite

Access the inspector at http://localhost:5173.

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

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"}}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "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"
            }
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "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"
            }
        }
    }
}

3. Restart Claude Desktop for the changes to take effect