Skip to content

Commit 467f62c

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 467f62c

1 file changed

Lines changed: 29 additions & 19 deletions

File tree

codex-plugin/README.md

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,49 +4,59 @@ 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`.
7+
Install via Atlan's marketplace on GitHub:
128

139
```bash
14-
# Register Atlan's marketplace (point at the GitHub repo, or a local clone's root)
10+
# 1. Register Atlan's marketplace from this repo
1511
codex plugin marketplace add https://github.com/atlanhq/agent-toolkit
1612

17-
# Install the plugin from that marketplace
13+
# 2. Install the plugin (registers in Plugins → Manage)
1814
codex plugin add atlan@atlan
15+
16+
# 3. Register the MCP server (auto-launches OAuth against mcp.atlan.com)
17+
codex mcp add atlan --url https://mcp.atlan.com/mcp
1918
```
2019

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.
20+
Step 3 is needed today because Codex CLI's `plugin add` does not yet populate `[mcp_servers.<name>]` from a plugin's bundled `.mcp.json`. The plugin entry alone is not enough to wire up the MCP server `codex mcp add` does the actual registration and launches the OAuth flow. Quit and relaunch Codex (Cmd+Q the desktop app, or exit and re-run the CLI) after the auth completes so the new server is loaded into the session.
2221

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

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:
24+
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:
2625

2726
```bash
2827
codex plugin add atlan@openai-curated
2928
```
3029

31-
### Direct MCP server install (CLI only, no plugin)
30+
The marketplace and plugin steps will collapse into a single install flow; step 3 (`codex mcp add`) won't be needed once Codex CLI honours the plugin's bundled `.mcp.json`.
3231

33-
If you only need the MCP server in the Codex CLI and don't care about the desktop-app plugin entry, run:
32+
## Verify
3433

3534
```bash
36-
codex mcp add atlan --url https://mcp.atlan.com/mcp
37-
codex mcp login atlan
35+
codex plugin list | grep atlan # atlan@atlan installed, enabled
36+
codex mcp list # atlan
3837
```
3938

40-
This appends `[mcp_servers.atlan]` to `~/.codex/config.toml` without going through the plugin system.
39+
Inside a Codex session, run `/mcp` to inspect connected servers, then ask anything Atlan-related — e.g. *"find all tables in the snowflake connection"*, *"trace lineage upstream from this asset"*.
4140

42-
## Verify
41+
## Uninstall
42+
43+
Reverse each install step in the opposite order. Run these from any shell:
4344

4445
```bash
45-
codex plugin list | grep atlan # atlan@atlan installed, enabled
46-
codex mcp list # atlan ✓
46+
# 1. Sign out of the MCP server (clears the OAuth token from ~/.codex/auth.json)
47+
codex mcp logout atlan
48+
49+
# 2. Remove the MCP server registration ([mcp_servers.atlan] section in ~/.codex/config.toml)
50+
codex mcp remove atlan
51+
52+
# 3. Remove the plugin from Plugins → Manage
53+
codex plugin remove atlan@atlan
54+
55+
# 4. (Optional) Remove Atlan's marketplace itself
56+
codex plugin marketplace remove atlan
4757
```
4858

49-
Inside a Codex session, run `/mcp` to inspect connected servers, then ask anything Atlan-related — e.g. *"find all tables in the snowflake connection"*, *"trace lineage upstream from this asset"*.
59+
Then quit and relaunch Codex so the change takes effect in any open session. After all four steps, `~/.codex/config.toml` should have no `[marketplaces.atlan]` or `[mcp_servers.atlan]` sections and `~/.codex/auth.json` should no longer carry an Atlan OAuth token. An empty `~/.codex/plugins/cache/atlan/` directory may remain — harmless; `rm -rf` it if you want a fully clean wipe.
5060

5161
## Available tools
5262

0 commit comments

Comments
 (0)