MCP-сервер Appwrite

mcp-name: io.github.appwrite/mcp-for-api

Обзор

Сервер протокола контекста модели (MCP) для взаимодействия с API Appwrite. Этот сервер предоставляет инструменты для управления базами данных, пользователями, функциями, командами и многим другим в вашем проекте Appwrite.

Related MCP server: Directus MCP Server

Быстрые ссылки

• Конфигурация

• Установка

• Интеграция с IDE:

  • Claude Desktop

  • Cursor

  • Windsurf Editor

  • VS Code

• Локальная разработка

• Отладка

Конфигурация

Перед запуском MCP-сервера необходимо настроить проект Appwrite и создать ключ API с включенными необходимыми областями доступа (scopes).

Сервер проверяет учетные данные и области доступа, необходимые для встроенного набора сервисов Appwrite, во время запуска. Если конечная точка, ID проекта, ключ API или области доступа указаны неверно, MCP-сервер завершит работу с ошибкой, вместо того чтобы ждать сбоя при первом вызове инструмента.

Создайте файл .env в вашей рабочей директории и добавьте следующее:

APPWRITE_PROJECT_ID=your-project-id
APPWRITE_API_KEY=your-api-key
APPWRITE_ENDPOINT=https://<REGION>.cloud.appwrite.io/v1

Затем откройте терминал и выполните следующую команду

Linux и MacOS

source .env

Windows

Командная строка (Command Prompt)

for /f "tokens=1,2 delims==" %A in (.env) do set %A=%B

PowerShell

Get-Content .\.env | ForEach-Object {
  if ($_ -match '^(.*?)=(.*)$') {
    [System.Environment]::SetEnvironmentVariable($matches[1], $matches[2], "Process")
  }
}

Установка

Использование uv (рекомендуется)

При использовании uv специальная установка не требуется. Мы будем использовать uvx для прямого запуска mcp-server-appwrite.

uvx mcp-server-appwrite

Использование pip

pip install mcp-server-appwrite

Затем запустите сервер с помощью

python -m mcp_server_appwrite

Поверхность инструментов

Сервер больше не принимает флаги выбора сервиса или режима. Он всегда запускается в компактном рабочем процессе, поэтому MCP-клиент видит только небольшую поверхность операторского типа, в то время как полный каталог Appwrite остается внутренним.

• Модели доступны только 2 инструмента MCP:

  • appwrite_search_tools

  • appwrite_call_tool

• Полный каталог инструментов Appwrite остается внутренним и ищется во время выполнения.

• Большие выходные данные инструментов сохраняются как ресурсы MCP и возвращаются в виде текста предварительного просмотра плюс URI ресурса.

• Для изменения скрытых инструментов требуется confirm_write=true.

• Сервер автоматически регистрирует все поддерживаемые сервисы Appwrite, за исключением устаревшего API баз данных.

Если у вас остались старые конфигурации MCP, которые передают флаги, такие как --mode или --users, удалите их.

Использование с Claude Desktop

В приложении Claude Desktop откройте страницу Настройки (нажмите CTRL + , в Windows или CMD + , в MacOS) и перейдите на вкладку Разработчик (Developer). Нажатие кнопки Редактировать конфигурацию (Edit Config) откроет файл 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": "https://<REGION>.cloud.appwrite.io/v1" // Optional
      }
    }
  }
}

Примечание: Если вы видите ошибку uvx ENOENT, убедитесь, что вы либо добавили uvx в переменную окружения PATH в вашей системе, либо используете полный путь к вашей установке uvx в файле конфигурации.

После успешной настройки вы сможете увидеть сервер в списке доступных серверов в Claude Desktop.

Использование с Cursor

Перейдите в Settings > MCP в Cursor и нажмите Add new MCP server. Выберите тип Command и добавьте приведенную ниже команду в поле Command.

• MacOS

env APPWRITE_API_KEY=your-api-key env APPWRITE_PROJECT_ID=your-project-id uvx mcp-server-appwrite

• Windows

cmd /c SET APPWRITE_PROJECT_ID=your-project-id && SET APPWRITE_API_KEY=your-api-key && uvx mcp-server-appwrite

Использование с Windsurf Editor

Перейдите в Settings > Cascade > Model Context Protocol (MCP) Servers в Windsurf и нажмите View raw config. Обновите файл mcp_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": "https://<REGION>.cloud.appwrite.io/v1" // Optional
      }
    }
  }
}

Использование с VS Code

Конфигурация

1. Обновите файл конфигурации MCP: Откройте палитру команд (Ctrl+Shift+P или Cmd+Shift+P) и выполните MCP: Open User Configuration. Должен открыться файл mcp.json в ваших пользовательских настройках.

2. Добавьте конфигурацию MCP-сервера Appwrite: Добавьте следующее в файл mcp.json:

{
  "servers": {
    "appwrite": {
      "command": "uvx",
      "args": ["mcp-server-appwrite"],
      "env": {
        "APPWRITE_PROJECT_ID": "<YOUR_PROJECT_ID>",
        "APPWRITE_API_KEY": "<YOUR_API_KEY>",
        "APPWRITE_ENDPOINT": "https://<REGION>.cloud.appwrite.io/v1"
      }
    }
  }
}

3. Запустите MCP-сервер: Откройте палитру команд (Ctrl+Shift+P или Cmd+Shift+P) и выполните MCP: List Servers. В выпадающем списке выберите appwrite и нажмите кнопку Start Server.

4. Используйте в Copilot Chat: Откройте Copilot Chat и переключитесь в режим агента (Agent Mode), чтобы получить доступ к инструментам Appwrite.

Локальная разработка

Клонирование репозитория

git clone https://github.com/appwrite/mcp-for-api.git

Установка 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"

Подготовка виртуального окружения

Сначала создайте виртуальное окружение.

uv venv

Затем активируйте виртуальное окружение.

• Linux или MacOS

source .venv/bin/activate

• Windows

.venv\Scripts\activate

Запуск сервера

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

Тестирование

Модульные тесты

uv run python -m unittest discover -s tests/unit -v

Интеграционные тесты в реальном времени

Эти тесты создают и удаляют реальные ресурсы Appwrite в реальном проекте Appwrite. Они запускаются автоматически, если в окружении или файле .env доступны действительные учетные данные Appwrite.

uv run --extra integration python -m unittest discover -s tests/integration -v

Отладка

Вы можете использовать инспектор MCP для отладки сервера.

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

Перед запуском инспектора убедитесь, что ваш файл .env настроен правильно. Затем вы сможете получить доступ к инспектору по адресу http://localhost:5173.

Лицензия

Этот MCP-сервер лицензирован по лицензии MIT. Это означает, что вы можете свободно использовать, изменять и распространять программное обеспечение в соответствии с условиями лицензии MIT. Для получения более подробной информации, пожалуйста, ознакомьтесь с файлом LICENSE в репозитории проекта.