MCP (Model Context Protocol) server for Appwrite
Project description
Appwrite MCP server
Overview
A Model Context Protocol server for interacting with Appwrite's API. This server provides tools to manage databases, users, functions, teams, and more within your Appwrite project.
Quick Links
- Configuration
- Installation
- IDE Integration:
- Local Development
- Debugging
Currently, the server supports the following tools:
- Databases
- Users
Please note that adding a lot of tools exceeds the context window of the LLM. As a result, we will make available a curated list of tools that are most commonly used.
Configuration
Create a .env file in the directory you're running the server from:
APPWRITE_API_KEY=your-api-key
APPWRITE_PROJECT_ID=your-project-id
APPWRITE_ENDPOINT=your-endpoint # Optional, defaults to https://cloud.appwrite.io/v1
Note: Ensure that your API Key has the necessary scopes to access the resources you want to use.
Installation
Using uv (recommended)
When using uv no specific installation is needed. We will
use uvx to directly run mcp-server-appwrite.
uvx run mcp-server-appwrite
Using pip
pip install mcp-server-appwrite
Then run the server using
python -m mcp_server_appwrite
Usage with Claude Desktop
Add this to your claude_desktop_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": "your-endpoint" // Optional
}
}
}
Upon successful configuration, you should be able to see the server in the list of available servers in Claude Desktop.
Usage with Zed
Add to your Zed settings.json:
"context_servers": {
"appwrite": {
"command": "uvx",
"args": [
"mcp-server-appwrite"
],
"env": {
"APPWRITE_PROJECT_ID": "your-project-id",
"APPWRITE_API_KEY": "your-api-key",
"APPWRITE_ENDPOINT": "your-endpoint" // Optional
}
}
}
Usage with Cursor
Head to Cursor Settings > Features > MCP Servers and click on Add New MCP Server. Choose the type as Command and add the command below to the Command field.
APPWRITE_PROJECT_ID=your-project-id APPWRITE_API_KEY=your-api-key uvx mcp-server-appwrite
Local Development
Clone the repository
git clone https://github.com/appwrite/mcp.git
Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh
Create virtual environment
uv venv
source .venv/bin/activate
Run the server
uv run -v --directory ./ mcp-server-appwrite
Debugging
You can use the MCP inspector to debug the server.
npx @modelcontextprotocol/inspector \
uv \
--directory . \
run mcp-server-appwrite
Make sure your .env file is properly configured before running the inspector. You can then access the inspector at http://localhost:5173.
License
This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.
Todos
- Add MCP server to registries
- Add support for SSE server
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mcp_server_appwrite-0.1.3.tar.gz.
File metadata
- Download URL: mcp_server_appwrite-0.1.3.tar.gz
- Upload date:
- Size: 255.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c0c7bd2a61e75cc9ed98cf23095fa1bc50f72e48d495a92d1ef554c6c3764b94
|
|
| MD5 |
dddd7b9eeb47d71f5bbf45a72b949077
|
|
| BLAKE2b-256 |
3ec14568c40178fe2dcab334a660ebf8e3f5468927d8a76a2769c5b3f71cc074
|
File details
Details for the file mcp_server_appwrite-0.1.3-py3-none-any.whl.
File metadata
- Download URL: mcp_server_appwrite-0.1.3-py3-none-any.whl
- Upload date:
- Size: 7.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
797d0af118be1fbe17e20136ef4459d891c78e1b1b061e993ecae52f144a6b42
|
|
| MD5 |
8560382da9ee5f7d8e4314b50a2a9916
|
|
| BLAKE2b-256 |
2aac9dea2b00ea7f8217ec5d06f10fed8cee8f4e349d389ee3586cd99734b37c
|