docs(codex): add Codex integration guide

This commit is contained in:
Thai Nguyen Hung
2025-09-23 11:04:12 +07:00
parent dd36735a1a
commit 9a13b977dc
3 changed files with 39 additions and 0 deletions

36
docs/CODEX_SETUP.md Normal file
View File

@@ -0,0 +1,36 @@
# Codex Setup
Connect n8n-MCP to Codex for enhanced n8n workflow development.
## Update your Codex configuration
Go to your Codex settings at `~/.codex/config.toml` and add the following configuration:
### Basic configuration (documentation tools only):
```toml
[mcp_servers.n8n]
command = "npx"
args = ["n8n-mcp"]
env = { "MCP_MODE" = "stdio", "LOG_LEVEL" = "error", "DISABLE_CONSOLE_OUTPUT" = "true" }
```
![Adding n8n-MCP server in Claude Code](./img/cc_command.png)
### Full configuration (with n8n management tools):
```toml
[mcp_servers.n8n]
command = "npx"
args = ["n8n-mcp"]
env = { "MCP_MODE" = "stdio", "LOG_LEVEL" = "error", "DISABLE_CONSOLE_OUTPUT" = "true", "N8N_API_URL" = "https://your-n8n-instance.com", "N8N_API_KEY" = "your-api-key" }
```
Make sure to replace `https://your-n8n-instance.com` with your actual n8n URL and `your-api-key` with your n8n API key.
## Managing Your MCP Server
Enter the Codex CLI and use the `/mcp` command to see server status and available tools.
![n8n-MCP connected and showing 39 tools available](./img/codex_connected.png)
## Project Instructions
For optimal results, create a `AGENTS.md` file in your project root with the instructions same with [main README's Claude Project Setup section](../README.md#-claude-project-setup).