Initial commit
This commit is contained in:
Zhongwei Li
168
codex-mcp/README.md
Normal file
168
codex-mcp/README.md
Normal file
@@ -0,0 +1,168 @@
|
||||
# Codex MCP Skill
|
||||
|
||||
一个通过标准 MCP 工具调用接口，协作 Codex 处理复杂技术任务的 Claude Code 技能。
|
||||
|
||||
## 快速入门
|
||||
|
||||
### 何时使用
|
||||
当您遇到以下场景时，此技能会自动激活：
|
||||
|
||||
| 场景 | 示例触发词 |
|
||||
|------|-----------|
|
||||
| **复杂算法设计** | "设计一个并发数据处理算法..." |
|
||||
| **性能优化** | "优化这个状态机，p99 延迟需要 < 100ms" |
|
||||
| **架构评审** | "分析系统架构，支持 10x 扩展" |
|
||||
| **代码审查** | "审查这段代码的线程安全问题" |
|
||||
|
||||
### 核心触发词
|
||||
- "深度分析"、"复杂逻辑"、"算法设计"
|
||||
- ">10行核心代码"、"状态机"
|
||||
- "架构优化"、"性能瓶颈"
|
||||
|
||||
### 典型示例
|
||||
|
||||
#### 算法设计
|
||||
```markdown
|
||||
我需要设计一个限流算法：
|
||||
- 处理 10K requests/sec
|
||||
- 每用户限制：100 req/min
|
||||
- 全局限制：10K req/sec
|
||||
- 延迟：<1ms 开销
|
||||
当前滑动窗口方案在大规模下太慢。
|
||||
推荐什么算法？
|
||||
```
|
||||
|
||||
#### 架构评审
|
||||
```markdown
|
||||
请评审我们的微服务架构，从 1K 扩展到 10K req/sec：
|
||||
|
||||
当前：API Gateway → 5个服务 → PostgreSQL + Redis
|
||||
|
||||
挑战：
|
||||
- 数据库在 p99 成为瓶颈
|
||||
- 服务紧耦合
|
||||
- 缺乏明确的缓存策略
|
||||
|
||||
建议哪些改进？
|
||||
```
|
||||
|
||||
#### 代码审查
|
||||
```markdown
|
||||
审查这个并发数据处理器，关注：
|
||||
- 线程安全问题
|
||||
- 性能瓶颈
|
||||
- 内存泄漏
|
||||
- 更好的设计模式
|
||||
|
||||
[代码]
|
||||
|
||||
担心热路径中的互斥锁使用。
|
||||
```
|
||||
|
||||
## 使用流程
|
||||
|
||||
### 1. 描述您的任务
|
||||
直接用自然语言描述复杂技术问题，包含：
|
||||
- 问题的背景和上下文
|
||||
- 具体的约束（性能、规模、安全等）
|
||||
- 您已经尝试过的方法
|
||||
|
||||
### 2. 提供必要信息
|
||||
确保包含：
|
||||
- **约束条件**：时间/空间复杂度、性能要求
|
||||
- **测试用例**：边界情况、预期行为
|
||||
- **现有代码**：相关实现（如果有）
|
||||
- **上下文**：使用场景、依赖关系
|
||||
|
||||
### 3. 接收 Codex 分析
|
||||
Claude 会将您的请求格式化并传递给 Codex，Codex 将提供：
|
||||
- 设计文档或伪代码
|
||||
- 实现策略和最佳实践
|
||||
- 测试用例建议
|
||||
- 性能分析和优化建议
|
||||
|
||||
### 4. 验证和实施
|
||||
使用 [REFERENCE.md](REFERENCE.md) 中的集成指南验证建议：
|
||||
- 检查逻辑正确性
|
||||
- 验证性能声明
|
||||
- 测试与现有代码的兼容性
|
||||
|
||||
## 关键特性
|
||||
|
||||
### ✅ MCP 工具调用
|
||||
- **工具名称**：
|
||||
- 开启会话：`mcp__codex-mcp-tool__codex`
|
||||
- 继续对话：`mcp__codex-mcp-tool__codex-reply`
|
||||
- **会话管理**：返回的 `conversationId` 用于后续对话
|
||||
- **灵活配置**：支持模型选择、沙盒模式、审批策略等参数
|
||||
- **详细说明**：查看 [SKILL.md](SKILL.md) 获取完整的工具调用示例
|
||||
|
||||
### ✅ 协作模板
|
||||
内置标准模板：
|
||||
- 标准任务交接
|
||||
- 算法设计请求
|
||||
- 架构评审请求
|
||||
|
||||
### ✅ 最佳实践指导
|
||||
- 完整的上下文准备
|
||||
- 有效的问题提问
|
||||
- 安全的集成策略
|
||||
|
||||
## 文件结构
|
||||
|
||||
```
|
||||
codex-mcp/
|
||||
├── SKILL.md # 主要技能定义
|
||||
├── README.md # 快速入门（本文件）
|
||||
├── REFERENCE.md # 完整参考指南
|
||||
└── HANDOFF_CHECKLIST.md # 交接检查清单
|
||||
```
|
||||
|
||||
## 成功技巧
|
||||
|
||||
### 快速激活
|
||||
使用明确的触发词：
|
||||
- "需要深度分析..."
|
||||
- "设计复杂算法..."
|
||||
- "审查这段代码..."
|
||||
- "架构优化建议..."
|
||||
|
||||
### 提供上下文
|
||||
- ✅ 具体约束（"p99 < 100ms"）
|
||||
- ✅ 现有代码示例
|
||||
- ✅ 测试用例
|
||||
- ❌ 模糊描述（"代码很慢"）
|
||||
|
||||
### 有效提问
|
||||
- 问具体问题，避免"怎么优化？"这类宽泛问题
|
||||
- 提供成功标准（"如何达到 <500ms？"）
|
||||
- 说明优先级（"准确性 > 性能"）
|
||||
|
||||
## 故障排除
|
||||
|
||||
**技能未激活？**
|
||||
- 添加触发词："深度分析"、"算法设计"
|
||||
- 明确规模：">10 行逻辑"、"复杂状态机"
|
||||
- 直接说明："我需要 Codex 的帮助..."
|
||||
|
||||
**响应不适用？**
|
||||
- 检查是否传达了所有约束
|
||||
- 验证上下文假设
|
||||
- 请求替代方案或澄清
|
||||
|
||||
**集成问题？**
|
||||
- 遵循 REFERENCE.md 中的集成指南
|
||||
- 先在隔离环境测试
|
||||
- 准备回滚计划
|
||||
|
||||
## 版本历史
|
||||
|
||||
- **v2.0** (2025-11-05): 精简重构
|
||||
- 大幅减少文档冗余
|
||||
- 明确 MCP 工具调用方法
|
||||
- 优化使用体验
|
||||
- **v1.0** (2025-11-05): 初始发布
|
||||
|
||||
## 许可证
|
||||
|
||||
CCode 技能插件的一部分。
|
||||
Reference in New Issue
Block a user