@mison/ag-kit-cn 3.0.0-beta.0 → 3.0.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/CHANGELOG.md +13 -11
- package/README.md +70 -35
- package/bin/adapters/codex.js +105 -372
- package/bin/adapters/gemini.js +133 -13
- package/bin/ag-kit.js +557 -155
- package/bin/core/builder.js +1 -1
- package/bin/core/generator.js +4 -4
- package/bin/core/resource-loader.js +2 -2
- package/bin/interactive.js +36 -81
- package/bin/utils/manifest.js +3 -3
- package/bin/utils.js +8 -3
- package/docs/PLAN.md +39 -0
- package/docs/TECH.md +136 -0
- package/package.json +11 -10
- package/scripts/ci-verify.js +95 -0
- package/scripts/clean.js +123 -0
- package/scripts/health-check.js +132 -0
- package/scripts/health-check.sh +6 -0
- package/tests/atomic-writer.test.js +47 -0
- package/tests/clean-script.test.js +77 -0
- package/tests/cli-smoke.test.js +479 -0
- package/tests/codex-adapter.test.js +132 -0
- package/tests/doctor.test.js +94 -0
- package/tests/gemini-adapter.test.js +30 -0
- package/tests/generator.test.js +48 -0
- package/tests/git-helper.test.js +53 -0
- package/tests/global-sync.test.js +133 -0
- package/tests/health-check-script.test.js +30 -0
- package/tests/managed-block.test.js +41 -0
- package/tests/manifest.test.js +97 -0
- package/tests/package-tarball.test.js +27 -0
- package/tests/phase-c.test.js +107 -0
- package/tests/standards-compliance.test.js +266 -0
- package/tests/transformer.test.js +74 -0
- package/docs/codex-rules-template.md +0 -36
- package/docs/mapping-spec.md +0 -62
- package/docs/multi-target-adapter.md +0 -46
- package/docs/official/README.md +0 -45
- package/docs/official/antigravity/agent-modes-settings.md +0 -64
- package/docs/official/antigravity/rules-workflows.md +0 -96
- package/docs/official/antigravity/skills.md +0 -147
- package/docs/official/codex/agents-md.md +0 -119
- package/docs/official/codex/config-advanced.md +0 -358
- package/docs/official/codex/config-basic.md +0 -141
- package/docs/official/codex/config-reference.md +0 -223
- package/docs/official/codex/config-sample.md +0 -216
- package/docs/official/codex/mcp.md +0 -107
- package/docs/official/codex/rules.md +0 -79
- package/docs/official/codex/skills.md +0 -114
- package/docs/official/mechanism-compat-audit-2026-03-04.md +0 -36
- package/docs/official/rules-baseline.md +0 -67
- package/docs/official/sources-index.md +0 -79
- package/docs/operations.md +0 -75
- package/docs/terminology-style-guide.md +0 -69
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/charts.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/colors.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/icons.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/landing.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/products.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/prompts.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/react-performance.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/stacks/flutter.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/stacks/html-tailwind.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/stacks/jetpack-compose.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/stacks/nextjs.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/stacks/nuxt-ui.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/stacks/nuxtjs.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/stacks/react-native.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/stacks/react.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/stacks/shadcn.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/stacks/svelte.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/stacks/swiftui.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/stacks/vue.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/styles.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/typography.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/ui-reasoning.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/ux-guidelines.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/data/web-interface.csv +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/scripts/core.py +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/scripts/design_system.py +0 -0
- /package/{.agent → .agents}/.shared/ui-ux-pro-max/scripts/search.py +0 -0
- /package/{.agent → .agents}/ARCHITECTURE.md +0 -0
- /package/{.agent → .agents}/agents/backend-specialist.md +0 -0
- /package/{.agent → .agents}/agents/code-archaeologist.md +0 -0
- /package/{.agent → .agents}/agents/database-architect.md +0 -0
- /package/{.agent → .agents}/agents/debugger.md +0 -0
- /package/{.agent → .agents}/agents/devops-engineer.md +0 -0
- /package/{.agent → .agents}/agents/documentation-writer.md +0 -0
- /package/{.agent → .agents}/agents/explorer-agent.md +0 -0
- /package/{.agent → .agents}/agents/frontend-specialist.md +0 -0
- /package/{.agent → .agents}/agents/game-developer.md +0 -0
- /package/{.agent → .agents}/agents/mobile-developer.md +0 -0
- /package/{.agent → .agents}/agents/orchestrator.md +0 -0
- /package/{.agent → .agents}/agents/penetration-tester.md +0 -0
- /package/{.agent → .agents}/agents/performance-optimizer.md +0 -0
- /package/{.agent → .agents}/agents/product-manager.md +0 -0
- /package/{.agent → .agents}/agents/product-owner.md +0 -0
- /package/{.agent → .agents}/agents/project-planner.md +0 -0
- /package/{.agent → .agents}/agents/qa-automation-engineer.md +0 -0
- /package/{.agent → .agents}/agents/security-auditor.md +0 -0
- /package/{.agent → .agents}/agents/seo-specialist.md +0 -0
- /package/{.agent → .agents}/agents/test-engineer.md +0 -0
- /package/{.agent → .agents}/mcp_config.json +0 -0
- /package/{.agent → .agents}/rules/GEMINI.md +0 -0
- /package/{.agent → .agents}/scripts/auto_preview.py +0 -0
- /package/{.agent → .agents}/scripts/checklist.py +0 -0
- /package/{.agent → .agents}/scripts/session_manager.py +0 -0
- /package/{.agent → .agents}/scripts/verify_all.py +0 -0
- /package/{.agent → .agents}/skills/api-patterns/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/api-patterns/api-style.md +0 -0
- /package/{.agent → .agents}/skills/api-patterns/auth.md +0 -0
- /package/{.agent → .agents}/skills/api-patterns/documentation.md +0 -0
- /package/{.agent → .agents}/skills/api-patterns/graphql.md +0 -0
- /package/{.agent → .agents}/skills/api-patterns/rate-limiting.md +0 -0
- /package/{.agent → .agents}/skills/api-patterns/response.md +0 -0
- /package/{.agent → .agents}/skills/api-patterns/rest.md +0 -0
- /package/{.agent → .agents}/skills/api-patterns/scripts/api_validator.py +0 -0
- /package/{.agent → .agents}/skills/api-patterns/security-testing.md +0 -0
- /package/{.agent → .agents}/skills/api-patterns/trpc.md +0 -0
- /package/{.agent → .agents}/skills/api-patterns/versioning.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/agent-coordination.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/feature-building.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/project-detection.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/scaffolding.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/tech-stack.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/templates/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/templates/astro-static/TEMPLATE.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/templates/chrome-extension/TEMPLATE.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/templates/cli-tool/TEMPLATE.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/templates/electron-desktop/TEMPLATE.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/templates/express-api/TEMPLATE.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/templates/flutter-app/TEMPLATE.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/templates/nextjs-static/TEMPLATE.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/templates/nuxt-app/TEMPLATE.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/templates/python-fastapi/TEMPLATE.md +0 -0
- /package/{.agent → .agents}/skills/app-builder/templates/react-native-app/TEMPLATE.md +0 -0
- /package/{.agent → .agents}/skills/architecture/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/architecture/context-discovery.md +0 -0
- /package/{.agent → .agents}/skills/architecture/examples.md +0 -0
- /package/{.agent → .agents}/skills/architecture/pattern-selection.md +0 -0
- /package/{.agent → .agents}/skills/architecture/patterns-reference.md +0 -0
- /package/{.agent → .agents}/skills/architecture/trade-off-analysis.md +0 -0
- /package/{.agent → .agents}/skills/bash-linux/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/behavioral-modes/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/brainstorming/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/brainstorming/dynamic-questioning.md +0 -0
- /package/{.agent → .agents}/skills/clean-code/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/code-review-checklist/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/database-design/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/database-design/database-selection.md +0 -0
- /package/{.agent → .agents}/skills/database-design/indexing.md +0 -0
- /package/{.agent → .agents}/skills/database-design/migrations.md +0 -0
- /package/{.agent → .agents}/skills/database-design/optimization.md +0 -0
- /package/{.agent → .agents}/skills/database-design/orm-selection.md +0 -0
- /package/{.agent → .agents}/skills/database-design/schema-design.md +0 -0
- /package/{.agent → .agents}/skills/database-design/scripts/schema_validator.py +0 -0
- /package/{.agent → .agents}/skills/deployment-procedures/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/doc.md +0 -0
- /package/{.agent → .agents}/skills/documentation-templates/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/frontend-design/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/frontend-design/animation-guide.md +0 -0
- /package/{.agent → .agents}/skills/frontend-design/color-system.md +0 -0
- /package/{.agent → .agents}/skills/frontend-design/decision-trees.md +0 -0
- /package/{.agent → .agents}/skills/frontend-design/motion-graphics.md +0 -0
- /package/{.agent → .agents}/skills/frontend-design/scripts/accessibility_checker.py +0 -0
- /package/{.agent → .agents}/skills/frontend-design/scripts/ux_audit.py +0 -0
- /package/{.agent → .agents}/skills/frontend-design/typography-system.md +0 -0
- /package/{.agent → .agents}/skills/frontend-design/ux-psychology.md +0 -0
- /package/{.agent → .agents}/skills/frontend-design/visual-effects.md +0 -0
- /package/{.agent → .agents}/skills/game-development/2d-games/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/game-development/3d-games/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/game-development/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/game-development/game-art/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/game-development/game-audio/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/game-development/game-design/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/game-development/mobile-games/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/game-development/multiplayer/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/game-development/pc-games/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/game-development/vr-ar/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/game-development/web-games/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/geo-fundamentals/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/geo-fundamentals/scripts/geo_checker.py +0 -0
- /package/{.agent → .agents}/skills/i18n-localization/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/i18n-localization/scripts/i18n_checker.py +0 -0
- /package/{.agent → .agents}/skills/intelligent-routing/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/lint-and-validate/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/lint-and-validate/scripts/lint_runner.py +0 -0
- /package/{.agent → .agents}/skills/lint-and-validate/scripts/type_coverage.py +0 -0
- /package/{.agent → .agents}/skills/mcp-builder/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/mobile-design/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/mobile-design/decision-trees.md +0 -0
- /package/{.agent → .agents}/skills/mobile-design/mobile-backend.md +0 -0
- /package/{.agent → .agents}/skills/mobile-design/mobile-color-system.md +0 -0
- /package/{.agent → .agents}/skills/mobile-design/mobile-debugging.md +0 -0
- /package/{.agent → .agents}/skills/mobile-design/mobile-design-thinking.md +0 -0
- /package/{.agent → .agents}/skills/mobile-design/mobile-navigation.md +0 -0
- /package/{.agent → .agents}/skills/mobile-design/mobile-performance.md +0 -0
- /package/{.agent → .agents}/skills/mobile-design/mobile-testing.md +0 -0
- /package/{.agent → .agents}/skills/mobile-design/mobile-typography.md +0 -0
- /package/{.agent → .agents}/skills/mobile-design/platform-android.md +0 -0
- /package/{.agent → .agents}/skills/mobile-design/platform-ios.md +0 -0
- /package/{.agent → .agents}/skills/mobile-design/scripts/mobile_audit.py +0 -0
- /package/{.agent → .agents}/skills/mobile-design/touch-psychology.md +0 -0
- /package/{.agent → .agents}/skills/nextjs-react-expert/1-async-eliminating-waterfalls.md +0 -0
- /package/{.agent → .agents}/skills/nextjs-react-expert/2-bundle-bundle-size-optimization.md +0 -0
- /package/{.agent → .agents}/skills/nextjs-react-expert/3-server-server-side-performance.md +0 -0
- /package/{.agent → .agents}/skills/nextjs-react-expert/4-client-client-side-data-fetching.md +0 -0
- /package/{.agent → .agents}/skills/nextjs-react-expert/5-rerender-re-render-optimization.md +0 -0
- /package/{.agent → .agents}/skills/nextjs-react-expert/6-rendering-rendering-performance.md +0 -0
- /package/{.agent → .agents}/skills/nextjs-react-expert/7-js-javascript-performance.md +0 -0
- /package/{.agent → .agents}/skills/nextjs-react-expert/8-advanced-advanced-patterns.md +0 -0
- /package/{.agent → .agents}/skills/nextjs-react-expert/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/nextjs-react-expert/scripts/convert_rules.py +0 -0
- /package/{.agent → .agents}/skills/nextjs-react-expert/scripts/react_performance_checker.py +0 -0
- /package/{.agent → .agents}/skills/nodejs-best-practices/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/parallel-agents/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/performance-profiling/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/performance-profiling/scripts/lighthouse_audit.py +0 -0
- /package/{.agent → .agents}/skills/plan-writing/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/powershell-windows/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/python-patterns/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/red-team-tactics/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/refactoring-patterns/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/rust-pro/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/seo-fundamentals/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/seo-fundamentals/scripts/seo_checker.py +0 -0
- /package/{.agent → .agents}/skills/server-management/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/systematic-debugging/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/tailwind-patterns/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/tdd-workflow/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/testing-patterns/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/testing-patterns/scripts/test_runner.py +0 -0
- /package/{.agent → .agents}/skills/vulnerability-scanner/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/vulnerability-scanner/checklists.md +0 -0
- /package/{.agent → .agents}/skills/vulnerability-scanner/scripts/security_scan.py +0 -0
- /package/{.agent → .agents}/skills/web-design-guidelines/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/webapp-testing/SKILL.md +0 -0
- /package/{.agent → .agents}/skills/webapp-testing/scripts/playwright_runner.py +0 -0
- /package/{.agent → .agents}/workflows/brainstorm.md +0 -0
- /package/{.agent → .agents}/workflows/create.md +0 -0
- /package/{.agent → .agents}/workflows/debug.md +0 -0
- /package/{.agent → .agents}/workflows/deploy.md +0 -0
- /package/{.agent → .agents}/workflows/enhance.md +0 -0
- /package/{.agent → .agents}/workflows/orchestrate.md +0 -0
- /package/{.agent → .agents}/workflows/plan.md +0 -0
- /package/{.agent → .agents}/workflows/preview.md +0 -0
- /package/{.agent → .agents}/workflows/restore-localize-compat.md +0 -0
- /package/{.agent → .agents}/workflows/status.md +0 -0
- /package/{.agent → .agents}/workflows/test.md +0 -0
- /package/{.agent → .agents}/workflows/ui-ux-pro-max.md +0 -0
|
@@ -1,141 +0,0 @@
|
|
|
1
|
-
# 配置基础(Config basics)
|
|
2
|
-
|
|
3
|
-
> 来源:`https://developers.openai.com/codex/config-basic`
|
|
4
|
-
> 同步日期:2026-02-12
|
|
5
|
-
> 说明:本文件为官方内容的中文整理版,采用标准 Markdown 语法。
|
|
6
|
-
|
|
7
|
-
Codex 会从多个层级读取配置。用户默认配置位于 `~/.codex/config.toml`,也可以在项目内通过 `.codex/config.toml` 做覆盖。
|
|
8
|
-
出于安全考虑,项目级配置只会在“受信任项目”中加载。
|
|
9
|
-
|
|
10
|
-
## Codex 配置文件
|
|
11
|
-
|
|
12
|
-
- 用户级配置:`~/.codex/config.toml`
|
|
13
|
-
- 项目级配置:`<repo>/.codex/config.toml`
|
|
14
|
-
|
|
15
|
-
在 Codex IDE 扩展中可通过右上角齿轮进入:
|
|
16
|
-
|
|
17
|
-
`Codex Settings > Open config.toml`
|
|
18
|
-
|
|
19
|
-
CLI 与 IDE 共享同一套配置层。你可以用它:
|
|
20
|
-
|
|
21
|
-
- 设置默认模型与提供方(provider)
|
|
22
|
-
- 配置审批策略与沙箱
|
|
23
|
-
- 配置 MCP 服务器
|
|
24
|
-
|
|
25
|
-
## 配置优先级(从高到低)
|
|
26
|
-
|
|
27
|
-
1. CLI 参数与 `--config` 覆盖值
|
|
28
|
-
2. `--profile <name>` 对应的 profile 配置
|
|
29
|
-
3. 项目级 `.codex/config.toml`(从项目根到当前目录逐层加载,越近优先级越高,仅受信任项目)
|
|
30
|
-
4. 用户级配置 `~/.codex/config.toml`
|
|
31
|
-
5. 系统级配置(Unix 上可能存在 `/etc/codex/config.toml`)
|
|
32
|
-
6. 内置默认值
|
|
33
|
-
|
|
34
|
-
建议:
|
|
35
|
-
|
|
36
|
-
- 把通用默认值放在用户级配置
|
|
37
|
-
- 把场景差异放进 profile
|
|
38
|
-
|
|
39
|
-
如果项目被标记为“不受信任”,Codex 会跳过项目内 `.codex/` 层,回退到用户级/系统级/内置默认值。
|
|
40
|
-
|
|
41
|
-
## 常用配置项
|
|
42
|
-
|
|
43
|
-
### 默认模型
|
|
44
|
-
|
|
45
|
-
```toml
|
|
46
|
-
model = "gpt-5.2"
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
### 命令审批策略
|
|
50
|
-
|
|
51
|
-
```toml
|
|
52
|
-
approval_policy = "on-request"
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
### 沙箱级别
|
|
56
|
-
|
|
57
|
-
```toml
|
|
58
|
-
sandbox_mode = "workspace-write"
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
### Web Search 模式
|
|
62
|
-
|
|
63
|
-
`web_search` 可选值:
|
|
64
|
-
|
|
65
|
-
- `"cached"`:使用缓存检索结果(默认)
|
|
66
|
-
- `"live"`:实时联网检索(等价 `--search`)
|
|
67
|
-
- `"disabled"`:关闭 Web Search
|
|
68
|
-
|
|
69
|
-
```toml
|
|
70
|
-
web_search = "cached"
|
|
71
|
-
# web_search = "live"
|
|
72
|
-
# web_search = "disabled"
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
### 推理强度
|
|
76
|
-
|
|
77
|
-
```toml
|
|
78
|
-
model_reasoning_effort = "high"
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
### 沟通风格
|
|
82
|
-
|
|
83
|
-
```toml
|
|
84
|
-
personality = "friendly" # 或 pragmatic / none
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
### 子进程环境变量策略
|
|
88
|
-
|
|
89
|
-
```toml
|
|
90
|
-
[shell_environment_policy]
|
|
91
|
-
include_only = ["PATH", "HOME"]
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
### 日志目录
|
|
95
|
-
|
|
96
|
-
```toml
|
|
97
|
-
log_dir = "/absolute/path/to/codex-logs"
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
也可在单次运行时覆盖:
|
|
101
|
-
|
|
102
|
-
```bash
|
|
103
|
-
codex -c log_dir=./.codex-log
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
## 功能开关(Feature Flags)
|
|
107
|
-
|
|
108
|
-
在 `config.toml` 中使用 `[features]` 表启用/禁用可选能力。
|
|
109
|
-
|
|
110
|
-
```toml
|
|
111
|
-
[features]
|
|
112
|
-
shell_snapshot = true
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
### 常见功能键
|
|
116
|
-
|
|
117
|
-
| 键名 | 默认值 | 成熟度 | 说明 |
|
|
118
|
-
| :--- | :---: | :--- | :--- |
|
|
119
|
-
| `collaboration_modes` | `true` | Stable | 协作模式(如 plan mode) |
|
|
120
|
-
| `personality` | `true` | Stable | 人格/沟通风格控制 |
|
|
121
|
-
| `request_rule` | `true` | Stable | 智能审批(`prefix_rule` 建议) |
|
|
122
|
-
| `shell_tool` | `true` | Stable | 默认 shell 工具 |
|
|
123
|
-
| `undo` | `true` | Stable | 按回合撤销能力 |
|
|
124
|
-
| `shell_snapshot` | `false` | Beta | Shell 快照加速重复命令 |
|
|
125
|
-
| `unified_exec` | `false` | Beta | PTY 统一执行工具 |
|
|
126
|
-
| `apply_patch_freeform` | `false` | Experimental | 启用自由格式 `apply_patch` |
|
|
127
|
-
| `apps` | `false` | Experimental | 启用 Apps/Connectors |
|
|
128
|
-
| `runtime_metrics` | `false` | Experimental | 在 TUI 展示运行指标 |
|
|
129
|
-
| `remote_models` | `false` | Experimental | 启动前刷新远程模型列表 |
|
|
130
|
-
| `web_search` | `true` | Deprecated | 旧开关,建议改用顶层 `web_search` |
|
|
131
|
-
|
|
132
|
-
说明:
|
|
133
|
-
|
|
134
|
-
- 未写入某个功能键时,沿用默认值。
|
|
135
|
-
- 建议优先使用 Stable/Beta 功能,Experimental 功能需谨慎启用。
|
|
136
|
-
|
|
137
|
-
### 启用与禁用方式
|
|
138
|
-
|
|
139
|
-
- 在 `config.toml` 的 `[features]` 下设置 `feature_name = true/false`
|
|
140
|
-
- CLI 启用:`codex --enable feature_name`
|
|
141
|
-
- CLI 连续启用多个:`codex --enable a --enable b`
|
|
@@ -1,223 +0,0 @@
|
|
|
1
|
-
# 配置参考(Configuration Reference)
|
|
2
|
-
|
|
3
|
-
> 来源:`https://developers.openai.com/codex/config-reference`
|
|
4
|
-
> 同步日期:2026-02-12
|
|
5
|
-
> 说明:本文件为官方内容的中文整理版,采用标准 Markdown 语法。
|
|
6
|
-
> 说明:完整示例请结合 `config-sample.md` 一并阅读。
|
|
7
|
-
|
|
8
|
-
本页用于快速检索 Codex 常用配置项。
|
|
9
|
-
配置分为两类:
|
|
10
|
-
|
|
11
|
-
- `config.toml`:运行时配置
|
|
12
|
-
- `requirements.toml`:受管控环境下的限制策略
|
|
13
|
-
|
|
14
|
-
## `config.toml`
|
|
15
|
-
|
|
16
|
-
### 核心与模型
|
|
17
|
-
|
|
18
|
-
| 键 | 类型 | 说明 |
|
|
19
|
-
| :--- | :--- | :--- |
|
|
20
|
-
| `model` | string | 默认模型名称 |
|
|
21
|
-
| `review_model` | string | `/review` 专用模型(可选) |
|
|
22
|
-
| `model_provider` | string | 当前模型提供方 ID |
|
|
23
|
-
| `oss_provider` | string | `--oss` 模式默认本地 provider |
|
|
24
|
-
| `model_context_window` | number | 模型上下文窗口 token 上限 |
|
|
25
|
-
| `model_auto_compact_token_limit` | number | 自动压缩触发阈值 |
|
|
26
|
-
| `tool_output_token_limit` | number | 单次工具输出的 token 限制 |
|
|
27
|
-
| `log_dir` | string | 本地日志目录 |
|
|
28
|
-
|
|
29
|
-
### 推理与表达
|
|
30
|
-
|
|
31
|
-
| 键 | 类型 | 说明 |
|
|
32
|
-
| :--- | :--- | :--- |
|
|
33
|
-
| `model_reasoning_effort` | string | 推理强度(如 `low`/`medium`/`high`) |
|
|
34
|
-
| `model_reasoning_summary` | string | 推理摘要策略 |
|
|
35
|
-
| `model_verbosity` | string | 响应冗长度 |
|
|
36
|
-
| `model_supports_reasoning_summaries` | bool | 强制声明支持推理摘要 |
|
|
37
|
-
| `personality` | string | 默认沟通风格(如 `friendly`) |
|
|
38
|
-
|
|
39
|
-
### 指令与提示词覆盖
|
|
40
|
-
|
|
41
|
-
| 键 | 类型 | 说明 |
|
|
42
|
-
| :--- | :--- | :--- |
|
|
43
|
-
| `developer_instructions` | string | 额外开发指令(优先于项目文档前注入) |
|
|
44
|
-
| `instructions` | string | 旧字段(兼容) |
|
|
45
|
-
| `compact_prompt` | string | 压缩提示词内联覆盖 |
|
|
46
|
-
| `model_instructions_file` | string | 覆盖内置基础指令的文件路径 |
|
|
47
|
-
| `experimental_compact_prompt_file` | string | 压缩提示词文件路径 |
|
|
48
|
-
|
|
49
|
-
### 审批与沙箱
|
|
50
|
-
|
|
51
|
-
| 键 | 类型 | 说明 |
|
|
52
|
-
| :--- | :--- | :--- |
|
|
53
|
-
| `approval_policy` | string | 审批策略(`untrusted`/`on-request`/`on-failure`/`never`) |
|
|
54
|
-
| `sandbox_mode` | string | 沙箱模式(`read-only`/`workspace-write`/`danger-full-access`) |
|
|
55
|
-
|
|
56
|
-
`[sandbox_workspace_write]` 子表常见键:
|
|
57
|
-
|
|
58
|
-
| 键 | 类型 | 说明 |
|
|
59
|
-
| :--- | :--- | :--- |
|
|
60
|
-
| `network_access` | bool | 是否允许沙箱内外网访问 |
|
|
61
|
-
| `writable_roots` | string[] | 额外可写目录白名单 |
|
|
62
|
-
| `exclude_tmpdir_env_var` | bool | 是否排除 `$TMPDIR` |
|
|
63
|
-
| `exclude_slash_tmp` | bool | 是否排除 `/tmp` |
|
|
64
|
-
|
|
65
|
-
### 身份与认证
|
|
66
|
-
|
|
67
|
-
| 键 | 类型 | 说明 |
|
|
68
|
-
| :--- | :--- | :--- |
|
|
69
|
-
| `cli_auth_credentials_store` | string | 凭据存储方式(`file`/`keyring`/`auto`) |
|
|
70
|
-
| `chatgpt_base_url` | string | ChatGPT 登录后端地址 |
|
|
71
|
-
| `forced_chatgpt_workspace_id` | string | 限定 ChatGPT workspace ID |
|
|
72
|
-
| `forced_login_method` | string | 强制登录方式(`chatgpt`/`api`) |
|
|
73
|
-
| `mcp_oauth_credentials_store` | string | MCP OAuth 凭据存储策略 |
|
|
74
|
-
| `mcp_oauth_callback_port` | number | MCP OAuth 回调端口 |
|
|
75
|
-
|
|
76
|
-
### 项目文档与根目录发现
|
|
77
|
-
|
|
78
|
-
| 键 | 类型 | 说明 |
|
|
79
|
-
| :--- | :--- | :--- |
|
|
80
|
-
| `project_doc_max_bytes` | number | 每层项目指令文档读取上限 |
|
|
81
|
-
| `project_doc_fallback_filenames` | string[] | `AGENTS.md` 缺失时的备选文件名 |
|
|
82
|
-
| `project_root_markers` | string[] | 项目根目录识别标记 |
|
|
83
|
-
|
|
84
|
-
### 历史与引用链接
|
|
85
|
-
|
|
86
|
-
| 键 | 类型 | 说明 |
|
|
87
|
-
| :--- | :--- | :--- |
|
|
88
|
-
| `file_opener` | string | 引用链接协议(`vscode`/`cursor`/`none` 等) |
|
|
89
|
-
|
|
90
|
-
`[history]` 子表:
|
|
91
|
-
|
|
92
|
-
| 键 | 类型 | 说明 |
|
|
93
|
-
| :--- | :--- | :--- |
|
|
94
|
-
| `persistence` | string | 历史持久化模式(`save-all`/`none`) |
|
|
95
|
-
| `max_bytes` | number | 历史文件大小上限 |
|
|
96
|
-
|
|
97
|
-
### Shell 环境策略
|
|
98
|
-
|
|
99
|
-
`[shell_environment_policy]` 子表:
|
|
100
|
-
|
|
101
|
-
| 键 | 类型 | 说明 |
|
|
102
|
-
| :--- | :--- | :--- |
|
|
103
|
-
| `inherit` | string | 继承策略(`all`/`core`/`none`) |
|
|
104
|
-
| `ignore_default_excludes` | bool | 是否忽略默认敏感变量过滤 |
|
|
105
|
-
| `exclude` | string[] | 额外排除模式 |
|
|
106
|
-
| `include_only` | string[] | 仅保留变量白名单 |
|
|
107
|
-
| `set` | table | 强制注入/覆盖变量 |
|
|
108
|
-
| `use_login_shell` | bool | 是否通过登录 shell 初始化 |
|
|
109
|
-
|
|
110
|
-
### 通知与界面
|
|
111
|
-
|
|
112
|
-
| 键 | 类型 | 说明 |
|
|
113
|
-
| :--- | :--- | :--- |
|
|
114
|
-
| `notify` | string[] | 外部通知程序命令 |
|
|
115
|
-
| `hide_agent_reasoning` | bool | 隐藏推理事件输出 |
|
|
116
|
-
| `show_raw_agent_reasoning` | bool | 显示原始推理内容 |
|
|
117
|
-
| `disable_response_storage` | bool | 禁止响应存储(若版本支持) |
|
|
118
|
-
| `profile` | string | 默认 profile 名称 |
|
|
119
|
-
| `web_search` | string | Web Search 模式(`cached`/`live`/`disabled`) |
|
|
120
|
-
|
|
121
|
-
`[tui]` 子表常见键:
|
|
122
|
-
|
|
123
|
-
| 键 | 类型 | 说明 |
|
|
124
|
-
| :--- | :--- | :--- |
|
|
125
|
-
| `notifications` | bool/string[] | TUI 通知开关或事件白名单 |
|
|
126
|
-
| `notification_method` | string | 终端通知方式(`auto`/`osc9`/`bel`) |
|
|
127
|
-
| `animations` | bool | 是否启用动画 |
|
|
128
|
-
| `alternate_screen` | string | 是否使用备用屏幕 |
|
|
129
|
-
| `show_tooltips` | bool | 是否显示引导提示 |
|
|
130
|
-
| `status_line` | string[] | 底部状态栏项 |
|
|
131
|
-
|
|
132
|
-
### 中央功能开关
|
|
133
|
-
|
|
134
|
-
`[features]` 子表(示例):
|
|
135
|
-
|
|
136
|
-
| 键 | 类型 | 说明 |
|
|
137
|
-
| :--- | :--- | :--- |
|
|
138
|
-
| `collaboration_modes` | bool | 协作模式能力 |
|
|
139
|
-
| `request_rule` | bool | 智能审批建议 |
|
|
140
|
-
| `shell_snapshot` | bool | Shell 快照 |
|
|
141
|
-
| `unified_exec` | bool | 统一执行工具 |
|
|
142
|
-
| `apply_patch_freeform` | bool | 自由格式补丁工具 |
|
|
143
|
-
| `apps` | bool | Apps/Connectors |
|
|
144
|
-
| `personality` | bool | 风格控制能力 |
|
|
145
|
-
| `runtime_metrics` | bool | 运行指标展示 |
|
|
146
|
-
| `remote_models` | bool | 远程模型刷新 |
|
|
147
|
-
|
|
148
|
-
### MCP 服务器
|
|
149
|
-
|
|
150
|
-
`[mcp_servers.<name>]` 支持两类配置:
|
|
151
|
-
|
|
152
|
-
1. **STDIO**:`command` + `args`
|
|
153
|
-
2. **HTTP**:`url`
|
|
154
|
-
|
|
155
|
-
常见键:
|
|
156
|
-
|
|
157
|
-
- `enabled`
|
|
158
|
-
- `required`
|
|
159
|
-
- `env` / `env_vars`
|
|
160
|
-
- `http_headers` / `env_http_headers`
|
|
161
|
-
- `startup_timeout_sec`
|
|
162
|
-
- `tool_timeout_sec`
|
|
163
|
-
- `enabled_tools`
|
|
164
|
-
- `disabled_tools`
|
|
165
|
-
- `bearer_token_env_var`
|
|
166
|
-
|
|
167
|
-
### 模型提供方
|
|
168
|
-
|
|
169
|
-
`[model_providers.<name>]` 常见键:
|
|
170
|
-
|
|
171
|
-
- `name`
|
|
172
|
-
- `base_url`
|
|
173
|
-
- `wire_api`(`responses` / `chat`)
|
|
174
|
-
- `env_key`
|
|
175
|
-
- `query_params`
|
|
176
|
-
- `http_headers`
|
|
177
|
-
- `env_http_headers`
|
|
178
|
-
- `request_max_retries`
|
|
179
|
-
- `stream_max_retries`
|
|
180
|
-
- `stream_idle_timeout_ms`
|
|
181
|
-
|
|
182
|
-
### 其他常见子表
|
|
183
|
-
|
|
184
|
-
| 子表 | 用途 |
|
|
185
|
-
| :--- | :--- |
|
|
186
|
-
| `[profiles.<name>]` | 命名配置集 |
|
|
187
|
-
| `[skills.<path>]` | 按路径启停 Skill |
|
|
188
|
-
| `[apps.<app_name>]` | App/Connector 开关 |
|
|
189
|
-
| `[projects."<absolute_path>"]` | 项目信任级别 |
|
|
190
|
-
| `[analytics]` | 匿名指标开关 |
|
|
191
|
-
| `[feedback]` | `/feedback` 开关 |
|
|
192
|
-
| `[otel]` | OTel 总开关与导出策略 |
|
|
193
|
-
| `[otel.exporter."otlp-http"]` | OTel HTTP 导出 |
|
|
194
|
-
| `[otel.exporter."otlp-grpc"]` | OTel gRPC 导出 |
|
|
195
|
-
|
|
196
|
-
## `requirements.toml`
|
|
197
|
-
|
|
198
|
-
`requirements.toml` 用于组织/企业环境“限制可用能力”,防止本地配置越权。
|
|
199
|
-
|
|
200
|
-
### 常见限制项
|
|
201
|
-
|
|
202
|
-
| 键 | 类型 | 说明 |
|
|
203
|
-
| :--- | :--- | :--- |
|
|
204
|
-
| `allowed_approval_policies` | string[] | 允许的审批策略集合 |
|
|
205
|
-
| `allowed_sandbox_modes` | string[] | 允许的沙箱模式集合 |
|
|
206
|
-
|
|
207
|
-
### MCP 约束(示例)
|
|
208
|
-
|
|
209
|
-
```toml
|
|
210
|
-
allowed_approval_policies = ["untrusted", "on-request", "on-failure"]
|
|
211
|
-
allowed_sandbox_modes = ["read-only", "workspace-write"]
|
|
212
|
-
|
|
213
|
-
[mcp_servers.docs]
|
|
214
|
-
identity = { command = "codex-mcp" }
|
|
215
|
-
|
|
216
|
-
[mcp_servers.remote]
|
|
217
|
-
identity = { url = "https://example.com/mcp" }
|
|
218
|
-
```
|
|
219
|
-
|
|
220
|
-
说明:
|
|
221
|
-
|
|
222
|
-
- 通过 `requirements.toml` 可以禁止高风险策略(如 `approval_policy = "never"`、`sandbox_mode = "danger-full-access"`)。
|
|
223
|
-
- 组织可用它统一团队安全基线。
|
|
@@ -1,216 +0,0 @@
|
|
|
1
|
-
# 配置示例(Sample Configuration)
|
|
2
|
-
|
|
3
|
-
> 来源:`https://developers.openai.com/codex/config-sample`
|
|
4
|
-
> 同步日期:2026-02-12
|
|
5
|
-
> 说明:本文件为官方内容的中文整理版,采用标准 Markdown 语法。
|
|
6
|
-
|
|
7
|
-
以下示例可作为 `config.toml` 起点。
|
|
8
|
-
按需复制你需要的键,不建议无差别全量粘贴。
|
|
9
|
-
|
|
10
|
-
```toml
|
|
11
|
-
################################################################################
|
|
12
|
-
# Codex 示例配置(config.toml)
|
|
13
|
-
# 说明:
|
|
14
|
-
# - 根键必须位于各表定义之前
|
|
15
|
-
# - 未设置的键会回退默认值
|
|
16
|
-
# - 示例中部分键为可选项,按需启用
|
|
17
|
-
################################################################################
|
|
18
|
-
|
|
19
|
-
################################################################################
|
|
20
|
-
# 核心模型
|
|
21
|
-
################################################################################
|
|
22
|
-
|
|
23
|
-
model = "gpt-5.2-codex"
|
|
24
|
-
model_provider = "openai"
|
|
25
|
-
# review_model = "gpt-5.2-codex"
|
|
26
|
-
# oss_provider = "ollama"
|
|
27
|
-
|
|
28
|
-
################################################################################
|
|
29
|
-
# 推理与冗长度
|
|
30
|
-
################################################################################
|
|
31
|
-
|
|
32
|
-
model_reasoning_effort = "medium" # minimal / low / medium / high / xhigh
|
|
33
|
-
model_reasoning_summary = "auto" # auto / concise / detailed / none
|
|
34
|
-
model_verbosity = "medium" # low / medium / high
|
|
35
|
-
# model_supports_reasoning_summaries = false
|
|
36
|
-
|
|
37
|
-
################################################################################
|
|
38
|
-
# 指令覆盖
|
|
39
|
-
################################################################################
|
|
40
|
-
|
|
41
|
-
# developer_instructions = "额外开发指令"
|
|
42
|
-
# instructions = "旧字段,兼容使用"
|
|
43
|
-
# compact_prompt = "覆盖压缩提示词"
|
|
44
|
-
# model_instructions_file = "/path/to/instructions.txt"
|
|
45
|
-
# experimental_compact_prompt_file = "/path/to/compact_prompt.txt"
|
|
46
|
-
|
|
47
|
-
################################################################################
|
|
48
|
-
# 审批与沙箱
|
|
49
|
-
################################################################################
|
|
50
|
-
|
|
51
|
-
approval_policy = "on-request" # untrusted / on-request / on-failure / never
|
|
52
|
-
sandbox_mode = "read-only" # read-only / workspace-write / danger-full-access
|
|
53
|
-
|
|
54
|
-
[sandbox_workspace_write]
|
|
55
|
-
network_access = false
|
|
56
|
-
exclude_tmpdir_env_var = false
|
|
57
|
-
exclude_slash_tmp = false
|
|
58
|
-
writable_roots = []
|
|
59
|
-
|
|
60
|
-
################################################################################
|
|
61
|
-
# 认证与登录
|
|
62
|
-
################################################################################
|
|
63
|
-
|
|
64
|
-
cli_auth_credentials_store = "file" # file / keyring / auto
|
|
65
|
-
# chatgpt_base_url = "https://chatgpt.com/backend-api/"
|
|
66
|
-
# forced_chatgpt_workspace_id = ""
|
|
67
|
-
# forced_login_method = "chatgpt" # chatgpt / api
|
|
68
|
-
# mcp_oauth_credentials_store = "auto" # auto / file / keyring
|
|
69
|
-
# mcp_oauth_callback_port = 4321
|
|
70
|
-
|
|
71
|
-
################################################################################
|
|
72
|
-
# 项目文档读取策略
|
|
73
|
-
################################################################################
|
|
74
|
-
|
|
75
|
-
project_doc_max_bytes = 32768
|
|
76
|
-
project_doc_fallback_filenames = []
|
|
77
|
-
project_root_markers = [".git"]
|
|
78
|
-
|
|
79
|
-
################################################################################
|
|
80
|
-
# Web Search
|
|
81
|
-
################################################################################
|
|
82
|
-
|
|
83
|
-
web_search = "cached" # cached / live / disabled
|
|
84
|
-
|
|
85
|
-
################################################################################
|
|
86
|
-
# 通知与输出
|
|
87
|
-
################################################################################
|
|
88
|
-
|
|
89
|
-
# notify = ["python3", "/path/to/notify.py"]
|
|
90
|
-
hide_agent_reasoning = false
|
|
91
|
-
show_raw_agent_reasoning = false
|
|
92
|
-
file_opener = "vscode" # vscode / cursor / windsurf / none
|
|
93
|
-
log_dir = "~/.codex/log"
|
|
94
|
-
|
|
95
|
-
################################################################################
|
|
96
|
-
# Shell 环境变量策略
|
|
97
|
-
################################################################################
|
|
98
|
-
|
|
99
|
-
[shell_environment_policy]
|
|
100
|
-
inherit = "all" # all / core / none
|
|
101
|
-
ignore_default_excludes = false
|
|
102
|
-
exclude = []
|
|
103
|
-
include_only = []
|
|
104
|
-
set = {}
|
|
105
|
-
use_login_shell = false
|
|
106
|
-
|
|
107
|
-
################################################################################
|
|
108
|
-
# 历史记录
|
|
109
|
-
################################################################################
|
|
110
|
-
|
|
111
|
-
[history]
|
|
112
|
-
persistence = "save-all" # save-all / none
|
|
113
|
-
# max_bytes = 104857600
|
|
114
|
-
|
|
115
|
-
################################################################################
|
|
116
|
-
# TUI 配置
|
|
117
|
-
################################################################################
|
|
118
|
-
|
|
119
|
-
[tui]
|
|
120
|
-
notifications = true # true / false / ["agent-turn-complete"]
|
|
121
|
-
# notification_method = "auto" # auto / osc9 / bel
|
|
122
|
-
animations = true
|
|
123
|
-
show_tooltips = true
|
|
124
|
-
alternate_screen = "auto"
|
|
125
|
-
# status_line = ["model", "context-remaining", "git-branch"]
|
|
126
|
-
|
|
127
|
-
################################################################################
|
|
128
|
-
# 功能开关(features)
|
|
129
|
-
################################################################################
|
|
130
|
-
|
|
131
|
-
[features]
|
|
132
|
-
collaboration_modes = true
|
|
133
|
-
request_rule = true
|
|
134
|
-
shell_tool = true
|
|
135
|
-
undo = true
|
|
136
|
-
shell_snapshot = false
|
|
137
|
-
unified_exec = false
|
|
138
|
-
apply_patch_freeform = false
|
|
139
|
-
personality = true
|
|
140
|
-
runtime_metrics = false
|
|
141
|
-
apps = false
|
|
142
|
-
|
|
143
|
-
################################################################################
|
|
144
|
-
# MCP 服务器示例
|
|
145
|
-
################################################################################
|
|
146
|
-
|
|
147
|
-
[mcp_servers.context7]
|
|
148
|
-
enabled = true
|
|
149
|
-
command = "npx"
|
|
150
|
-
args = ["-y", "@upstash/context7-mcp"]
|
|
151
|
-
startup_timeout_sec = 10.0
|
|
152
|
-
tool_timeout_sec = 60.0
|
|
153
|
-
|
|
154
|
-
[mcp_servers.github]
|
|
155
|
-
enabled = false
|
|
156
|
-
url = "https://github-mcp.example.com/mcp"
|
|
157
|
-
bearer_token_env_var = "GITHUB_TOKEN"
|
|
158
|
-
startup_timeout_sec = 10.0
|
|
159
|
-
tool_timeout_sec = 60.0
|
|
160
|
-
|
|
161
|
-
################################################################################
|
|
162
|
-
# Provider 示例
|
|
163
|
-
################################################################################
|
|
164
|
-
|
|
165
|
-
[model_providers.openai]
|
|
166
|
-
name = "OpenAI"
|
|
167
|
-
base_url = "https://api.openai.com/v1"
|
|
168
|
-
wire_api = "responses"
|
|
169
|
-
|
|
170
|
-
[model_providers.ollama]
|
|
171
|
-
name = "Ollama"
|
|
172
|
-
base_url = "http://localhost:11434/v1"
|
|
173
|
-
wire_api = "chat"
|
|
174
|
-
|
|
175
|
-
[model_providers.azure]
|
|
176
|
-
name = "Azure"
|
|
177
|
-
base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"
|
|
178
|
-
wire_api = "responses"
|
|
179
|
-
query_params = { api-version = "2025-04-01-preview" }
|
|
180
|
-
env_key = "AZURE_OPENAI_API_KEY"
|
|
181
|
-
|
|
182
|
-
################################################################################
|
|
183
|
-
# 命名配置集(profiles)
|
|
184
|
-
################################################################################
|
|
185
|
-
|
|
186
|
-
[profiles.deep-review]
|
|
187
|
-
model = "gpt-5-pro"
|
|
188
|
-
model_reasoning_effort = "high"
|
|
189
|
-
approval_policy = "on-request"
|
|
190
|
-
sandbox_mode = "read-only"
|
|
191
|
-
|
|
192
|
-
[profiles.fast-local]
|
|
193
|
-
model_provider = "ollama"
|
|
194
|
-
model = "qwen2.5-coder:14b"
|
|
195
|
-
approval_policy = "never"
|
|
196
|
-
sandbox_mode = "workspace-write"
|
|
197
|
-
|
|
198
|
-
################################################################################
|
|
199
|
-
# 其他策略开关
|
|
200
|
-
################################################################################
|
|
201
|
-
|
|
202
|
-
[analytics]
|
|
203
|
-
enabled = true
|
|
204
|
-
|
|
205
|
-
[feedback]
|
|
206
|
-
enabled = true
|
|
207
|
-
|
|
208
|
-
[projects."/absolute/path/to/project"]
|
|
209
|
-
trust_level = "trusted" # trusted / untrusted
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
## 使用建议
|
|
213
|
-
|
|
214
|
-
1. 先写最小配置:`model`、`approval_policy`、`sandbox_mode`。
|
|
215
|
-
2. 再按场景补充:`features`、`mcp_servers`、`model_providers`。
|
|
216
|
-
3. 团队协作时统一 `requirements.toml` 约束,避免配置越权。
|
|
@@ -1,107 +0,0 @@
|
|
|
1
|
-
# 模型上下文协议(MCP)
|
|
2
|
-
|
|
3
|
-
> 来源:`https://developers.openai.com/codex/mcp`
|
|
4
|
-
> 同步日期:2026-02-12
|
|
5
|
-
> 说明:本文件为官方内容的中文整理版,采用标准 Markdown 语法。
|
|
6
|
-
|
|
7
|
-
MCP(Model Context Protocol)用于把模型连接到外部工具与上下文。
|
|
8
|
-
在 Codex 中,你可以通过 MCP 让 Agent 访问第三方文档、浏览器工具、设计工具等。
|
|
9
|
-
|
|
10
|
-
Codex CLI 与 IDE 扩展都支持 MCP,且共用同一份配置。
|
|
11
|
-
|
|
12
|
-
## 支持的 MCP 类型
|
|
13
|
-
|
|
14
|
-
- `STDIO` 服务器(本地进程)
|
|
15
|
-
- 支持环境变量注入
|
|
16
|
-
- `Streamable HTTP` 服务器(远程地址)
|
|
17
|
-
- 支持 Bearer Token
|
|
18
|
-
- 支持 OAuth(若服务器支持)
|
|
19
|
-
|
|
20
|
-
## MCP 配置位置
|
|
21
|
-
|
|
22
|
-
默认写入:
|
|
23
|
-
|
|
24
|
-
```text
|
|
25
|
-
~/.codex/config.toml
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
也可在项目内配置:
|
|
29
|
-
|
|
30
|
-
```text
|
|
31
|
-
<repo>/.codex/config.toml
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
注意:项目级配置仅在“受信任项目”中生效。
|
|
35
|
-
|
|
36
|
-
## 使用 CLI 配置 MCP
|
|
37
|
-
|
|
38
|
-
### 添加服务器
|
|
39
|
-
|
|
40
|
-
```bash
|
|
41
|
-
codex mcp add <server-name> -- <stdio-command>
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
示例(Context7):
|
|
45
|
-
|
|
46
|
-
```bash
|
|
47
|
-
codex mcp add context7 -- npx -y @upstash/context7-mcp
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
### 查看帮助与状态
|
|
51
|
-
|
|
52
|
-
```bash
|
|
53
|
-
codex mcp --help
|
|
54
|
-
codex mcp list
|
|
55
|
-
codex mcp get <server-name>
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
在 Codex TUI 中,可用 `/mcp` 查看当前会话可用服务器。
|
|
59
|
-
|
|
60
|
-
## 通过 `config.toml` 手动配置
|
|
61
|
-
|
|
62
|
-
### STDIO 示例
|
|
63
|
-
|
|
64
|
-
```toml
|
|
65
|
-
[mcp_servers.context7]
|
|
66
|
-
command = "npx"
|
|
67
|
-
args = ["-y", "@upstash/context7-mcp"]
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
### HTTP 示例
|
|
71
|
-
|
|
72
|
-
```toml
|
|
73
|
-
[mcp_servers.docs_remote]
|
|
74
|
-
url = "https://example.com/mcp"
|
|
75
|
-
bearer_token_env_var = "DOCS_TOKEN"
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
常见可选字段:
|
|
79
|
-
|
|
80
|
-
- `enabled`:是否启用
|
|
81
|
-
- `required`:启动失败时是否阻断会话
|
|
82
|
-
- `env` / `env_vars`:注入环境变量
|
|
83
|
-
- `http_headers` / `env_http_headers`:HTTP 头
|
|
84
|
-
- `startup_timeout_sec`:启动超时
|
|
85
|
-
- `tool_timeout_sec`:工具调用超时
|
|
86
|
-
- `enabled_tools` / `disabled_tools`:工具白名单/黑名单
|
|
87
|
-
|
|
88
|
-
## OAuth 登录(按需)
|
|
89
|
-
|
|
90
|
-
若远程 MCP 支持 OAuth,可执行:
|
|
91
|
-
|
|
92
|
-
```bash
|
|
93
|
-
codex mcp login <server-name>
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
## 常见 MCP 场景
|
|
97
|
-
|
|
98
|
-
- 文档检索:接入官方 API/SDK 文档
|
|
99
|
-
- 浏览器自动化:页面检查、交互、抓取
|
|
100
|
-
- 设计协作:Figma 等上下文接入
|
|
101
|
-
- 内部平台:接入公司内部服务与知识库
|
|
102
|
-
|
|
103
|
-
## 安全建议
|
|
104
|
-
|
|
105
|
-
- 默认最小权限:只配置必要服务器和必要工具。
|
|
106
|
-
- Token 使用环境变量注入,不写死在仓库。
|
|
107
|
-
- 对高风险服务器设置 `required = false`,避免启动失败阻断主流程。
|