diff --git a/README.md b/README.md index 090f3c8..7d6db9e 100644 --- a/README.md +++ b/README.md @@ -346,6 +346,9 @@ Step-by-step tutorial for connecting n8n-MCP to Cursor IDE with custom rules. ### [Windsurf](./docs/WINDSURF_SETUP.md) Complete guide for integrating n8n-MCP with Windsurf using project rules. +### [Codex](./docs/CODEX_SETUP.md) +Complete guide for integrating n8n-MCP with Codex. + ## 🤖 Claude Project Setup For the best results when using n8n-MCP with Claude Projects, use these enhanced system instructions: diff --git a/docs/CODEX_SETUP.md b/docs/CODEX_SETUP.md new file mode 100644 index 0000000..63752a8 --- /dev/null +++ b/docs/CODEX_SETUP.md @@ -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). diff --git a/docs/img/codex_connected.png b/docs/img/codex_connected.png new file mode 100644 index 0000000..6dec670 Binary files /dev/null and b/docs/img/codex_connected.png differ