Skip to main content

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.

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 runing 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-sentry.

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.

Claude Desktop Config

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

Cursor Settings

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_server_appwrite-0.1.2.tar.gz (252.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_server_appwrite-0.1.2-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_appwrite-0.1.2.tar.gz.

File metadata

  • Download URL: mcp_server_appwrite-0.1.2.tar.gz
  • Upload date:
  • Size: 252.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mcp_server_appwrite-0.1.2.tar.gz
Algorithm Hash digest
SHA256 b72ef2080ea4817191e900b3db34e2a35bcdb9351890e7faf7836e46750bd39d
MD5 b5ba9a3683b91a0c58de099dfbb51e41
BLAKE2b-256 be3883afd66a41c00254568f3ae874111661d2b6ae07b32465b65b253f530497

See more details on using hashes here.

File details

Details for the file mcp_server_appwrite-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_appwrite-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a191d555ea450bd52aed649a36046d6d6bc319987cd04d3e8d588a5658c41f43
MD5 b8d55b01c49540d4a576a650b35fe341
BLAKE2b-256 490d5635fe5a815f63e9f7c922d87363d3d067d3c3d3906dddc91ad3f6963a05

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page