-
Notifications
You must be signed in to change notification settings - Fork 322
Add Codex plugin #2987
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
adityaoberai
wants to merge
7
commits into
main
Choose a base branch
from
add-codex-plugin
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add Codex plugin #2987
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
1303546
Add Codex plugin announcement + changelog + docs update
adityaoberai fb626f5
Merge branch 'main' into add-codex-plugin
adityaoberai 3c7a7c9
Update src/routes/docs/tooling/ai/ai-dev-tools/codex/+page.markdoc
adityaoberai 8f04952
Update src/routes/docs/tooling/ai/ai-dev-tools/codex/+page.markdoc
adityaoberai ef0f48b
update cover
adityaoberai 2f3e595
optimize assets
adityaoberai fe4f0eb
Add FAQs + other edits
adityaoberai File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
65 changes: 65 additions & 0 deletions
65
src/routes/blog/post/announcing-appwrite-codex-plugin/+page.markdoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| --- | ||
| layout: post | ||
| title: "Introducing the Appwrite plugin for Codex: Skills and MCP in one install" | ||
| description: The Appwrite plugin for Codex bundles agent skills and the Appwrite Docs MCP server into a single install, so Codex can build with Appwrite out of the box. | ||
| date: 2026-05-11 | ||
| cover: /images/blog/announcing-appwrite-codex-plugin/cover.png | ||
| timeToRead: 4 | ||
| author: aditya-oberai | ||
| category: announcement | ||
| featured: false | ||
| --- | ||
|
|
||
| Codex is OpenAI's terminal-resident coding agent. It reads, writes, and runs code against your project, and it has been steadily picking up the building blocks needed to work well with platforms like Appwrite: skills for language-specific context, MCP servers for live tool and documentation access, and a marketplace for distributing them. Using Codex with Appwrite has worked for a while, but getting set up meant copying skill files into `~/.codex/skills/`, hand-editing `~/.codex/config.toml` to register the docs MCP, and stitching everything together yourself. | ||
|
|
||
| Today, we are announcing the **Appwrite plugin for Codex**. Add the marketplace, install the plugin, and your agent is ready to build with Appwrite using up-to-date SDK patterns and live access to the Appwrite documentation. | ||
|
|
||
| # What installing the plugin gives you | ||
|
|
||
| The plugin ships two things in a single install: | ||
|
|
||
| - **The Appwrite Docs MCP server:** No credentials required. Codex can search the Appwrite documentation as it works, instead of relying on whatever it was trained on. | ||
| - **Thirteen agent skills:** Markdown skills covering the Appwrite CLI and every major Appwrite SDK (TypeScript, Dart, .NET, Go, Kotlin, PHP, Python, Ruby, Rust, and Swift), plus two guided deployment skills for shipping Appwrite Sites and Functions with the Appwrite CLI. Codex loads the relevant skill on its own when a task calls for it, and the deployment skills can also be invoked explicitly with `$appwrite-deploy-site` and `$appwrite-deploy-function`. | ||
|
|
||
| # Setup the plugin | ||
|
greptile-apps[bot] marked this conversation as resolved.
|
||
|
|
||
| 1. Add the Appwrite marketplace to Codex by running the following command in your terminal: | ||
|
|
||
| ```bash | ||
| codex plugin marketplace add appwrite/codex-plugin | ||
| ``` | ||
|
|
||
| 2. Start Codex by running `codex`. | ||
| 3. Open the plugins menu with `/plugins`. | ||
| 4. Select **Appwrite** from the marketplace listing and confirm the install. | ||
|
|
||
| The skills and the `appwrite-docs` MCP server are wired up automatically. | ||
|
|
||
| ## Why the API MCP server isn't bundled | ||
|
|
||
| The Appwrite API MCP server needs three values to talk to your project: your endpoint, project ID, and API key. Codex plugins don't currently expose a way to prompt for and inject per-install configuration like that in the CLI, so shipping the API MCP inside the plugin would mean hard-coding credentials, which isn't something we want to do. The docs MCP, which doesn't need credentials, is bundled. | ||
|
|
||
| To add the API MCP server, run this in your terminal: | ||
|
|
||
| ```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 | ||
| ``` | ||
|
|
||
| # A prompt to try first | ||
|
|
||
| Once the plugin is active, try a prompt like: | ||
|
|
||
| `Scaffold a Next.js app that uses Appwrite for email/password auth and a "todos" table.` | ||
|
|
||
| Codex picks up the `appwrite-typescript` and `appwrite-cli` skills, queries the Appwrite Docs MCP server when it needs to confirm specifics, and generates code that uses the right SDK calls instead of guessed ones. When you are ready to ship, ask it to deploy with the Appwrite CLI and the `$appwrite-deploy-site` skill walks it through the steps. | ||
|
|
||
| # Resources | ||
|
|
||
| - [Codex plugin docs](/docs/tooling/ai/ai-dev-tools/codex) | ||
| - [Plugin source code on GitHub](https://github.com/appwrite/codex-plugin) | ||
| - [Appwrite Skills](/docs/tooling/ai/skills) | ||
| - [Discord community](https://appwrite.io/discord) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| layout: changelog | ||
| title: "Appwrite plugin for Codex" | ||
| date: 2026-05-11 | ||
| cover: /images/blog/announcing-appwrite-codex-plugin/cover.png | ||
| --- | ||
|
|
||
| The Appwrite plugin is now available for Codex. Install it to get agent skills for the Appwrite CLI and every major SDK, two guided deployment skills for Sites and Functions, and the Appwrite Docs MCP server, all in a single setup. | ||
|
|
||
| {% arrow_link href="/blog/post/announcing-appwrite-codex-plugin" %} | ||
| Read the announcement | ||
| {% /arrow_link %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably should have FAQ, especially around why API MCP is not supported. We do cover it in the article, but FAQs should be good here in frontmatter