The MCP server for Appwrite API allows LLMs and code-generation tools to interact with the Appwrite platform and perform various operations on your Appwrite resources, such as creating users, managing databases, and more, using natural language commands.
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
- Automatic service discovery: All supported Appwrite services are automatically registered, no configuration needed
Pre-requisites
Appwrite API key
Before launching the MCP server, you must set up an Appwrite project and create an API key with the necessary scopes enabled.
Ensure you save the API key along with the project ID, region and endpoint URL from the Settings page of your project as you'll need them later.
Install uv
Install uv on your system with:
curl -LsSf https://astral.sh/uv/install.sh | sh
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
You can verify the installation by running the following command in your terminal:
uv
Installation
You can add the MCP server to various AI tools and code editors:
Want to integrate your AI tool?
If you are building an AI code-generation tool that can integrate with MCP servers and would like to collaborate, join our Technology Partners program.
How it works
The MCP server starts in a compact workflow where only two MCP tools are exposed to the model:
appwrite_search_tools- Searches the full Appwrite tool catalog at runtimeappwrite_call_tool- Calls a specific Appwrite tool by name
The full Appwrite tool catalog stays internal and is searched at runtime, using less of the model's context.
Usage
Once configured, your AI assistant will have access to your Appwrite project. You can ask questions like:
Example 1: List users
Run the following prompt in your preferred code editor/LLM after enabling the MCP server:
List users in my Appwrite project
Example 2: Search a site
Run the following prompt in your preferred code editor/LLM after enabling the MCP server:
Get the details of my portfolio site from Appwrite
Example 3: Create a user
Run the following prompt in your preferred code editor/LLM after enabling the MCP server:
Add a user john.doe@example.com to the Appwrite project
