The fastest way to get started with Appwrite in Codex is to install the Appwrite plugin from the Appwrite marketplace. The plugin includes agent skills for the Appwrite CLI and all major SDKs and registers the Appwrite Docs MCP server, giving Codex access to the Appwrite documentation so that it follows the latest and suggested code patterns.
Add the Appwrite marketplace to Codex by running the following command in your terminal:
codex plugin marketplace add appwrite/codex-plugin
Then run codex and open the plugins menu to install the Appwrite plugin:
- Run
/pluginsin Codex. - Select the Appwrite plugin from the marketplace listing.
- Confirm the install.
Once installed, the language and deployment skills load automatically based on your task, and the appwrite-docs MCP server is registered for documentation lookups.
The Appwrite API MCP server isn't bundled in the plugin: it needs your endpoint, project ID, and API key, and Codex plugins don't currently expose a way to prompt for per-install configuration in the CLI. Add it manually in Step 3.
Prefer manual setup?
If you'd rather configure MCP servers individually, skip to Step 3.
Get started quickly with these pre-built prompts for common Appwrite integrations:
Browse all quick start prompts
If you installed the Appwrite plugin in Step 1, the docs MCP server is already configured and you can skip to Step 4.
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:
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)
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
