Docs
Skip to content

Tooling

Codex_

Learn how to use Codex with Appwrite through the Appwrite plugin, quick start prompts, and the Appwrite MCP server for AI-assisted development.

2 min read

Raw

1. Install the Appwrite plugin

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, giving Codex the context it needs to follow the latest Appwrite code patterns.

Add the Appwrite marketplace to Codex by running the following command in your terminal:

Bash
codex plugin marketplace add appwrite/codex-plugin

Then run codex and open the plugins menu to install the Appwrite plugin:

  • Run /plugins in 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. Add the remote Appwrite MCP server in Step 3 so Codex can call Appwrite APIs and search the documentation.

2. Quick start prompts

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

3. Add the MCP server

Connect the Appwrite MCP server to Codex for deeper integration with the Appwrite API and documentation. It is a remote HTTP server, so there are no additional pre-requisites to install.

Run the following command in your terminal to add the MCP server:

Bash
codex mcp add appwrite --url https://mcp.appwrite.io/

The server uses OAuth for authentication. In case Codex does not automatically prompt you to login, run the following command to sign in to your Appwrite account and authorize access:

Bash
codex mcp login appwrite

4. Test the integration

Try out the following example prompts:

Example prompts:

  • Create a new user in my Appwrite project
  • List all databases in my project
  • Show me the tables in my database
  • How do I set up real-time subscriptions in Appwrite?
  • Show me how to authenticate users with OAuth
  • How do I implement file uploads with Appwrite Storage?

Codex listing users via the Appwrite MCP server
Codex listing users via the Appwrite MCP server

Was this page helpful?

Share what worked or what we should fix. Once approved, our agents automatically apply suggested updates to the docs.