Appwrite MCP Server 使用说明

项目简介

Appwrite MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在将 Appwrite 后端服务以标准化的方式提供给 LLM 客户端。通过此服务器，开发者可以在支持 MCP 协议的 LLM 应用或代码编辑器（如 Claude Desktop, Zed, Cursor）中，直接利用 Appwrite 提供的各种功能，例如数据库操作、用户管理、云函数调用等。

主要功能点

资源访问 (Resources): 虽然仓库描述中没有明确提及“资源”，但通过集成 Appwrite 服务，实际上提供了对 Appwrite 后端资源的访问能力，例如数据库中的文档、用户数据、存储文件等。这些可以被视为广义的资源。
工具注册和执行 (Tools): 核心功能，将 Appwrite 的各项服务（Databases, Users, Functions, Teams, Storage, Locale, Avatars, Messaging）封装成可被 LLM 调用的工具。目前已支持 Databases 和 Users 服务，并计划支持更多服务。
Prompt 模板 (Prompts): 仓库本身不直接涉及 Prompt 模板，但作为 MCP 服务器，它可以与支持 Prompt 模板的 MCP 客户端协同工作，为 LLM 应用提供更灵活的交互模式。
JSON-RPC 协议: 基于 MCP 协议，使用 JSON-RPC 与客户端通信，接收和响应客户端的工具调用请求。
可扩展性: 通过模块化的服务注册机制，易于扩展支持更多的 Appwrite 服务或自定义功能。
多种客户端集成: 提供与 Claude Desktop, Zed, Cursor 等主流 LLM 应用和代码编辑器的集成配置示例。

安装步骤

安装 'mcp-server-appwrite' 包:

pip install mcp-server-appwrite

或者使用 'uv' (推荐):

uvx run mcp-server-appwrite

配置环境变量: 创建 '.env' 文件，并填入你的 Appwrite 项目和 API Key 信息。

APPWRITE_PROJECT_ID=your-project-id
APPWRITE_API_KEY=your-api-key
APPWRITE_ENDPOINT=your-endpoint  # 可选，默认为 https://cloud.appwrite.io/v1

注意: 确保你的 API Key 具有访问所需 Appwrite 资源的权限。

服务器配置 (MCP 客户端)

以下是在支持 MCP 协议的客户端中配置 Appwrite MCP Server 的示例。你需要配置 MCP 服务器的启动命令 (command) 及其参数 (args)，以便客户端能与服务器建立连接。

Claude Desktop 配置 ( 'claude_desktop_config.json' ):

{
  "mcpServers": {
    "appwrite": {
      "command": "uvx",
      "args": [
        "mcp-server-appwrite"
      ],
      "env": {
        "APPWRITE_PROJECT_ID": "your-project-id", // 替换为你的 Appwrite 项目ID
        "APPWRITE_API_KEY": "your-api-key",     // 替换为你的 Appwrite API Key
        "APPWRITE_ENDPOINT": "your-endpoint"    // 可选，如果使用自定义 Appwrite Endpoint 请替换
      }
    }
  }
}

Zed 编辑器配置 ( 'settings.json' ):

{
  "context_servers": {
    "appwrite": {
      "command": "uvx",
      "args": [
        "mcp-server-appwrite"
      ],
      "env": {
        "APPWRITE_PROJECT_ID": "your-project-id", // 替换为你的 Appwrite 项目ID
        "APPWRITE_API_KEY": "your-api-key",     // 替换为你的 Appwrite API Key
        "APPWRITE_ENDPOINT": "your-endpoint"    // 可选，如果使用自定义 Appwrite Endpoint 请替换
      }
    }
  }
}

Cursor 编辑器配置 (Cursor Settings > Features > MCP Servers):

Type: Command
Command:
```
APPWRITE_PROJECT_ID=your-project-id APPWRITE_API_KEY=your-api-key uvx mcp-server-appwrite
```
注意: 你需要将 'your-project-id' 和 'your-api-key' 替换为你的实际 Appwrite 项目ID 和 API Key。你也可以选择在 Cursor 的 MCP Server 配置中直接设置 'APPWRITE_ENDPOINT' 环境变量，如果需要连接到非官方 Appwrite Cloud Endpoint 的话。

基本使用方法

确保已安装 'mcp-server-appwrite' 并配置好环境变量。
在 MCP 客户端（如 Claude Desktop, Zed, Cursor）中，根据上述配置示例添加 Appwrite MCP Server。
启动 MCP 客户端，并连接到 Appwrite MCP Server。
在 LLM 应用或代码编辑器中，即可使用 Appwrite 提供的工具，例如查询数据库、管理用户等。具体的工具和使用方式取决于客户端的界面和功能。

本地开发和调试: 如果你需要本地开发或调试 Appwrite MCP Server，可以参考 'README.md' 中的 "Local Development" 和 "Debugging" 章节，使用 'uv venv' 创建虚拟环境，并使用 'npx @modelcontextprotocol/inspector' 进行调试。

关键词