Serveur Appwrite MCP

Vue d'ensemble

Un serveur Model Context Protocol pour interagir avec l'API d'Appwrite. Ce serveur fournit des outils pour gérer les bases de données, les utilisateurs, les fonctions, les équipes, etc. dans votre projet Appwrite.

Liens rapides

• Configuration du serveur
• Installation (en anglais)
• Intégration IDE
  • Bureau Claude
  • Curseur
  • Editeur Windsurf
  • VS Code
• Développement local
• Débogage

Configuration

Avant de lancer le serveur MCP, vous devez configurer un projet Appwrite et créer une clé API avec les scopes nécessaires activés.

Créez un fichier .env dans votre répertoire de travail et ajoutez les éléments suivants :

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

Ensuite, ouvrez votre terminal et exécutez la commande suivante

Linux et MacOS

source .env

Windows

Invite de commande

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") } } }

Installation

Utilisation d'uv (recommandé)

L'utilisation de uv ne nécessite aucune installation spécifique. Nous utiliserons uvx pour exécuter directement mcp-server-appwrite.

uvx mcp-server-appwrite [args]

Utilisation de pip

pip install mcp-server-appwrite

Lancez ensuite le serveur en utilisant

python -m mcp_server_appwrite [args]

Arguments de la ligne de commande

Les processus d'installation uv et pip requièrent certains arguments afin d'activer les outils MCP pour les différentes API Appwrite.

Lorsqu'un outil MCP est activé, la définition de l'outil est transmise au LLM, en utilisant les jetons de la fenêtre de contexte disponible du modèle. En conséquence, la fenêtre de contexte effective est réduite.

Le serveur Appwrite MCP par défaut est livré avec seulement les outils Databases (notre API la plus utilisée) activés pour rester dans ces limites. Des outils supplémentaires peuvent être activés en utilisant les drapeaux ci-dessous.

Utilisation avec Claude Desktop

Dans l'application Claude Desktop, ouvrez la page Paramètres de l'application (appuyez sur CTRL + , sous Windows ou CMD + , sous MacOS) et dirigez-vous vers l'onglet Développeur. En cliquant sur le bouton Edit Config, vous accéderez au fichier claude_desktop_config.json, dans lequel vous devrez ajouter les éléments suivants :

{ "mcpServers" : { "appwrite" : {"command" : "uvx", "args" : ["mcp-server-appwrite" ], "env" : { "APPWRITE_PROJECT_ID" : "<VOTRE_PROJET_ID>", "APPWRITE_API_KEY" : "<VOTRE_CLÉ_API>", "APPWRITE_ENDPOINT" : "https://<REGION>.cloud.appwrite.io/v1" // Facultatif } } }

Note : Si vous obtenez une erreur ENOENT de uvx, assurez-vous d'ajouter uvx à la variable d'environnement PATH de votre système ou d'utiliser le chemin complet de votre installation uvx dans le fichier de configuration.

Une fois la configuration réussie, vous devriez pouvoir voir le serveur dans la liste des serveurs disponibles dans Claude Desktop.

Utilisation avec le curseur

Allez dans Paramètres du curseur > MCP et cliquez sur Ajouter un nouveau serveur MCP. Choisissez le type comme Commande et ajoutez la commande ci-dessous dans le champ Commande.

• MacOS

env APPWRITE_API_KEY=votre-api-clé env APPWRITE_PROJECT_ID=votre-projet-id uvx mcp-server-appwrite

• Windows

cmd /c SET APPWRITE_PROJECT_ID=votre-projet-id && SET APPWRITE_API_KEY=votre-clé-api-key && uvx mcp-server-appwrite

Utilisation avec l'éditeur Windsurf

Allez dans Windsurf Settings > Cascade > Model Context Protocol (MCP) Servers et cliquez sur View raw config. Mettez à jour le fichier mcp_config.json pour y inclure ce qui suit :

{ "mcpServers" : { "appwrite" : { "command" : "uvx", "args" : ["mcp-server-appwrite" ], "env" : { "APPWRITE_PROJECT_ID" : "<VOTRE_PROJET_ID>", "APPWRITE_API_KEY" : "<VOTRE_CLÉ_API>", "APPWRITE_ENDPOINT" : "https://<REGION>.cloud.appwrite.io/v1" // Facultatif } } }

Utilisation avec VS Code

Configuration

1. Mettez à jour le fichier de configuration MCP: Ouvrez la palette de commandes(Ctrl+Shift+P ou Cmd+Shift+P) et exécutez MCP : Open User Configuration. Cela devrait ouvrir le fichier mcp.json dans vos paramètres utilisateur.

2. Ajoutez la configuration du serveur Appwrite MCP: Ajoutez les éléments suivants au fichier mcp.json:

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

3. Démarrez le serveur MCP: Ouvrez la palette de commandes(Ctrl+Shift+P ou Cmd+Shift+P) et exécutez MCP : List Servers. Dans la liste déroulante, sélectionnez appwrite et cliquez sur le bouton Start Server.

4. Utilisation dans Copilot Chat: Ouvrez Copilot Chat et passez en mode agent pour accéder aux outils Appwrite.

Développement local

Cloner le dépôt

git clone https://github.com/appwrite/mcp.git

Installer uv

• Linux ou MacOS

curl -LsSf https://astral.sh/uv/install.sh | sh

• Windows (PowerShell)

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Préparer l'environnement virtuel

Commencez par créer un environnement virtuel.

uv venv

Ensuite, activez l'environnement virtuel.

• Linux ou MacOS

source .venv/bin/activate

• Windows

.venv\Scripts\activate

Exécutez le serveur

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

Débogage

Vous pouvez utiliser l'inspecteur MCP pour déboguer le serveur.

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

Assurez-vous que votre fichier .env est correctement configuré avant d'exécuter l'inspecteur. Vous pouvez ensuite accéder à l'inspecteur à l'adresse http://localhost:5173.

Licence

Ce serveur MCP est sous licence MIT. Cela signifie que vous êtes libre d'utiliser, de modifier et de distribuer le logiciel, sous réserve des termes et conditions de la licence MIT. Pour plus de détails, veuillez consulter le fichier LICENSE dans le référentiel du projet.