Skip to content

docs(codex-plugin): install via GitHub marketplace + uninstall commands#232

Merged
ankitjaggi merged 1 commit into
mainfrom
aryaman/codex-install-command-fix
Jun 3, 2026
Merged

docs(codex-plugin): install via GitHub marketplace + uninstall commands#232
ankitjaggi merged 1 commit into
mainfrom
aryaman/codex-install-command-fix

Conversation

@Aryamanz29
Copy link
Copy Markdown
Member

@Aryamanz29 Aryamanz29 commented Jun 3, 2026

Summary

Two README updates for the Atlan Codex plugin:

  1. Install via GitHub marketplace — preserve the GitHub-aware install path (codex plugin marketplace add https://github.com/atlanhq/agent-toolkit) so the plugin lands properly in Plugins → Manage with logo + metadata. Add a third step to register the MCP server (codex mcp add) until upstream Codex CLI fixes the underlying bug.
  2. Add an Uninstall section — symmetric reverse of each install step, so users have a clean path off.

Bug confirmed

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 appears in Plugins → Manage but the MCP server is never registered; tool discovery returns 0 tools; the agent silently falls back to spawning codex exec subprocesses.

# After `codex plugin add atlan@atlan`:
[marketplaces.atlan]
source = "https://github.com/atlanhq/agent-toolkit.git"
# ← MISSING [mcp_servers.atlan] section

codex mcp add atlan --url https://mcp.atlan.com/mcp writes the proper section AND auto-launches OAuth in one step.

Recommended install (3 commands)

codex plugin marketplace add https://github.com/atlanhq/agent-toolkit  # register Atlan marketplace from GitHub
codex plugin add atlan@atlan                                            # install in Plugins → Manage
codex mcp add atlan --url https://mcp.atlan.com/mcp                     # register MCP server (auto-launches OAuth)

Step 3 is needed today because of the upstream Codex CLI bug. The README explains this in one sentence and notes that the step will become unnecessary once Codex CLI honours the plugin's bundled .mcp.json.

Uninstall section

codex mcp logout atlan                  # clear OAuth token
codex mcp remove atlan                  # remove [mcp_servers.atlan]
codex plugin remove atlan@atlan         # remove plugin from Plugins → Manage
codex plugin marketplace remove atlan   # (optional) remove the marketplace itself

Plus a note that some older Codex CLI versions leave a stale [mcp_servers.atlan] block after codex mcp remove, requiring manual cleanup.

Tested end-to-end

Ran the 3-command install on a clean profile (Codex CLI 0.133.0) — all three steps succeeded; OAuth flow auto-launched on step 3 with the expected https://mcp.atlan.com/oauth/authorize?... URL.

Follow-up

Upstream issue at openai/codex so codex plugin add is taught to honour the plugin's bundled .mcp.json — to be filed separately.

🤖 Generated with Claude Code

@Aryamanz29 Aryamanz29 requested review from Hk669 and firecast as code owners June 3, 2026 16:28
@Aryamanz29 Aryamanz29 force-pushed the aryaman/codex-install-command-fix branch from 9a4fffc to dc491f2 Compare June 3, 2026 16:37
@Aryamanz29 Aryamanz29 changed the title docs(codex-plugin): use codex mcp add (the install command that actually works) docs(codex-plugin): install via GitHub marketplace + uninstall commands Jun 3, 2026
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>
@Aryamanz29 Aryamanz29 force-pushed the aryaman/codex-install-command-fix branch from dc491f2 to 467f62c Compare June 3, 2026 16:38
@ankitjaggi ankitjaggi merged commit 789507c into main Jun 3, 2026
2 checks passed
@ankitjaggi ankitjaggi deleted the aryaman/codex-install-command-fix branch June 3, 2026 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants