Codex MCP Server

A Model Context Protocol (MCP) server that integrates OpenAI's Codex CLI with Claude Code, enabling you to use Codex's capabilities directly from within Claude.

This server is converted from the original GPT-5 MCP server, with cost tracking features removed and replaced with direct Codex CLI integration.

Features

Persistent Process Architecture: 80% faster responses with long-lived Codex processes
Workspace Isolation: Automatic repository-based session separation
Streaming Support: Real-time progress updates and thinking events
Session Management: Health monitoring, cancellation, and restart capabilities
Lightweight Persistence: JSON-based storage for session recovery
Resource Processing: Handle attached files and content in prompts
🆕 Structured Logging: Context-aware error categorization and tracking
🆕 Enhanced Capability Detection: Dynamic discovery of Codex CLI features
🆕 Improved Claude Code Integration: Optimized for collaborative workflows

Available Tools

Core Tools

🌟 codex_ask: Primary tool for Codex assistance with enhanced integration
💬 codex_conversation_start: Begin a new conversation with context
💬 codex_conversation_continue: Continue an existing conversation
⚙️ codex_conversation_options: Configure conversation settings
📊 codex_conversation_metadata: View conversation details
📝 codex_conversation_summarize: Compress conversation history

Session Management

🔧 codex_cancel: Cancel ongoing operations or force terminate sessions
🩺 codex_health: Monitor session status and get diagnostics
🔄 codex_restart: Recover from errors with process restart

Prerequisites

Node.js (≥18.0.0)
pnpm package manager

Codex CLI installed and configured

npm install -g @openai/codex
# or
brew install codex

Installation

Automated Installation

./install.sh

This script will:

Check dependencies
Install Codex CLI if needed
Build the project
Configure Claude Desktop integration
Run tests

Manual Installation

Install dependencies:
```
pnpm install
```
Build the project:
```
pnpm run build
```

Configure Claude Desktop by adding to claude_desktop_config.json:

{
  "mcpServers": {
    "codex": {
      "command": "node",
      "args": ["/path/to/codex_mcp/dist/index.js"],
      "env": {
        "MAX_CONVERSATIONS": "50",
        "MAX_CONVERSATION_HISTORY": "100",
        "MAX_CONVERSATION_CONTEXT": "10"
      }
    }
  }
}

Running the Server

Start Script

./start.sh

Manual Start

# Production mode
node dist/index.js

# Development mode with hot reload
pnpm run dev

Configuration

Environment variables (set in .env file):

MAX_CONVERSATIONS: Maximum number of concurrent conversations (default: 50)
MAX_CONVERSATION_HISTORY: Maximum messages per conversation (default: 100)
MAX_CONVERSATION_CONTEXT: Maximum context messages sent to Codex (default: 10)
LOG_LEVEL: Logging level (default: info)
MAX_SESSIONS: Maximum concurrent Codex sessions (default: 10)
SESSION_IDLE_TIMEOUT: Session cleanup timeout in ms (default: 1800000)

Testing

Run the comprehensive test suite:

# Test all functionality
node test-server.js

# Test MCP protocol only
node test-mcp-protocol.js

# Test tools functionality
node test-tools.js

MCP Client Discovery & Usage

How MCP Clients Understand This Server

MCP clients (like Claude Code) automatically discover available tools through the Model Context Protocol:

1. Automatic Tool Discovery

The server exposes 9 tools with full JSON schemas:

consult_codex - Core Codex interaction with advanced features
get_session_health - Monitor and diagnose sessions
cancel_request, restart_session - Session management
start_conversation, continue_conversation - Conversation workflows
set_conversation_options, get_conversation_metadata, summarize_conversation - Advanced conversation control

2. Progressive Feature Discovery

Users naturally discover capabilities through:

Tool descriptions in MCP protocol
Response metadata showing session IDs and workspace paths
Error messages that guide proper usage
Rich output from Codex CLI operations

3. Self-Documenting Responses

Every response includes helpful context:

Session: `my-session` | Workspace: `/path/to/repo`

Usage Patterns

Level 1: Basic Usage

@codex What is the best way to implement error handling in Node.js?

Level 2: Workspace-Aware Development

@codex Based on this code: [attach file], how can I optimize the performance?
# Automatically uses current repository workspace for isolation

Level 3: Persistent Sessions

@codex {"session_id": "auth-feature", "prompt": "Help me implement user authentication"}
@codex {"session_id": "auth-feature", "prompt": "Now add password reset functionality"}  
# Session maintains workspace context and request history

Level 4: Advanced Features

{
  "session_id": "complex-task",
  "workspace_path": "/specific/repo", 
  "streaming": true,
  "prompt": "Analyze and refactor this large codebase",
  "page": 1,
  "max_tokens_per_page": 15000
}

Session Management

@codex_health                           # Monitor all sessions
@codex_health {"session_id": "my-task"} # Check specific session
@codex_cancel {"session_id": "stuck-task"}  # Cancel operations  
@codex_restart {"session_id": "failed"}     # Recover from errors

Multi-Repository Workflows

# Work on frontend
@codex_ask {"workspace_path": "/projects/frontend", "session_id": "ui", "prompt": "Update React components"}

# Switch to backend  
@codex_ask {"workspace_path": "/projects/backend", "session_id": "api", "prompt": "Add new API endpoints"}

# Sessions remain isolated by workspace
@codex_health  # Shows both sessions with different workspace IDs

🚀 Enhanced Integration Features (v2.0)

Structured Error Handling

All errors are automatically categorized and logged with context:

Codex CLI errors: Command failures, timeouts, authentication issues
Session management: Creation, timeout, and capacity issues
MCP protocol: Request validation and response handling
Resource errors: File access, permissions, disk space

Dynamic Capability Detection

The server automatically detects available Codex CLI features:

JSON mode support
Available models (GPT-5, o3, etc.)
Workspace/directory mode
File operation capabilities
Plan API support
Token limits and constraints

Enhanced Shell Security

Complex prompts with special characters are automatically escaped for secure execution:

// Handles prompts like: "What's the best way to implement auth?"
// Safely escapes: 'What'\''s the best way to implement auth?'

Claude Code Optimizations

Unified session_id system for seamless integration
Tool names prefixed with codex_ for easy discovery
Rich error context with recovery suggestions
Workspace-aware session isolation

API Reference

`codex_ask`

🌟 Primary Codex interaction tool with enhanced Claude Code integration.

Parameters:

prompt (string, required): The prompt to send to Codex
session_id (string, optional): Session ID for persistent context
workspace_path (string, optional): Workspace path for repository isolation
context (string, optional): Additional context for the prompt
streaming (boolean, optional): Enable streaming responses
model (string, optional): Model to use (e.g., "o3", "gpt-5")
page (number, optional): Page number for pagination
max_tokens_per_page (number, optional): Maximum tokens per page

Response: Rich Codex output with session and workspace metadata

`codex_health`

🩺 Monitor session status and diagnostics with detailed capability reporting.

Parameters:

session_id (string, optional): Specific session to check

Response: Session status, workspace info, capabilities, and request counts

`codex_cancel` / `codex_restart`

🔧🔄 Enhanced session management and recovery with structured error handling.

Parameters:

session_id (string, required): Target session ID
force (boolean, optional): Force termination vs graceful restart

Response: Operation status and confirmation

Conversation Tools

Legacy conversation management (consider using sessions instead):

start_conversation, continue_conversation
set_conversation_options, get_conversation_metadata
summarize_conversation

Troubleshooting

Codex CLI Not Found

# Install via npm
npm install -g @openai/codex

# Install via Homebrew
brew install codex

# Verify installation
codex --help

Server Won't Start

Check that dependencies are installed: pnpm install
Ensure the project is built: pnpm run build
Verify Codex CLI is working: codex exec "echo test"

Authentication Issues

Make sure Codex CLI is authenticated. Run codex to check status or re-authenticate if needed.

Development

Project Structure

src/
├── index.ts                   # Main MCP server
├── codex-process-simple.ts    # Enhanced Codex CLI wrapper with capability detection
├── session-manager.ts         # Session management with workspace isolation
├── conversation.ts            # Conversation management  
├── logger.ts                  # Structured logging system
├── error-types.ts             # Error categorization and definitions
├── error-utils.ts             # Error mapping and recovery utilities
└── types.ts                   # TypeScript types

Building

pnpm run build

Testing

pnpm run test         # Run test suite
pnpm run dev          # Development mode

License

MIT License - see original GPT-5 MCP server for full license details.

Name		Name	Last commit message	Last commit date
Latest commit History 15 Commits
src		src
.gitignore		.gitignore
CLAUDE.md		CLAUDE.md
README.md		README.md
install.sh		install.sh
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
start.sh		start.sh
test-mcp-protocol.js		test-mcp-protocol.js
test-pagination.js		test-pagination.js
test-server.js		test-server.js
test-tools.js		test-tools.js
tsconfig.json		tsconfig.json

andreahaku/codex_mcp

Folders and files

Latest commit

History

Repository files navigation

Codex MCP Server

Features

Available Tools

Core Tools

Session Management

Prerequisites

Installation

Automated Installation

Manual Installation

Running the Server

Start Script

Manual Start

Configuration

Testing

MCP Client Discovery & Usage

How MCP Clients Understand This Server

1. Automatic Tool Discovery

2. Progressive Feature Discovery

3. Self-Documenting Responses

Usage Patterns

Level 1: Basic Usage

Level 2: Workspace-Aware Development

Level 3: Persistent Sessions

Level 4: Advanced Features

Session Management

Multi-Repository Workflows

🚀 Enhanced Integration Features (v2.0)

Structured Error Handling

Dynamic Capability Detection

Enhanced Shell Security

Claude Code Optimizations

API Reference

codex_ask

codex_health

codex_cancel / codex_restart

Conversation Tools

Troubleshooting

Codex CLI Not Found

Server Won't Start

Authentication Issues

Development

Project Structure

Building

Testing

License

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Contributors 2

Uh oh!

Languages

`codex_ask`

`codex_health`

`codex_cancel` / `codex_restart`

Packages