Skip to content

Commit 9a4fffc

Browse files
Aryamanz29claude
andcommitted
docs(codex-plugin): use codex mcp add (the command that actually works)
Empirically reproduced (Codex CLI 0.133.0) — `codex plugin add` writes [marketplaces.atlan] to ~/.codex/config.toml but does NOT write [mcp_servers.atlan]. The plugin entry appears in Plugins → Manage but the MCP server is never registered, so tool discovery returns 0 tools and the agent silently falls back to spawning `codex exec` subprocesses. `codex mcp add atlan --url https://mcp.atlan.com/mcp` writes the proper [mcp_servers.atlan] section AND auto-launches the OAuth flow in one step. No `--type` / `--transport` flag needed — Codex infers HTTP from the URL. Simplify the install section to one command that works. Keep the "Once OpenAI's Plugin Directory is GA" stub for when the official distribution path goes live. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent cda594f commit 9a4fffc

1 file changed

Lines changed: 5 additions & 24 deletions

File tree

codex-plugin/README.md

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,21 @@ Connects Atlan's hosted MCP server (`https://mcp.atlan.com/mcp`) to [OpenAI Code
44

55
## Install
66

7-
> **Note:** OpenAI's official Codex Plugin Directory is not yet GA. The build docs state: *"Adding plugins to the official Plugin Directory is coming soon. Self-serve plugin publishing and management are coming soon."* — see [developers.openai.com/codex/plugins/build](https://developers.openai.com/codex/plugins/build). Until then, Atlan customers install this plugin by registering Atlan's own marketplace — the steps below.
8-
9-
### Sideload from this repository
10-
11-
The repository root ships a marketplace manifest at `.agents/plugins/marketplace.json` that exposes the plugin as `atlan@atlan`.
12-
137
```bash
14-
# Register Atlan's marketplace (point at the GitHub repo, or a local clone's root)
15-
codex plugin marketplace add https://github.com/atlanhq/agent-toolkit
16-
17-
# Install the plugin from that marketplace
18-
codex plugin add atlan@atlan
8+
codex mcp add atlan --url https://mcp.atlan.com/mcp
199
```
2010

21-
Quit and relaunch **Codex.app**the Atlan plugin appears under **Plugins → Manage** (enabled, with the bundled MCP server registered). On first tool call, Codex runs OAuth against `mcp.atlan.com` to authenticate against your Atlan tenant.
11+
Codex detects OAuth support automatically and launches a browser tab to authenticate against `mcp.atlan.com`no API keys or environment variables to manage. Quit and relaunch Codex (Cmd+Q the desktop app, or exit and re-run the CLI) after the auth flow completes so the new MCP server is loaded.
2212

23-
### From the official Codex Plugin Directory (once GA)
13+
### Once OpenAI's Plugin Directory is GA
2414

25-
When OpenAI opens self-serve publishing and Atlan is accepted into the curated Plugin Directory, install via **Codex.app → Plugins → search "Atlan" → Install**, or:
15+
OpenAI's [Codex Plugin Directory](https://developers.openai.com/codex/plugins/build) is not yet generally available. When self-serve publishing opens and Atlan is accepted, install via **Codex.app → Plugins → search "Atlan" → Install**, or:
2616

2717
```bash
2818
codex plugin add atlan@openai-curated
2919
```
3020

31-
### Direct MCP server install (CLI only, no plugin)
32-
33-
If you only need the MCP server in the Codex CLI and don't care about the desktop-app plugin entry, run:
34-
35-
```bash
36-
codex mcp add atlan --url https://mcp.atlan.com/mcp
37-
codex mcp login atlan
38-
```
39-
40-
This appends `[mcp_servers.atlan]` to `~/.codex/config.toml` without going through the plugin system.
21+
This will register the plugin in **Plugins → Manage** with the Atlan logo and metadata, in addition to the MCP server entry.
4122

4223
## Verify
4324

0 commit comments

Comments
 (0)