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
  • Teams
  • Messaging
  • Locale
  • Avatars
  • Storage (Beta)
  • Functions (Beta)

Please note that the Storage and Functions tools are currently in beta and methods like createFile and createDeployment are not yet supported.

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

Configuration

Create a .env file in the root directory based on .env.example:

APPWRITE_API_KEY=your-api-key
APPWRITE_PROJECT_ID=your-project-id
APPWRITE_ENDPOINT=your-endpoint  # Optional, defaults to https://cloud.appwrite.io/v1

Run the server

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

Usage with Claude Desktop

Add this to your claude_desktop_config.json:

"mcpServers": {
  "appwrite": {
    "command": "uv",
    "args": [
      "run",
      "--directory",
      "<path-to-repository>",
      "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": "uv",
    "args": [
      "run",
      "--directory",
      "<path-to-repository>",
      "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 uv run --directory <path_to_repository> mcp-server-appwrite

Cursor Settings

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.0.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.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mcp_server_appwrite-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1a925196bb3baaf7723b43848b8a616c100f52dc095971f866aaca3e97ec3849
MD5 051433281a0ee23f9764e9d4d24af19f
BLAKE2b-256 3211dc7e2620b4c4dad4036ee09d8158b2b423fc58efb2dcbece610f43e175dc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mcp_server_appwrite-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4fc1bdee0f92bf410af458fe4884f03e09b34ccddb7ac49683b92b04a87c3187
MD5 a9527285c2c41ce0a9558205b081c375
BLAKE2b-256 ecdf90b35fd129bbe06bc5fe3d4a85e629fa7357cbda1fd74815ab667cec17be

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