Appwrite MCP Server 使用说明

项目简介

Appwrite MCP Server 旨在为大型语言模型 (LLM) 提供与 Appwrite 后端服务集成的桥梁。通过遵循 Model Context Protocol (MCP)，此服务器允许 LLM 客户端以标准化的方式调用 Appwrite 的各项功能，例如数据库操作、用户管理、文件存储等。

主要功能点

Appwrite 服务集成: 支持将 Appwrite 的 Databases, Users 服务作为 MCP 工具提供给 LLM 客户端，未来计划支持更多 Appwrite 服务。
工具化封装: 将 Appwrite API 封装成易于 LLM 理解和调用的工具，降低 LLM 应用与后端集成的复杂度。
标准化 MCP 协议: 基于 MCP 协议开发，确保与所有兼容 MCP 协议的 LLM 客户端互操作。
灵活部署: 可以通过 'uv' 或 'pip' 快速安装和运行，方便在不同环境部署。
易于配置: 通过环境变量管理 Appwrite 项目配置，简化服务器配置流程。

安装步骤

安装 'mcp-server-appwrite' 包:

推荐使用 'uv' (需先安装 uvx):

uvx run mcp-server-appwrite

或者使用 'pip':

pip install mcp-server-appwrite

配置 Appwrite 环境变量:

在运行服务器的目录中创建 '.env' 文件，并填入您的 Appwrite 项目信息：

APPWRITE_API_KEY=YOUR_APPWRITE_API_KEY
APPWRITE_PROJECT_ID=YOUR_APPWRITE_PROJECT_ID
APPWRITE_ENDPOINT=YOUR_APPWRITE_ENDPOINT # 可选，默认为 https://cloud.appwrite.io/v1

请替换 'YOUR_APPWRITE_API_KEY' 和 'YOUR_APPWRITE_PROJECT_ID' 为您实际的 Appwrite API 密钥和项目 ID。确保 API 密钥拥有访问相关 Appwrite 服务的权限。

服务器配置

为了在 MCP 客户端中使用 Appwrite MCP Server，您需要在客户端中配置服务器连接信息。以下是通用的配置示例 (JSON 格式)，您需要根据您的 MCP 客户端进行配置，通常在客户端的 MCP 服务器设置中添加：

{
  "serverName": "appwrite-mcp-server",  //  自定义服务器名称，用于在客户端中标识
  "command": "uvx",                    //  运行服务器的命令，如果使用 pip 安装，则为 "python"
  "args": [                             //  命令参数
    "mcp-server-appwrite"              //  使用 uvx 运行 mcp-server-appwrite，如果使用 pip 安装，则为 "-m mcp_server_appwrite"
  ],
  "env": {                              //  环境变量，建议在此处配置，客户端启动服务器时会自动设置
    "APPWRITE_PROJECT_ID": "YOUR_APPWRITE_PROJECT_ID",   //  替换为您的 Appwrite 项目 ID
    "APPWRITE_API_KEY": "YOUR_APPWRITE_API_KEY",     //  替换为您的 Appwrite API 密钥
    "APPWRITE_ENDPOINT": "YOUR_APPWRITE_ENDPOINT"      //  可选，Appwrite Endpoint，非默认 endpoint 时配置
  }
}

注意:

如果您使用 'pip install' 安装，请将 '"command"' 修改为 '"python"'， '"args"' 修改为 '["-m", "mcp_server_appwrite"]'。
请务必将 'YOUR_APPWRITE_PROJECT_ID' 和 'YOUR_APPWRITE_API_KEY' 替换为您的实际 Appwrite 项目信息。
'serverName' 可以自定义，用于在 MCP 客户端界面中识别该服务器。
'env' 中的环境变量配置是可选的，您也可以在客户端启动命令的环境变量中直接配置。

基本使用方法

启动 Appwrite MCP Server (根据安装方式，运行 'uvx run mcp-server-appwrite' 或 'python -m mcp_server_appwrite')。
在您的 MCP 客户端（如 Claude Desktop, Zed, Cursor）中，添加并配置 Appwrite MCP Server。
客户端成功连接服务器后，您应该能在工具列表中看到 Appwrite 提供的工具，例如 "databases_listDocuments", "users_create", 等。
在 LLM 交互中，您可以指示 LLM 调用这些工具来操作您的 Appwrite 后端资源。

请参考仓库的 README 文件和您的 MCP 客户端文档获取更详细的使用指导。

关键词

Appwrite MCP Server 使用说明

信息