Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.userplane.io/llms.txt

Use this file to discover all available pages before exploring further.

The Codex plugin installs Userplane skills and both MCP servers in one setup flow. Use it when you want Codex to make framework-aware Userplane changes or analyze recordings with workspace data.

​
Install

1

Register the marketplace

Run this once from your terminal:
codex marketplace add userplanehq/userplane-agent
2

Install the plugin

Open /plugins in Codex, choose the Userplane marketplace, and install userplane.
3

Verify the plugin

Open /plugins again and confirm userplane is listed and enabled.
4

Verify MCP servers

Open /mcp.You should see userplane-workspace and userplane-docs.

​
First use

1

Authenticate

On the first tool call that uses the workspace MCP server, Codex opens a browser window for Userplane sign-in. Log in and approve access. Tokens are stored by Codex.
2

Try a workflow

Open a web app repository and ask Codex:
$userplane-integrate Install Userplane in this app.
Codex detects the framework, loads the matching skill, and applies the integration.
3

Try natural language

You can also ask without naming the skill:
Audit my Userplane setup and tell me what needs to change.
Codex loads userplane-audit when the request matches the workflow.

​
Verification checklist

CheckExpected result
/pluginsuserplane listed and enabled
/mcpuserplane-workspace and userplane-docs listed
$userplane-integrateDetects framework or prompts for one
”List my Userplane workspaces”Returns workspace list after MCP authentication

​
Troubleshooting

Plugin not visible Confirm the marketplace was added with codex marketplace add userplanehq/userplane-agent, then reopen /plugins. MCP authentication failed Open /mcp to view server status and re-authenticate. A workflow skill did not activate Name the skill explicitly, such as $userplane-audit, or make the request more specific: “Audit my Userplane install in this repo.”