Appwrite MCP server
Overview
Quick Links
- Configuration
- Installation
- IDE Integration:
- Local Development
- Debugging
Configuration
Before launching the MCP server, you must setup an Appwrite project and create an API key with the necessary scopes enabled.
.env
file in your working directory and add the following:Linux and MacOS
Windows
Command Prompt
PowerShell
Installation
Using uv (recommended)
Using pip
Command-line arguments
uv
and pip
setup processes require certain arguments to enable MCP tools for various Appwrite APIs.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. 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 by using the flags below.
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
Usage with Claude Desktop
CTRL + ,
on Windows or CMD + ,
on MacOS) and head to the Developer tab. Clicking on the Edit Config button will take you to the claude_desktop_config.json
file, where you must add the following:Note: In case you see auvx ENOENT
error, ensure that you either adduvx
to thePATH
environment variable on your system or use the full path to youruvx
installation in the config file.
Usage with [Cursor](https://www.cursor.com/)
Settings > MCP
and click on Add new MCP server. Choose the type as Command
and add the command below to the Command field.- MacOS
- Windows
Usage with [Windsurf Editor](https://codeium.com/windsurf)
Settings > Cascade > Model Context Protocol (MCP) Servers
and click on View raw config. Update the mcp_config.json
file to include the following:Local Development
Clone the repository
Install `uv`
- Linux or MacOS
- Windows (PowerShell)
Prepare virtual environment
- Linux or MacOS
- Windows
Run the server
Debugging
.env
file is properly configured before running the inspector. You can then access the inspector at http://localhost:5173
.License
Appwrite MCP server
Overview
Quick Links
- Configuration
- Installation
- IDE Integration:
- Local Development
- Debugging
Configuration
Before launching the MCP server, you must setup an Appwrite project and create an API key with the necessary scopes enabled.
.env
file in your working directory and add the following:Linux and MacOS
Windows
Command Prompt
PowerShell
Installation
Using uv (recommended)
Using pip
Command-line arguments
uv
and pip
setup processes require certain arguments to enable MCP tools for various Appwrite APIs.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. 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 by using the flags below.
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
[object Object] | [object Object] |
Usage with Claude Desktop
CTRL + ,
on Windows or CMD + ,
on MacOS) and head to the Developer tab. Clicking on the Edit Config button will take you to the claude_desktop_config.json
file, where you must add the following:Note: In case you see auvx ENOENT
error, ensure that you either adduvx
to thePATH
environment variable on your system or use the full path to youruvx
installation in the config file.
Usage with [Cursor](https://www.cursor.com/)
Settings > MCP
and click on Add new MCP server. Choose the type as Command
and add the command below to the Command field.- MacOS
- Windows
Usage with [Windsurf Editor](https://codeium.com/windsurf)
Settings > Cascade > Model Context Protocol (MCP) Servers
and click on View raw config. Update the mcp_config.json
file to include the following:Local Development
Clone the repository
Install `uv`
- Linux or MacOS
- Windows (PowerShell)
Prepare virtual environment
- Linux or MacOS
- Windows
Run the server
Debugging
.env
file is properly configured before running the inspector. You can then access the inspector at http://localhost:5173
.