oh-my-codex-cli 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agent/skills/agent-kb/HOW_TO_USE.md +428 -0
- package/.agent/skills/agent-kb/README.md +46 -0
- package/.agent/skills/agent-kb/SKILL.md +128 -0
- package/.agent/skills/agent-kb/references/intelligent-analysis-explained.md +333 -0
- package/.agent/skills/agent-kb/references/query-optimization.md +225 -0
- package/.agent/skills/aireview/SKILL.md +704 -0
- package/.agent/skills/analyze/SKILL.md +81 -0
- package/.agent/skills/architect-planner/HOW_TO_USE.md +238 -0
- package/.agent/skills/architect-planner/README.md +41 -0
- package/.agent/skills/architect-planner/SKILL.md +539 -0
- package/.agent/skills/auto-mbti/SKILL.md +291 -0
- package/.agent/skills/autopilot/SKILL.md +222 -0
- package/.agent/skills/backend-patterns/SKILL.md +602 -0
- package/.agent/skills/bdd-generator/README.md +78 -0
- package/.agent/skills/bdd-generator/SKILL.md +436 -0
- package/.agent/skills/brainstorming/HOW_TO_USE.md +289 -0
- package/.agent/skills/brainstorming/README.md +41 -0
- package/.agent/skills/brainstorming/SKILL.md +165 -0
- package/.agent/skills/build-fix/SKILL.md +190 -0
- package/.agent/skills/cancel/SKILL.md +658 -0
- package/.agent/skills/checkpoint/SKILL.md +94 -0
- package/.agent/skills/code-review/SKILL.md +273 -0
- package/.agent/skills/coding-standards/SKILL.md +535 -0
- package/.agent/skills/conductor/SKILL.md +128 -0
- package/.agent/skills/conductor/commands/conductor/implement.toml +358 -0
- package/.agent/skills/conductor/commands/conductor/newTrack.toml +142 -0
- package/.agent/skills/conductor/commands/conductor/revert.toml +123 -0
- package/.agent/skills/conductor/commands/conductor/setup.toml +429 -0
- package/.agent/skills/conductor/commands/conductor/status.toml +57 -0
- package/.agent/skills/conductor/scripts/install.sh +89 -0
- package/.agent/skills/conductor/templates/code_styleguides/csharp.md +115 -0
- package/.agent/skills/conductor/templates/code_styleguides/dart.md +238 -0
- package/.agent/skills/conductor/templates/code_styleguides/general.md +23 -0
- package/.agent/skills/conductor/templates/code_styleguides/go.md +48 -0
- package/.agent/skills/conductor/templates/code_styleguides/html-css.md +49 -0
- package/.agent/skills/conductor/templates/code_styleguides/javascript.md +51 -0
- package/.agent/skills/conductor/templates/code_styleguides/python.md +37 -0
- package/.agent/skills/conductor/templates/code_styleguides/typescript.md +43 -0
- package/.agent/skills/conductor/templates/rules/README.md +23 -0
- package/.agent/skills/conductor/templates/rules/agents.md +49 -0
- package/.agent/skills/conductor/templates/rules/coding-style.md +70 -0
- package/.agent/skills/conductor/templates/rules/dev.md +20 -0
- package/.agent/skills/conductor/templates/rules/git-workflow.md +45 -0
- package/.agent/skills/conductor/templates/rules/hooks.md +6 -0
- package/.agent/skills/conductor/templates/rules/patterns.md +55 -0
- package/.agent/skills/conductor/templates/rules/performance.md +47 -0
- package/.agent/skills/conductor/templates/rules/research.md +26 -0
- package/.agent/skills/conductor/templates/rules/review.md +22 -0
- package/.agent/skills/conductor/templates/rules/security.md +36 -0
- package/.agent/skills/conductor/templates/rules/testing.md +30 -0
- package/.agent/skills/conductor/templates/workflow.md +333 -0
- package/.agent/skills/consensus/HOW_TO_USE.md +191 -0
- package/.agent/skills/consensus/README.md +41 -0
- package/.agent/skills/consensus/SKILL.md +317 -0
- package/.agent/skills/content-research-writer/SKILL.md +537 -0
- package/.agent/skills/debug-analysis/SKILL.md +331 -0
- package/.agent/skills/deepinit/SKILL.md +347 -0
- package/.agent/skills/deepsearch/SKILL.md +56 -0
- package/.agent/skills/doctor/SKILL.md +158 -0
- package/.agent/skills/drawio/EXAMPLES.md +382 -0
- package/.agent/skills/drawio/QUICK_START.md +237 -0
- package/.agent/skills/drawio/README.md +315 -0
- package/.agent/skills/drawio/SETUP_GUIDE.md +254 -0
- package/.agent/skills/drawio/SKILL.md +1176 -0
- package/.agent/skills/e2e/SKILL.md +396 -0
- package/.agent/skills/ecomode/SKILL.md +160 -0
- package/.agent/skills/electron-driver/SKILL.md +144 -0
- package/.agent/skills/electron-driver/scripts/driver-template.js +71 -0
- package/.agent/skills/eval/SKILL.md +140 -0
- package/.agent/skills/eval-harness/SKILL.md +242 -0
- package/.agent/skills/evolve/SKILL.md +213 -0
- package/.agent/skills/frontend-design/SKILL.md +42 -0
- package/.agent/skills/frontend-patterns/SKILL.md +646 -0
- package/.agent/skills/frontend-ui-ux/SKILL.md +70 -0
- package/.agent/skills/git-master/SKILL.md +75 -0
- package/.agent/skills/help/SKILL.md +89 -0
- package/.agent/skills/iterative-retrieval/SKILL.md +217 -0
- package/.agent/skills/local-skills-setup/SKILL.md +483 -0
- package/.agent/skills/log-analyzer/SKILL.md +187 -0
- package/.agent/skills/mcp-setup/SKILL.md +226 -0
- package/.agent/skills/multi-model-research/HOW_TO_USE.md +614 -0
- package/.agent/skills/multi-model-research/README.md +233 -0
- package/.agent/skills/multi-model-research/SKILL.md +541 -0
- package/.agent/skills/multi-model-research/references/troubleshooting.md +415 -0
- package/.agent/skills/note/SKILL.md +80 -0
- package/.agent/skills/omc-setup/SKILL.md +219 -0
- package/.agent/skills/orchestrate/SKILL.md +620 -0
- package/.agent/skills/patent-workflow/IMPLEMENTATION_SUMMARY.md +500 -0
- package/.agent/skills/patent-workflow/README.md +455 -0
- package/.agent/skills/patent-workflow/SKILL.md +1036 -0
- package/.agent/skills/patent-workflow/tools/irr_checker.py +260 -0
- package/.agent/skills/patent-workflow/tools/sample_terminology.json +49 -0
- package/.agent/skills/patent-workflow/tools/term_checker.py +355 -0
- package/.agent/skills/pattern-recognition/SKILL.md +792 -0
- package/.agent/skills/pipeline/SKILL.md +448 -0
- package/.agent/skills/plan/SKILL.md +309 -0
- package/.agent/skills/planning-methodology/SKILL.md +370 -0
- package/.agent/skills/planning-with-files/SKILL.md +210 -0
- package/.agent/skills/planning-with-files/examples.md +202 -0
- package/.agent/skills/planning-with-files/reference.md +218 -0
- package/.agent/skills/planning-with-files/scripts/check-complete.ps1 +42 -0
- package/.agent/skills/planning-with-files/scripts/check-complete.sh +44 -0
- package/.agent/skills/planning-with-files/scripts/init-session.ps1 +120 -0
- package/.agent/skills/planning-with-files/scripts/init-session.sh +120 -0
- package/.agent/skills/planning-with-files/scripts/session-catchup.py +208 -0
- package/.agent/skills/planning-with-files/templates/findings.md +95 -0
- package/.agent/skills/planning-with-files/templates/progress.md +114 -0
- package/.agent/skills/planning-with-files/templates/task_plan.md +132 -0
- package/.agent/skills/project-analyze/CLAUDE.md +18 -0
- package/.agent/skills/project-analyze/HOW_TO_USE.md +145 -0
- package/.agent/skills/project-analyze/README.md +42 -0
- package/.agent/skills/project-analyze/SKILL.md +289 -0
- package/.agent/skills/project-analyze/SKILL.md.backup +287 -0
- package/.agent/skills/project-analyze/SKILL.md.backup_20260105_093646 +287 -0
- package/.agent/skills/project-analyze/assets/analysis-report-template.md +433 -0
- package/.agent/skills/project-analyze/references/analysis-patterns.md +422 -0
- package/.agent/skills/project-analyze/references/projectmind-explained.md +535 -0
- package/.agent/skills/project-session-manager/SKILL.md +428 -0
- package/.agent/skills/project-session-manager/lib/config.sh +86 -0
- package/.agent/skills/project-session-manager/lib/parse.sh +121 -0
- package/.agent/skills/project-session-manager/lib/session.sh +132 -0
- package/.agent/skills/project-session-manager/lib/tmux.sh +103 -0
- package/.agent/skills/project-session-manager/lib/worktree.sh +171 -0
- package/.agent/skills/project-session-manager/psm.sh +629 -0
- package/.agent/skills/project-session-manager/templates/feature.md +56 -0
- package/.agent/skills/project-session-manager/templates/issue-fix.md +57 -0
- package/.agent/skills/project-session-manager/templates/pr-review.md +65 -0
- package/.agent/skills/project-session-manager/templates/projects.json +19 -0
- package/.agent/skills/quality-check/HOW_TO_USE.md +171 -0
- package/.agent/skills/quality-check/README.md +50 -0
- package/.agent/skills/quality-check/SKILL.md +240 -0
- package/.agent/skills/quality-check/SKILL.md.backup +238 -0
- package/.agent/skills/quality-check/SKILL.md.backup_20260105_093646 +238 -0
- package/.agent/skills/quality-check/assets/quality-report-template.md +437 -0
- package/.agent/skills/quality-check/references/refactoring-patterns.md +550 -0
- package/.agent/skills/quality-check/references/scoring-criteria.md +454 -0
- package/.agent/skills/quality-validation/SKILL.md +519 -0
- package/.agent/skills/quality-validation/SKILL.md.backup +573 -0
- package/.agent/skills/quality-validation/SKILL.md.backup_20260105_093646 +573 -0
- package/.agent/skills/ralph/SKILL.md +236 -0
- package/.agent/skills/ralph-init/SKILL.md +78 -0
- package/.agent/skills/ralplan/SKILL.md +58 -0
- package/.agent/skills/refactor-clean/SKILL.md +49 -0
- package/.agent/skills/release/SKILL.md +84 -0
- package/.agent/skills/research/SKILL.md +526 -0
- package/.agent/skills/research-methodology/SKILL.md +268 -0
- package/.agent/skills/review/SKILL.md +53 -0
- package/.agent/skills/security-review/SKILL.md +509 -0
- package/.agent/skills/security-review/cloud-infrastructure-security.md +361 -0
- package/.agent/skills/setup-pm/SKILL.md +102 -0
- package/.agent/skills/skill/SKILL.md +424 -0
- package/.agent/skills/skill-create/SKILL.md +209 -0
- package/.agent/skills/skill-debugger/HOW_TO_USE.md +244 -0
- package/.agent/skills/skill-debugger/README.md +44 -0
- package/.agent/skills/skill-debugger/SKILL.md +326 -0
- package/.agent/skills/skill-debugger/diagnostic_checklist.md +115 -0
- package/.agent/skills/skill-development/SKILL.md +661 -0
- package/.agent/skills/skill-development/references/skill-creator-original.md +209 -0
- package/.agent/skills/skill-doc-generator/README.md +37 -0
- package/.agent/skills/skill-doc-generator/SKILL.md +331 -0
- package/.agent/skills/skill-quality-analyzer/HOW_TO_USE.md +243 -0
- package/.agent/skills/skill-quality-analyzer/README.md +61 -0
- package/.agent/skills/skill-quality-analyzer/SKILL.md +247 -0
- package/.agent/skills/skill-quality-analyzer/analyzer.py +209 -0
- package/.agent/skills/skill-quality-analyzer/expected_output.json +81 -0
- package/.agent/skills/skill-quality-analyzer/sample_input.json +9 -0
- package/.agent/skills/skill-tester/README.md +46 -0
- package/.agent/skills/skill-tester/SKILL.md +345 -0
- package/.agent/skills/start-dev/SKILL.md +701 -0
- package/.agent/skills/swarm/SKILL.md +691 -0
- package/.agent/skills/task-kb-lookup/SKILL.md +211 -0
- package/.agent/skills/task-kb-record/SKILL.md +417 -0
- package/.agent/skills/tdd/SKILL.md +446 -0
- package/.agent/skills/tdd-generator/DEMO.md +516 -0
- package/.agent/skills/tdd-generator/README.md +89 -0
- package/.agent/skills/tdd-generator/SKILL.md +278 -0
- package/.agent/skills/tdd-workflow/SKILL.md +424 -0
- package/.agent/skills/test-coverage/SKILL.md +48 -0
- package/.agent/skills/thinkdeep/HOW_TO_USE.md +183 -0
- package/.agent/skills/thinkdeep/README.md +41 -0
- package/.agent/skills/thinkdeep/SKILL.md +343 -0
- package/.agent/skills/ui-ux-pro-max/SKILL.md +228 -0
- package/.agent/skills/ui-ux-pro-max/data/charts.csv +26 -0
- package/.agent/skills/ui-ux-pro-max/data/colors.csv +97 -0
- package/.agent/skills/ui-ux-pro-max/data/landing.csv +31 -0
- package/.agent/skills/ui-ux-pro-max/data/products.csv +97 -0
- package/.agent/skills/ui-ux-pro-max/data/prompts.csv +24 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/flutter.csv +53 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/nextjs.csv +53 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/react-native.csv +52 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/react.csv +54 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/svelte.csv +54 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/swiftui.csv +51 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/vue.csv +50 -0
- package/.agent/skills/ui-ux-pro-max/data/styles.csv +59 -0
- package/.agent/skills/ui-ux-pro-max/data/typography.csv +58 -0
- package/.agent/skills/ui-ux-pro-max/data/ux-guidelines.csv +100 -0
- package/.agent/skills/ui-ux-pro-max/scripts/core.py +236 -0
- package/.agent/skills/ui-ux-pro-max/scripts/search.py +61 -0
- package/.agent/skills/ultrapilot/SKILL.md +647 -0
- package/.agent/skills/ultraqa/SKILL.md +152 -0
- package/.agent/skills/ultrawork/SKILL.md +123 -0
- package/.agent/skills/update-codemaps/SKILL.md +38 -0
- package/.agent/skills/update-docs/SKILL.md +52 -0
- package/.agent/skills/verification-loop/SKILL.md +140 -0
- package/.agent/skills/verify/SKILL.md +80 -0
- package/.agent/skills/writer-memory/SKILL.md +459 -0
- package/.agent/skills/writer-memory/lib/character-tracker.ts +338 -0
- package/.agent/skills/writer-memory/lib/memory-manager.ts +804 -0
- package/.agent/skills/writer-memory/lib/relationship-graph.ts +400 -0
- package/.agent/skills/writer-memory/lib/scene-organizer.ts +544 -0
- package/.agent/skills/writer-memory/lib/synopsis-builder.ts +339 -0
- package/.agent/skills/writer-memory/templates/synopsis-template.md +46 -0
- package/.governance/skill-lint.allowlist +4 -0
- package/.governance/skill-llm.allowlist +4 -0
- package/AGENTS.md +59 -0
- package/LICENSE +21 -0
- package/README.md +169 -0
- package/README.zh.md +145 -0
- package/bin/omcodex.js +8 -0
- package/commands/conductor/implement.toml +358 -0
- package/commands/conductor/newTrack.toml +142 -0
- package/commands/conductor/revert.toml +123 -0
- package/commands/conductor/setup.toml +429 -0
- package/commands/conductor/status.toml +57 -0
- package/docs/ALIGNMENT.md +40 -0
- package/docs/CODEX.md +133 -0
- package/docs/NOTIFY.md +81 -0
- package/docs/SKILL_GOVERNANCE.md +72 -0
- package/docs/SKILL_GOVERNANCE_FRAMEWORK.md +182 -0
- package/docs/SKILL_GOVERNANCE_FRAMEWORK.zh.md +170 -0
- package/package.json +50 -0
- package/prompts/architect.md +105 -0
- package/prompts/executor.md +134 -0
- package/prompts/planner.md +113 -0
- package/scripts/check-skill-governance.sh +84 -0
- package/scripts/check-skill-llm-governance.js +302 -0
- package/scripts/eval-skills.js +217 -0
- package/scripts/generate-catalog-docs.js +95 -0
- package/scripts/generate-codex-mcp-config.sh +22 -0
- package/scripts/install-codex-force.sh +5 -0
- package/scripts/install-codex-incremental.sh +5 -0
- package/scripts/install-codex.sh +79 -0
- package/scripts/notify-dispatch.js +15 -0
- package/scripts/setup-package-manager.js +137 -0
- package/src/catalog/generated/public-catalog.json +547 -0
- package/src/catalog/manifest.json +542 -0
- package/src/catalog/reader.js +43 -0
- package/src/catalog/schema.js +79 -0
- package/src/cli/doctor.js +62 -0
- package/src/cli/index.js +85 -0
- package/src/cli/notify.js +127 -0
- package/src/cli/route.js +43 -0
- package/src/cli/setup.js +155 -0
- package/src/cli/team.js +125 -0
- package/src/config/generator.js +119 -0
- package/src/mcp/memory-server.js +241 -0
- package/src/mcp/state-server.js +112 -0
- package/src/mcp/trace-server.js +168 -0
- package/src/notify/dispatch.js +74 -0
- package/src/notify/extensibility/dispatcher.js +113 -0
- package/src/notify/extensibility/events.js +15 -0
- package/src/notify/extensibility/loader.js +54 -0
- package/src/router/skill-router.js +90 -0
- package/src/team/auto-advance.js +72 -0
- package/src/team/orchestrator.js +82 -0
- package/src/team/state-store.js +33 -0
- package/src/utils/paths.js +33 -0
- package/templates/AGENTS.md +15 -0
- package/templates/catalog-manifest.json +542 -0
- package/templates/code_styleguides/csharp.md +115 -0
- package/templates/code_styleguides/dart.md +238 -0
- package/templates/code_styleguides/general.md +23 -0
- package/templates/code_styleguides/go.md +48 -0
- package/templates/code_styleguides/html-css.md +49 -0
- package/templates/code_styleguides/javascript.md +51 -0
- package/templates/code_styleguides/python.md +37 -0
- package/templates/code_styleguides/typescript.md +43 -0
- package/templates/rules/README.md +23 -0
- package/templates/rules/agents.md +49 -0
- package/templates/rules/coding-style.md +70 -0
- package/templates/rules/dev.md +20 -0
- package/templates/rules/git-workflow.md +45 -0
- package/templates/rules/notify.md +6 -0
- package/templates/rules/patterns.md +55 -0
- package/templates/rules/performance.md +47 -0
- package/templates/rules/research.md +26 -0
- package/templates/rules/review.md +22 -0
- package/templates/rules/security.md +36 -0
- package/templates/rules/testing.md +30 -0
- package/templates/workflow.md +333 -0
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: mcp-setup
|
|
3
|
+
description: Configure popular MCP servers for enhanced agent capabilities
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# MCP Setup
|
|
7
|
+
|
|
8
|
+
## Codex Quickstart
|
|
9
|
+
|
|
10
|
+
Codex uses `~/.codex/config.toml` for MCP servers. Use one of:
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
./scripts/generate-codex-mcp-config.sh
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Or manage via CLI:
|
|
18
|
+
```
|
|
19
|
+
codex mcp add
|
|
20
|
+
codex mcp list
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Related 0.9+ helpers:
|
|
24
|
+
```
|
|
25
|
+
/apps # browse connected apps/connectors
|
|
26
|
+
/debug-config # inspect active Codex config and MCP wiring
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Approval tip: for trusted MCP tools, use "allow and remember" to avoid repeated prompts in the same workflow.
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
## Native Subagent Protocol (Codex)
|
|
34
|
+
|
|
35
|
+
Codex supports native subagents. Delegate with `spawn_agent`, coordinate with `send_input`, collect via `wait`, and clean up with `close_agent`.
|
|
36
|
+
|
|
37
|
+
Execution preference:
|
|
38
|
+
1. Use native subagents first for independent workstreams (parallel when possible).
|
|
39
|
+
2. Merge results in main thread and run final verification.
|
|
40
|
+
3. Fallback only when delegation is blocked: use the `[ANALYST]`/`[ARCHITECT]`/`[EXECUTOR]`/`[REVIEWER]` structure in a single response.
|
|
41
|
+
|
|
42
|
+
Minimal orchestration pattern:
|
|
43
|
+
```text
|
|
44
|
+
spawn_agent -> send_input (optional) -> wait -> close_agent
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
> Codex invocation: use `$mcp-setup ...` or `mcp-setup: ...`
|
|
48
|
+
|
|
49
|
+
Configure Model Context Protocol (MCP) servers to extend Codex's capabilities with external tools like web search, file system access, and GitHub integration.
|
|
50
|
+
|
|
51
|
+
## Overview
|
|
52
|
+
|
|
53
|
+
MCP servers provide additional tools that Codex agents can use. This skill helps you configure popular MCP servers using the `codex mcp add` command-line interface.
|
|
54
|
+
|
|
55
|
+
## Step 1: Show Available MCP Servers
|
|
56
|
+
|
|
57
|
+
Present the user with available MCP server options in plain text with numbered choices:
|
|
58
|
+
|
|
59
|
+
**Question:** "Which MCP server would you like to configure?"
|
|
60
|
+
|
|
61
|
+
**Options:**
|
|
62
|
+
1. **Context7** - Documentation and code context from popular libraries
|
|
63
|
+
2. **Exa Web Search** - Enhanced web search (replaces built-in websearch)
|
|
64
|
+
3. **Filesystem** - Extended file system access with additional capabilities
|
|
65
|
+
4. **GitHub** - GitHub API integration for issues, PRs, and repository management
|
|
66
|
+
5. **All of the above** - Configure all recommended MCP servers
|
|
67
|
+
6. **Custom** - Add a custom MCP server
|
|
68
|
+
|
|
69
|
+
## Step 2: Gather Required Information
|
|
70
|
+
|
|
71
|
+
### For Context7:
|
|
72
|
+
No API key required. Ready to use immediately.
|
|
73
|
+
|
|
74
|
+
### For Exa Web Search:
|
|
75
|
+
Ask for API key:
|
|
76
|
+
```
|
|
77
|
+
Do you have an Exa API key?
|
|
78
|
+
- Get one at: https://exa.ai
|
|
79
|
+
- Enter your API key, or type 'skip' to configure later
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### For Filesystem:
|
|
83
|
+
Ask for allowed directories:
|
|
84
|
+
```
|
|
85
|
+
Which directories should the filesystem MCP have access to?
|
|
86
|
+
Default: Current working directory
|
|
87
|
+
Enter comma-separated paths, or press Enter for default
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### For GitHub:
|
|
91
|
+
Ask for token:
|
|
92
|
+
```
|
|
93
|
+
Do you have a GitHub Personal Access Token?
|
|
94
|
+
- Create one at: https://github.com/settings/tokens
|
|
95
|
+
- Recommended scopes: repo, read:org
|
|
96
|
+
- Enter your token, or type 'skip' to configure later
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## Step 3: Add MCP Servers Using CLI
|
|
100
|
+
|
|
101
|
+
Use the `codex mcp add` command to configure each MCP server.
|
|
102
|
+
|
|
103
|
+
### Context7 Configuration:
|
|
104
|
+
```bash
|
|
105
|
+
codex mcp add context7 -- npx -y @upstash/context7-mcp
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Exa Web Search Configuration:
|
|
109
|
+
```bash
|
|
110
|
+
codex mcp add -e EXA_API_KEY=<user-provided-key> exa -- npx -y exa-mcp-server
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Filesystem Configuration:
|
|
114
|
+
```bash
|
|
115
|
+
codex mcp add filesystem -- npx -y @modelcontextprotocol/server-filesystem <allowed-directories>
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### GitHub Configuration:
|
|
119
|
+
|
|
120
|
+
**Option 1: Docker (local)**
|
|
121
|
+
```bash
|
|
122
|
+
codex mcp add -e GITHUB_PERSONAL_ACCESS_TOKEN=<user-provided-token> github -- docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN ghcr.io/github/github-mcp-server
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
**Option 2: HTTP (remote)**
|
|
126
|
+
```bash
|
|
127
|
+
codex mcp add --transport http github https://api.githubcopilot.com/mcp/
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
> Note: Docker option requires Docker installed. HTTP option is simpler but may have different capabilities.
|
|
131
|
+
|
|
132
|
+
## Step 4: Verify Installation
|
|
133
|
+
|
|
134
|
+
After configuration, verify the MCP servers are properly set up:
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
# List configured MCP servers
|
|
138
|
+
codex mcp list
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
This will display all configured MCP servers and their status.
|
|
142
|
+
|
|
143
|
+
## Step 5: Show Completion Message
|
|
144
|
+
|
|
145
|
+
```
|
|
146
|
+
MCP Server Configuration Complete!
|
|
147
|
+
|
|
148
|
+
CONFIGURED SERVERS:
|
|
149
|
+
[List the servers that were configured]
|
|
150
|
+
|
|
151
|
+
NEXT STEPS:
|
|
152
|
+
1. Restart Codex for changes to take effect
|
|
153
|
+
2. The configured MCP tools will be available to all agents
|
|
154
|
+
3. Run `codex mcp list` to verify configuration
|
|
155
|
+
|
|
156
|
+
USAGE TIPS:
|
|
157
|
+
- Context7: Ask about library documentation (e.g., "How do I use React hooks?")
|
|
158
|
+
- Exa: Use for web searches (e.g., "Search the web for latest TypeScript features")
|
|
159
|
+
- Filesystem: Extended file operations beyond the working directory
|
|
160
|
+
- GitHub: Interact with GitHub repos, issues, and PRs
|
|
161
|
+
|
|
162
|
+
TROUBLESHOOTING:
|
|
163
|
+
- If MCP servers don't appear, run `codex mcp list` to check status
|
|
164
|
+
- Ensure you have Node.js 18+ installed for npx-based servers
|
|
165
|
+
- For GitHub Docker option, ensure Docker is installed and running
|
|
166
|
+
- Run $doctor to diagnose issues
|
|
167
|
+
|
|
168
|
+
MANAGING MCP SERVERS:
|
|
169
|
+
- Add more servers: $mcp-setup or `codex mcp add ...`
|
|
170
|
+
- List servers: `codex mcp list`
|
|
171
|
+
- Remove a server: `codex mcp remove <server-name>`
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
## Custom MCP Server
|
|
175
|
+
|
|
176
|
+
If user selects "Custom":
|
|
177
|
+
|
|
178
|
+
Ask for:
|
|
179
|
+
1. Server name (identifier)
|
|
180
|
+
2. Transport type: `stdio` (default) or `http`
|
|
181
|
+
3. For stdio: Command and arguments (e.g., `npx my-mcp-server`)
|
|
182
|
+
4. For http: URL (e.g., `https://example.com/mcp`)
|
|
183
|
+
5. Environment variables (optional, key=value pairs)
|
|
184
|
+
6. HTTP headers (optional, for http transport only)
|
|
185
|
+
|
|
186
|
+
Then construct and run the appropriate `codex mcp add` command:
|
|
187
|
+
|
|
188
|
+
**For stdio servers:**
|
|
189
|
+
```bash
|
|
190
|
+
# Without environment variables
|
|
191
|
+
codex mcp add <server-name> -- <command> [args...]
|
|
192
|
+
|
|
193
|
+
# With environment variables
|
|
194
|
+
codex mcp add -e KEY1=value1 -e KEY2=value2 <server-name> -- <command> [args...]
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
**For HTTP servers:**
|
|
198
|
+
```bash
|
|
199
|
+
# Basic HTTP server
|
|
200
|
+
codex mcp add --transport http <server-name> <url>
|
|
201
|
+
|
|
202
|
+
# HTTP server with headers
|
|
203
|
+
codex mcp add --transport http --header "Authorization: Bearer <token>" <server-name> <url>
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
## Common Issues
|
|
207
|
+
|
|
208
|
+
### MCP Server Not Loading
|
|
209
|
+
- Ensure Node.js 18+ is installed
|
|
210
|
+
- Check that npx is available in PATH
|
|
211
|
+
- Run `codex mcp list` to verify server status
|
|
212
|
+
- Check server logs for errors
|
|
213
|
+
|
|
214
|
+
### API Key Issues
|
|
215
|
+
- Exa: Verify key at https://dashboard.exa.ai
|
|
216
|
+
- GitHub: Ensure token has required scopes (repo, read:org)
|
|
217
|
+
- Re-run `codex mcp add` with correct credentials if needed
|
|
218
|
+
|
|
219
|
+
### Agents Still Using Built-in Tools
|
|
220
|
+
- Restart Codex after configuration
|
|
221
|
+
- The built-in websearch will be deprioritized when exa is configured
|
|
222
|
+
- Run `codex mcp list` to confirm servers are active
|
|
223
|
+
|
|
224
|
+
### Removing or Updating a Server
|
|
225
|
+
- Remove: `codex mcp remove <server-name>`
|
|
226
|
+
- Update: Remove the old server, then add it again with new configuration
|