Skip to content

Commit ef700ba

Browse files
authored
Merge pull request #39 from shinpr/fix/readme-codex-documentation
docs: add Codex to README and fix CLI naming consistency
2 parents dabbd3d + 21fd141 commit ef700ba

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Bring Claude Code–style sub-agents to any MCP-compatible tool.
77

8-
This MCP server lets you define task-specific AI agents (like "test-writer" or "code-reviewer") in markdown files, and execute them via Cursor CLI, Claude Code CLI, or Gemini CLI backends.
8+
This MCP server lets you define task-specific AI agents (like "test-writer" or "code-reviewer") in markdown files, and execute them via Cursor CLI, Claude Code, Gemini CLI, or Codex backends.
99

1010
## Why?
1111

@@ -14,7 +14,7 @@ Claude Code offers powerful sub-agent workflows—but they're limited to its own
1414
**Concrete benefits:**
1515
- Define reusable agents once, use them across multiple tools
1616
- Share agent definitions within teams regardless of IDE choice
17-
- Leverage Cursor CLI, Claude Code CLI, or Gemini CLI capabilities from any MCP client
17+
- Leverage Cursor CLI, Claude Code, Gemini CLI, or Codex capabilities from any MCP client
1818

1919
[Read the full story](https://dev.to/shinpr/bringing-claude-codes-sub-agents-to-any-mcp-compatible-tool-1hb9)
2020

@@ -37,6 +37,7 @@ Claude Code offers powerful sub-agent workflows—but they're limited to its own
3737
- `cursor-agent` CLI (from Cursor)
3838
- `claude` CLI (from Claude Code)
3939
- `gemini` CLI (from Gemini CLI)
40+
- `codex` CLI (from Codex)
4041
- An MCP-compatible tool (Cursor IDE, Claude Desktop, Windsurf, etc.)
4142

4243
## Quick Start
@@ -90,6 +91,12 @@ gemini
9091

9192
Note: Gemini CLI uses OAuth authentication. Run `gemini` once to authenticate via browser.
9293

94+
**For Codex users:**
95+
```bash
96+
# Install Codex
97+
npm install -g @openai/codex
98+
```
99+
93100
### 3. Configure MCP
94101

95102
Add this to your MCP configuration file:
@@ -391,14 +398,14 @@ The startup overhead is an intentional trade-off: the system favors clarity and
391398

392399
## How It Works
393400

394-
This MCP server acts as a bridge between your AI tool and a supported execution engine (Cursor CLI, Claude Code CLI, or Gemini CLI).
401+
This MCP server acts as a bridge between your AI tool and a supported execution engine (Cursor CLI, Claude Code, Gemini CLI, or Codex).
395402

396403
**The flow:**
397404

398405
1. You configure the MCP server in your client (Cursor, Claude Desktop, etc.)
399406
2. The client automatically launches `sub-agents-mcp` as a background process when it starts
400407
3. When your main AI assistant needs a sub-agent, it makes an MCP tool call
401-
4. The MCP server reads the agent definition (markdown file) and invokes the selected CLI (`cursor-agent`, `claude`, or `gemini`)
408+
4. The MCP server reads the agent definition (markdown file) and invokes the selected CLI (`cursor-agent`, `claude`, `gemini`, or `codex`)
402409
5. The execution engine runs the agent and streams results back through the MCP server
403410
6. Your main assistant receives the results and continues working
404411

0 commit comments

Comments
 (0)