You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: codex-plugin/README.md
+29-19Lines changed: 29 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,49 +4,59 @@ Connects Atlan's hosted MCP server (`https://mcp.atlan.com/mcp`) to [OpenAI Code
4
4
5
5
## Install
6
6
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:
12
8
13
9
```bash
14
-
# Register Atlan's marketplace (point at the GitHub repo, or a local clone's root)
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.
22
21
23
-
### From the official Codex Plugin Directory (once GA)
22
+
### Once OpenAI's Plugin Directory is GA
24
23
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:
26
25
27
26
```bash
28
27
codex plugin add atlan@openai-curated
29
28
```
30
29
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`.
32
31
33
-
If you only need the MCP server in the Codex CLI and don't care about the desktop-app plugin entry, run:
codex plugin list | grep atlan #atlan@atlan installed, enabled
36
+
codex mcp list #atlan ✓
38
37
```
39
38
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"*.
41
40
42
-
## Verify
41
+
## Uninstall
42
+
43
+
Reverse each install step in the opposite order. Run these from any shell:
43
44
44
45
```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
47
57
```
48
58
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.
0 commit comments