MCP Server Appwrite

🚀 Appwrite MCP 服務器

這是一個用於與 Appwrite API 交互的模型上下文協議（Model Context Protocol）服務器，提供管理數據庫、用戶、函數、團隊等功能的工具，極大地提升了與 Appwrite API 交互的便捷性和效率。

🚀 快速開始

你可以通過以下快速鏈接，快速瞭解服務器的配置、安裝、集成開發環境以及本地開發等相關內容：

• 配置
• 安裝
• 集成開發環境：
  • VS Code
  • PyCharm
  • WebStorm
• 本地開發

✨ 主要特性

該服務器主要用於與 Appwrite API 交互，具備管理數據庫、用戶、函數、團隊等功能，為開發者提供了一系列強大的工具，方便對 Appwrite 項目進行管理和開發。

📦 安裝指南

使用 uv 安裝

• Linux 或 MacOS：

curl -LsSf https://astral.sh/uv/install.sh | sh

• Windows（PowerShell）：

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

使用 pip 安裝

pip install mcp-server-appwrite

📚 詳細文檔

配置

要使用 MCP 服務器，請按照以下步驟進行配置：

1. 在項目根目錄下創建一個 .env 文件。
2. 將以下內容添加到 .env 文件中：

APPWRITE_PROJECT_ID=your_project_id
APPWRITE_API_KEY=your_api_key

3. 根據需要更新 APPWRITE_ENDPOINT 環境變量（可選）。

集成開發環境

VS Code

1. 在項目根目錄下創建或更新 settings.json 文件。
2. 添加以下內容：

{
  "mcp.servers.appwrite": {
    "command": "uv",
    "args": [
      "mcp-server-appwrite"
    ],
    "env": {
      "APPWRITE_PROJECT_ID": "your_project_id",
      "APPWRITE_API_KEY": "your_api_key"
    }
  }
}

PyCharm

1. 打開項目設置。
2. 轉到 MCP 選項卡。
3. 添加以下內容：

{
  "mcpServers": {
    "appwrite": {
      "command": "uv",
      "args": [
        "mcp-server-appwrite"
      ],
      "env": {
        "APPWRITE_PROJECT_ID": "your_project_id",
        "APPWRITE_API_KEY": "your_api_key"
      }
    }
  }
}

WebStorm

1. 打開項目設置。
2. 轉到 MCP 選項卡。
3. 添加以下內容：

{
  "mcpServers": {
    "appwrite": {
      "command": "uv",
      "args": [
        "mcp-server-appwrite"
      ],
      "env": {
        "APPWRITE_PROJECT_ID": "your_project_id",
        "APPWRITE_API_KEY": "your_api_key"
      }
    }
  }
}

本地開發

克隆倉庫

git clone https://github.com/appwrite/mcp.git

安裝虛擬環境

1. 創建虛擬環境：

uv venv

2. 激活虛擬環境：

• Linux 或 MacOS：

source .venv/bin/activate

• Windows：

.venv\Scripts\activate

3. 運行服務器：

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

調試

使用 MCP inspector 進行調試：

npx @modelcontextprotocol/inspector \
  uv \
  --directory . \
  run mcp-server-appwrite

確保 .env 文件已正確配置。調試完成後，訪問 http://localhost:5173 查看結果。

📄 許可證

該 MCP 服務器根據 MIT 許可證分發。這意味著您可以自由使用、修改和分發軟件，但需遵守 MIT 許可證的條款和條件。更多詳細信息，請參閱項目倉庫中的 LICENSE 文件。