Servidor MCP de Appwrite
Visión general
Un servidor de Protocolo de Contexto de Modelo para interactuar con la API de Appwrite. Este servidor proporciona herramientas para gestionar bases de datos, usuarios, funciones, equipos y mucho más dentro de tu proyecto Appwrite.
Enlaces rápidos
- Configuración
- Instalación
- Integración IDE
- Desarrollo local
- Depuración
Configuración
Antes de lanzar el servidor MCP, debe configurar un proyecto Appwrite y crear una clave API con los ámbitos necesarios habilitados.
Cree un archivo .env
en su directorio de trabajo y añada lo siguiente:
APPWRITE_PROJECT_ID=tu-id-proyecto APPWRITE_API_KEY=tu-clave-api APPWRITE_ENDPOINT=https://<REGION>.cloud.appwrite.io/v1
A continuación, abra su terminal y ejecute el siguiente comando
Linux y MacOS
fuente .env
Windows
Símbolo del sistema
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") }
Instalación
Uso de uv (recomendado)
Al utilizar uv
no es necesaria ninguna instalación específica. Utilizaremos uvx
para ejecutar directamente mcp-server-appwrite.
uvx mcp-server-appwrite [args]
Usando pip
pip install mcp-servidor-appwrite
A continuación, ejecute el servidor utilizando
python -m mcp_server_appwrite [args]
Argumentos de la línea de comandos
Tanto el proceso de instalación uv
como pip
requieren ciertos argumentos para habilitar las herramientas MCP para varias APIs de Appwrite.
Cuando se habilita una herramienta MCP, la definición de la herramienta se pasa al LLM, utilizando tokens de la ventana de contexto disponible del modelo. Como resultado, la ventana de contexto efectiva se reduce.
El servidor MCP predeterminado de Appwrite sólo tiene activadas las herramientas de bases de datos (nuestra API más utilizada) para mantenerse dentro de estos límites. Herramientas adicionales pueden ser habilitadas usando las siguientes banderas.
Argumento | Descripción |
---|---|
--databases | Habilita la API de bases de datos |
--users | Activa la API de usuarios |
--Equipos | Activa la API de equipos |
--Almacenamiento | Activa la API de almacenamiento |
--Funciones | Activa la API de funciones |
--Mensajería | Activa la API de mensajería |
--Configuración regional | Activa la API de configuración regional |
--avatares | Activa la API de avatares |
--Sitios | Activa la API de sitios |
--todos | Activa todas las API de Appwrite |
Uso con Claude Desktop
En la aplicación Claude Desktop, abre la página de Configuración de la aplicación (pulsa CTRL + ,
en Windows o CMD + ,
en MacOS) y dirígete a la pestaña Desarrollador. Haciendo clic en el botón Editar Configuración te llevará al archivo claude_desktop_config.json
, donde debes añadir lo siguiente:
{ "mcpServers": { "appwrite": { "command": "uvx", "args": [ "mcp-server-appwrite" ], "env": { "APPWRITE_PROJECT_ID": "<SU_PROYECTO_ID>", "APPWRITE_API_KEY": "<SU_CLAVE_API>", "APPWRITE_ENDPOINT": "https://<REGION>.cloud.appwrite.io/v1" // Opcional } } }
Nota: En caso de que aparezca un error
uvx ENOENT
, asegúrese de añadiruvx
a la variable de entornoPATH
de su sistema o utilice la ruta completa a su instalación deuvx
en el archivo de configuración.
Una vez configurado correctamente, debería poder ver el servidor en la lista de servidores disponibles en Claude Desktop.
Uso con Cursor
Vaya a Configuración de Cursor > MCP
y haga clic en Añadir nuevo servidor MCP. Elija el tipo como Comando
y añada el siguiente comando al campo Comando.
- MacOS
env APPWRITE_API_KEY=tu-clave-api env APPWRITE_PROJECT_ID=tu-id-proyecto uvx mcp-server-appwrite
- Windows
cmd /c SET APPWRITE_PROJECT_ID=su_proyecto-id && SET APPWRITE_API_KEY=su_api-key && uvx mcp-server-appwrite
Uso con Windsurf Editor
Dirígete a Windsurf Settings > Cascade > Model Context Protocol (MCP) Servers
y haz click en View raw config. Actualiza el archivo mcp_config.json
para incluir lo siguiente:
{ "mcpServers": { "appwrite": { "command": "uvx", "args": [ "mcp-server-appwrite" ], "env": { "APPWRITE_PROJECT_ID": "<SU_PROYECTO_ID>", "APPWRITE_API_KEY": "<SU_CLAVE_API>", "APPWRITE_ENDPOINT": "https://<REGION>.cloud.appwrite.io/v1" // Opcional } } }
Uso con VS Code
Configuración
Actualice el archivo de configuración de MCP: Abra la paleta de comandos
(Ctrl+Shift+P
oCmd+Shift+P
) y ejecuteMCP: Open User Configuration
. Debería abrir el archivomcp.json
en tu configuración de usuario.Añade la configuración del servidor MCP de Appwrite: Añade lo siguiente al archivo
mcp.
json:
{ "servers": { "appwrite": { "command": "uvx", "args": ["mcp-server-appwrite", "--users"], "env": {"APPWRITE_PROJECT_ID": "<SU_PROYECTO_ID>", "APPWRITE_API_KEY": "<SU_CLAVE_API>", "APPWRITE_ENDPOINT": "https://<REGION>.cloud.appwrite.io/v1" } } }
Inicie el servidor MCP: Abra la paleta de comandos
(Ctrl+Mayús+P
oCmd+Mayús+P
) y ejecuteMCP: List Servers
. En el desplegable, seleccionaappwrite
y haz clic en el botón Iniciar servidor.Uso en Copilot Chat: Abra Copilot Chat y cambie al modo Agente para acceder a las herramientas de Appwrite.
Desarrollo local
Clone el repositorio
git clone https://github.com/appwrite/mcp.git
Instalar uv
- Linux o MacOS
curl -LsSf https://astral.sh/uv/install.sh | sh
- Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
Preparar el entorno virtual
En primer lugar, cree un entorno virtual.
uv venv
A continuación, active el entorno virtual.
- Linux o MacOS
source .venv/bin/activate
- Windows
.venv\Scripts\activar
Ejecute el servidor
uv run -v --directorio ./ mcp-server-appwrite
Depuración
Puede utilizar el inspector MCP para depurar el servidor.
npx @modelcontextprotocol/inspector \ uv \ --directory . \ ejecutar mcp-server-appwrite
Asegúrese de que su archivo .env
está correctamente configurado antes de ejecutar el inspector. A continuación, puede acceder al inspector en http://localhost:5173.
Licencia
Este servidor MCP está licenciado bajo la Licencia MIT. Esto significa que usted es libre de usar, modificar y distribuir el software, sujeto a los términos y condiciones de la Licencia MIT. Para más detalles, consulte el archivo LICENSE en el repositorio del proyecto.