Get started quickly with these pre-built prompts for common Appwrite integrations:

Connect Appwrite MCP servers to VS Code for deeper integration with the Appwrite API and documentation.

Pre-requisites

Before you begin, ensure you have the following pre-requisites installed on your system:

  • MCP must be installed on your system.
  • Node.js and npm must be installed on your system.

Configuration Steps

  1. In VS Code, open the Command Palette (press CTRL + Shift + P on Windows or CMD + Shift + P on MacOS) and run the MCP: Open User Configuration command.

  2. Choose which MCP servers you want to configure:

  • Update the mcp.json file to include the API server:

    {
        "project_id": "your-project-id",
        "api_key": "your-api-key",
        "region": "<REGION>"
    }
    
    • Update the mcp.json file to include the docs server:
    {
        "docs": "your-docs-server"
    }
    
  1. Once you save the configuration, Copilot Chat will connect with the MCP server(s) and load all available tools.

Open Copilot Chat

Open Copilot Chat in VS Code and switch to Agent Mode to test your MCP integrations. You can try out the following example prompts based on the MCP server you have configured:

Example prompts:

  • Create a new user in my Appwrite project
  • List all databases in my project
  • Show me the collections in my database
  • Create a new document in my collection
  • Delete a specific user by ID

Additional Prompts:

  • How do I set up real-time subscriptions in Appwrite?
  • Show me how to authenticate users with OAuth
  • What are the best practices for database queries?
  • How do I implement file uploads with Appwrite Storage?
  • Show me an example of using Appwrite Functions