Appwrite

🚀 Appwrite MCP Server

The Appwrite MCP Server is a Model Context Protocol (MCP) server for interacting with the Appwrite API. It allows you to directly integrate with the Appwrite platform through the Model Context Protocol (MCP).

🚀 Quick Start

The Appwrite MCP Server enables seamless interaction with the Appwrite API via the Model Context Protocol (MCP). It provides a convenient way to integrate with the Appwrite platform directly.

✨ Features

• Integrate with the Appwrite platform through the Model Context Protocol (MCP).
• Support multiple installation methods and integration with different applications.

📦 Installation

Using uv

• Linux or MacOS

  curl -LsSf https://astral.sh/uv/install.sh | sh
  

• Windows (PowerShell)

  powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
  

Using pip

pip install mcp-server-appwrite

📚 Documentation

Configuration

Create a .env file

Create a .env file in the project root directory and add the following content:

APPWRITE_API_KEY=Your API Key
APPWRITE_PROJECT_ID=Your Project ID
APPWRITE_ENDPOINT=https://api.appwrite.io (Optional, default value)

Integration

Claude Desktop

1. Open the settings of Claude Desktop.
2. In Settings > MCP, click Add new MCP server.
3. Select the type as Command and add the following content in the Command field:
   • MacOS

     env APPWRITE_API_KEY=Your API Key env APPWRITE_PROJECT_ID=Your Project ID uvx mcp-server-appwrite
     

   • Windows

     cmd /c SET APPWRITE_PROJECT_ID=Your Project ID && SET APPWRITE_API_KEY=Your API Key && uvx mcp-server-appwrite
     

Cursor

1. Open the settings of Cursor.
2. In Settings > Model Context Protocol (MCP), click View raw config.
3. Update the mcp_config.json 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://api.appwrite.io" // Optional, default value
         }
       }
     }
   }
   

Windsurf Editor

1. Open the settings of Windsurf Editor.
2. In Settings > Cascade > Model Context Protocol (MCP) Servers, click View raw config.
3. Update the mcp_config.json 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://api.appwrite.io" // Optional, default value
         }
       }
     }
   }
   

Local Development

Clone the repository

git clone https://github.com/appwrite/mcp.git

Install uv

• Linux or MacOS

  curl -LsSf https://astral.sh/uv/install.sh | sh
  

• Windows (PowerShell)

  powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
  

Set up a virtual environment

1. Create and activate the virtual environment:
   • Linux or MacOS

     uv venv
     source .venv/bin/activate
     

   • Windows

     .venv\Scripts\activate
     

2. Run the server:

   uv run -v --directory ./ mcp-server-appwrite
   

Debugging

Use the MCP inspector tool for debugging:

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

Open your browser and visit http://localhost:8090.

📄 License

This software is licensed under the MIT License. You are free to use, modify, and distribute it.