使用说明
Codex MCP服务器
OpenAI Codex CLI 打开Claude Code 打开Model Context Protocol (MCP) 合并
概要
Codex MCP Server 表示OpenAI Codex CLI 打开Claude Code 无缝集成Model Context Protocol (MCP) 通过,通过Claude Code在中Codex强大的AI允许直接使用编码功能。
✨ 机能
- 🚀 全局安装 -一旦安装Claude Code 可在任何地方使用
- 🛠️ 六个强大的工具 -実行、分析、修正、泛用操作、Web検索对应
- 🔒 安全 -执行具有超时控制的沙箱
- ⚡ 高速 -高效TypeScript实施
- 🎯 轻松设置 -单命令安装和配置
- 📝 TypeScript -完整的模具安全性和卓越的开发体验
🎯 可用工具
工具|说明|使用示例| |------|-----|--------| | codex.exec 在提示符下Codex执行命令|代码生成、算法说明、函数创建| | codex.analyze |分析代码问题|安全审计、性能检查、代码质量| | codex.fix | AI帮助修复代码问题|错误修复、优化建议、重构| | codex.一般 |通用Codex CLI操作|自定义命令、高级工作流| | codex.search |高速Web検索(构造化结果)|API仕样确认、エラー意味调查、技术情报検索| | codex.search_detailed 详细信息Web搜索(完整内容)|教程获取、实施例分析、深入的技术解说|
所需环境
- Node.js 18+ - MCP运行服务器所需
- OpenAI Codex命令行界面 -基础AI编码工具
- 克劳德代码 - MCP使用服务器的客户端
- OpenAI API 按键 -或ChatGPT Plus/Pro/Team/Enterprise 预订
安装
🚀 快速安装(推荐)
# オプション1: ワンコマンドインストール(近日公開)
npx create-codex-mcp --global
# オプション2: ソースから手動インストール
git clone https://github.com/goalseeklabs/codex-mcp-server.git
cd codex-mcp-server
./setup/install.sh
📦 手动安装
- Codex CLI 安装(未安装时):
# npmを使用
npm install -g @openai/codex
# またはHomebrew(macOS)
brew install codex
- Codex MCP Server 安装:
npm install -g codex-mcp-server
- Claude Code 配置:
codex-mcp-setup
- Claude Code 重新启动这样,工具就可以使用了!
使用方法
基本用例
1.代码生成
codex.exec ツールを使用してフィボナッチ数を計算するPython関数を作成してください
2.代码分析
codex.analyze ツールを使用して、このJavaScriptファイルのセキュリティ脆弱性をチェックしてください: /path/to/file.js
3.问题修正
codex.fix ツールを使用して、この関数のパフォーマンス問題を修正してください: [コードを貼り付け]
4.自定义命令
codex.general ツールを使用してカスタムCodex操作を実行: このコードベースのアーキテクチャを説明してください
5. Web検索(高速)
codex.search ツールを使用して、React useEffectフックの最新ベストプラクティスを調べてください
6. Web検索(详细)
codex.search_detailed ツールを使用して、TypeScript genericsの詳しいチュートリアルと実装例を取得してください
工具参数
codex.exec
{
"prompt": "ユーザー認証用のREST APIエンドポイントを作成",
"args": ["--language", "typescript"],
"workingDirectory": "/path/to/project",
"timeout": 30000
}
codex.analyze
{
"filePath": "/path/to/file.js",
"analysisType": "security",
"workingDirectory": "/path/to/project"
}
codex.fix
{
"filePath": "/path/to/buggy-file.py",
"issueDescription": "この関数のメモリリークを修正",
"workingDirectory": "/path/to/project",
"dryRun": true
}
codex.一般
{
"command": "explain",
"args": ["--detailed", "architecture"],
"workingDirectory": "/path/to/project",
"timeout": 60000
}
codex.search
{
"query": "React hooks useEffect best practices 2024",
"provider": "bing",
"workingDirectory": "/path/to/project",
"timeout": 30000
}
codex.search_detailed
{
"query": "TypeScript advanced generics tutorial examples",
"provider": "bing",
"maxPages": 3,
"workingDirectory": "/path/to/project",
"timeout": 60000
}
设定
全局设置
MCP服务器通过以下文件Claude Code将条目添加到文档注册表
~/.config/claude-code/mcp_settings.json
环境变数
# OpenAI APIキー(ChatGPTサブスクリプションを使用しない場合)
export OPENAI_API_KEY="your-api-key-here"
# オプション: カスタムタイムアウト(ミリ秒)
export CODEX_MCP_TIMEOUT="30000"
高级设置
您可以更改全局设置以自定义服务器行为:
{
"mcpServers": {
"codex": {
"command": "codex-mcp",
"args": [],
"env": {
"CODEX_MCP_TIMEOUT": "45000"
}
}
}
}
开発
源构建
git clone https://github.com/goalseeklabs/codex-mcp-server.git
cd codex-mcp-server
# 依存関係のインストール
npm install
# TypeScriptのビルド
npm run build
# テストの実行
npm test
# テスト用にグローバルインストール
npm install -g .
测试
# バリデーションテストの実行
npm run test
# 手動バリデーション
node tests/validation.js
# サーバー起動テスト
node tests/startup-test.js
项目结构
codex-mcp-server/
├── src/
│ ├── index.ts # メインMCPサーバー
│ ├── codex.ts # Codex CLI統合
│ └── schemas.ts # 型定義とバリデーション
├── bin/
│ ├── codex-mcp.js # CLIエントリーポイント
│ └── setup.js # セットアップコマンド
├── config/
│ └── claude-code-mcp.json # Claude Code設定テンプレート
├── setup/
│ └── install.sh # インストールスクリプト
├── tests/
│ ├── validation.js # バリデーションテスト
│ └── startup-test.js # 起動テスト
└── docs/
└── usage-guide.md # 詳細使用ガイド
故障排除
常见问题
❌ “Codex CLI不可用”
# Codex CLIのインストール
npm install -g @openai/codex
# または
brew install codex
# インストール確認
codex --version
❌ “找不到命令:codex mcp”
# グローバルインストール確認
npm list -g codex-mcp-server
# 必要に応じて再インストール
npm install -g codex-mcp-server
# PATH確認
echo $PATH
❌ “MCP服务器没有响应”
# Claude Codeの再起動
# サーバーログの確認
codex-mcp --version
# セットアップ再実行
codex-mcp-setup
❌ “权限被拒绝”
# macOS/Linuxでの権限修正
sudo chown -R $(whoami) ~/.config/claude-code
chmod 755 ~/.config/claude-code
调试模式
启用调试日志:
DEBUG=codex-mcp:* codex-mcp
支持
貢献
欢迎贡献!了解更多信息贡献指南来修改标记元素的显示属性。
快速入门
- 分叉存储库
- 创建功能分支:
git checkout -b feature/amazing-feature - 加以变更
- 测试运行:
npm test - 提交:
git commit -m 'Add amazing feature' - 推送:
git push origin feature/amazing-feature - 打开拉式请求
许可证
这个项目Apache License 2.0下许可-详细信息许可证请看文件。
⚠️ 免责事项・重要な注意事项
使用前必须 免责事项・重要な注意事项 来修改标记元素的显示属性。
更新履歴
v0.2.0(2025-08-30)
- 🔍 Web検索机能追加 - Codex CLI的,之web search整合功能
- ✅ 添加快速搜索工具-快速收集结构化结果中的信息
- ✅ 高级搜索工具(codex.search_detailed)添加-完整页面内容深入分析
- ✅ 支持多供应商(Bing、Google、DuckDuckGo)
- ✅ 自动选择和自定义搜索供应商
- ⚡ 高级搜索默认页数优化(3页获取最大信息)
- 🛠️ 六个强大的工具,帮助您更全面地编码
v0.1.0(2025-08-30)
- 🎉 首次发布
- ✅ Claude Code 和的完全MCP集成
- ✅ 4つのコアツール(执行、分析、修复、通用)
- ✅ 支持全局安装
- ✅ 自动设置和配置
- ✅ TypeScript実装
- ✅ 全面测试
Goal Seek Laboratory が ❤️ を込めて作成
OpenAI Codex と Claude Code を活用