Add OpenAI Codex setup documentation to MCP reference #7597
+69
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,62 @@ | ||||||
| --- | ||||||
| description: "Host set up for OpenAI Codex" | ||||||
| --- | ||||||
|
|
||||||
| # OpenAI Codex Setup | ||||||
|
|
||||||
| [OpenAI Codex](https://openai.com/blog/openai-codex) is OpenAI's terminal-first workspace that pairs a shell, editor, and conversational developer agent. With Model Context Protocol (MCP) support, you can connect Codex directly to Umbraco's tools and data so the assistant can work inside your projects. | ||||||
|
|
||||||
| ## Getting started | ||||||
|
|
||||||
| Install the Codex CLI with npm: | ||||||
|
|
||||||
| ```bash | ||||||
| npm install -g @openai/codex | ||||||
| ``` | ||||||
|
|
||||||
| Or install the Codex CLI with brew: | ||||||
|
|
||||||
| ```bash | ||||||
| brew install codex | ||||||
| ``` | ||||||
|
|
||||||
| ### Configure using the Codex CLI | ||||||
|
|
||||||
| Add the Umbraco MCP server with the Codex CLI: | ||||||
|
|
||||||
| ```bash | ||||||
| codex mcp add umbraco-mcp -- npx -y @umbraco-cms/mcp-dev@beta | ||||||
| ``` | ||||||
|
|
||||||
| **Define configuration values directly** | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| If you prefer to keep secrets in your shell session, pass them as environment variables during registration: | ||||||
|
|
||||||
| ```bash | ||||||
| codex mcp add umbraco-mcp \ | ||||||
| --env UMBRACO_CLIENT_ID="your-id" \ | ||||||
| --env UMBRACO_CLIENT_SECRET="your-secret" \ | ||||||
| --env UMBRACO_BASE_URL="https://your-domain.com" \ | ||||||
| --env NODE_TLS_REJECT_UNAUTHORIZED="0" \ | ||||||
| --env UMBRACO_INCLUDE_TOOL_COLLECTIONS="document,media,document-type,data-type" \ | ||||||
| -- npx -y @umbraco-cms/mcp-dev@beta | ||||||
| ``` | ||||||
|
|
||||||
| Replace the `UMBRACO_CLIENT_ID`, `UMBRACO_CLIENT_SECRET`, `UMBRACO_BASE_URL`, and `UMBRACO_INCLUDE_TOOL_COLLECTIONS` values with your local connection details. | ||||||
|
|
||||||
| This command stores the MCP server as `umbraco-mcp` in your Codex configuration file (typically `~/.codex/config.toml`). | ||||||
|
|
||||||
| {% hint style="info" %} | ||||||
| Use the command below at any time to see which MCP servers Codex is currently loading: | ||||||
|
|
||||||
| ``` | ||||||
| codex mcp list | ||||||
| ``` | ||||||
| {% endhint %} | ||||||
|
|
||||||
| ## Managing tools and tool collections | ||||||
|
|
||||||
| When you change the tool set: | ||||||
|
|
||||||
| - Update your `.env` file with the tool collections you want (for example `document,media`). | ||||||
| - Repeat the `codex mcp list` command to confirm the server is healthy. | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.