Getting Started
Client Setup
Prerequisites
Before installing, ensure you have:
- Node.js v16.0.0 or higher
- Codex CLI installed and authenticated on your system
- Claude Desktop or Claude Code with MCP support
Claude Code (Recommended)
💡 @trishchuk/codex-mcp-tool is tested extensively with Claude Code
Claude Code offers the smoothest experience.
# install for Claude Code
claude mcp add codex-cli -- npx -y @trishchuk/codex-mcp-tool
# Start Claude Code - it's automatically configured!
claudeClaude Desktop
Configuration File Locations
For Claude Desktop users, add this to your configuration file:
{
"mcpServers": {
"codex-cli": {
"command": "npx",
"args": ["-y", "@trishchuk/codex-mcp-tool"]
}
}
}WARNING
You must restart Claude Desktop completely for changes to take effect.
Other MCP Clients
Codex MCP Tool works with 40+ MCP clients! Here are the common configuration patterns:
STDIO Transport (Most Common)
{
"transport": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@trishchuk/codex-mcp-tool"]
}
}Popular Clients
Warp - Modern terminal with AI features
Configuration Location: Terminal Settings → AI Settings → MCP Configuration
{
"codex-cli": {
"command": "npx",
"args": ["-y", "@trishchuk/codex-mcp-tool"],
"env": {},
"working_directory": null,
"start_on_launch": true
}
}Features: Terminal-native MCP integration, AI-powered command suggestions
Generic Setup Steps
- Install Prerequisites: Ensure Codex CLI is installed
- Add Server Config: Use the STDIO transport pattern above
- Restart Client: Most clients require restart after config changes
- Test Connection: Try
/codex-cli:pingor natural language commands
Verify Your Setup
Once configured, test that everything is working:
1. Basic Connectivity Test
Type in Claude:
/codex-cli:ping (MCP) "Hello from Codex MCP!"2. Test File Analysis
/codex-cli:ask-codex (MCP) @README.md summarize this file3. Test Sandbox Mode
/codex-cli:ask-codex (MCP) --sandbox create a simple Bash hello world scriptQuick Command Reference
Once installed, you can use natural language or slash commands:
Natural Language Examples
- "use codex to explain index.html"
- "understand the massive project using codex"
- "ask codex to analyze @src/main.ts and explain what it does"
- "use codex to look for vulnerabilities and suggest fixes"
Slash Commands in Claude Code
Type /codex-cli and these commands will appear:
/codex-cli:analyze- Analyze files or ask questions/codex-cli:sandbox- Safe code execution with full-auto mode/codex-cli:help- Show help information/codex-cli:ping- Test connectivity
Need a Different Client?
Don't see your MCP client listed? Codex MCP Tool uses standard MCP protocol and works with any compatible client.
Find More MCP Clients
- Official List: modelcontextprotocol.io/clients
- Configuration Help: Most clients follow the STDIO transport pattern above
- Community: Join discussions on GitHub for client-specific tips
Common Issues
"Command not found: codex"
Make sure you've installed the Codex CLI:
# Check if Codex is installed
which codex
# If not, install it following the official instructions
# Visit: https://github.com/openai/codex"MCP server not responding"
- Run
claude code --> /doctorfor diagnostics - Check your configuration file path
- Ensure JSON syntax is correct
- Restart your MCP client completely
- Verify Codex CLI works:
codex --version
Client-Specific Issues
- Claude Desktop: Must restart completely after config changes
- Other Clients: Check their specific documentation for MCP setup
Next Steps
Now that you're set up:
- Learn about file analysis with @ syntax
- Explore sandbox mode for safe code execution with approval policies
- Check out Codex CLI usage guide for advanced features
- Join the community for support
Need Help?
If you run into issues, open an issue on GitHub.