基本能力
产品定位
Appwrite MCP server 是一个用于与Appwrite API交互的模型上下文协议服务器,旨在简化Appwrite项目的管理和开发流程。
核心功能
- 管理Appwrite项目中的数据库、用户、函数、团队等功能
- 支持多种IDE集成(Claude Desktop、Cursor、Windsurf Editor)
- 提供本地开发和调试工具
- 支持多种API(Databases、Users、Teams、Storage、Functions、Messaging、Locale、Avatars)
适用场景
- 开发者在Appwrite项目中进行数据库管理
- 需要与Appwrite API交互的自动化任务
- 团队协作和用户管理
- 本地开发和调试Appwrite项目
工具列表
- Databases API: 管理Appwrite项目中的数据库
- Users API: 管理用户信息
- Teams API: 管理团队信息
- Storage API: 管理存储资源
- Functions API: 管理函数
- Messaging API: 管理消息
- Locale API: 管理本地化信息
- Avatars API: 管理头像
常见问题解答
- uvx ENOENT错误: 确保
uvx
已添加到系统的PATH
环境变量中,或在配置文件中使用uvx
的完整路径。 - 环境变量配置: 确保
.env
文件正确配置了APPWRITE_PROJECT_ID
和APPWRITE_API_KEY
。
使用教程
使用依赖
- 创建一个Appwrite项目并生成API密钥。
- 在项目目录中创建
.env
文件,并添加以下内容:
env
APPWRITE_PROJECT_ID=your-project-id
APPWRITE_API_KEY=your-api-key
APPWRITE_ENDPOINT=https://cloud.appwrite.io/v1 - 加载环境变量:
- Linux和MacOS:
sh
source .env - Windows (Command Prompt):
cmd
for /f "tokens=1,2 delims==" %A in (.env) do set %A=%B - Windows (PowerShell):
powershell
Get-Content .\.env | ForEach-Object {
if ($_ -match '^(.*?)=(.*)$') {
[System.Environment]::SetEnvironmentVariable($matches[1], $matches[2], "Process")
}
}
安装教程
- 使用
uv
安装(推荐):
bash
uvx mcp-server-appwrite [args] - 使用
pip
安装:
bash
pip install mcp-server-appwrite
python -m mcp_server_appwrite [args]
调试方式
- 使用MCP inspector调试服务器:
bash
npx @modelcontextprotocol/inspector \
uv \
--directory . \
run mcp-server-appwrite - 访问调试界面:
- 打开浏览器,访问
http://localhost:5173
。
本地开发
- 克隆仓库:
bash
git clone https://github.com/appwrite/mcp.git - 安装
uv
: - Linux或MacOS:
bash
curl -LsSf https://astral.sh/uv/install.sh | sh - Windows (PowerShell):
powershell
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" - 创建并激活虚拟环境:
bash
uv venv
source .venv/bin/activate # Linux/MacOS
.venv\Scripts\activate # Windows - 运行服务器:
bash
uv run -v --directory ./ mcp-server-appwrite