Get started quickly with these pre-built prompts for common Appwrite integrations:
Browse all quick start prompts
Connect Appwrite MCP servers to Codex for deeper integration with the Appwrite API and documentation.
Before you begin, ensure you have the following pre-requisites installed on your system:
uv must be installed on your system.
No additional prerequisites. The docs server runs as a remote HTTP endpoint.
Run the following commands in your terminal to add the MCP servers:
Bash
codex mcp add appwrite-api \
--env APPWRITE_PROJECT_ID=your-project-id \
--env APPWRITE_API_KEY=your-api-key \
--env APPWRITE_ENDPOINT=https://<REGION>.cloud.appwrite.io/v1 \
-- uvx mcp-server-appwrite
Configuration:
- Replace
your-project-idwith your actual Appwrite project ID - Replace
your-api-keywith your Appwrite API key - Replace
<REGION>with your Appwrite Cloud region (e.g.,nyc,fra)
Bash
codex mcp add appwrite-docs --url https://mcp-for-docs.appwrite.io
Try out the following example prompts based on the MCP server you have configured:
Example prompts:
Create a new user in my Appwrite projectList all databases in my projectShow me the collections in my databaseCreate a new document in my collectionDelete a specific user by ID
Example prompts:
How do I set up real-time subscriptions in Appwrite?Show me how to authenticate users with OAuthWhat are the best practices for database queries?How do I implement file uploads with Appwrite Storage?Show me an example of using Appwrite Functions
