sdd-full 4.2.0 → 4.3.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.
Files changed (127) hide show
  1. package/bin.js +31 -63
  2. package/package.json +1 -1
  3. package/skills/README.md +97 -0
  4. package/skills/call-adaptation/SKILL.md +23 -0
  5. package/skills/call-adaptation/call-adaptation-guide.md +136 -0
  6. package/skills/call-adaptation/claude-code-call-spec.md +50 -0
  7. package/skills/call-adaptation/trae-call-spec.md +56 -0
  8. package/skills/checklist.md +154 -0
  9. package/skills/design-planning/ai-coding-rules/SKILL.md +52 -0
  10. package/skills/design-planning/design-to-code/SKILL.md +53 -0
  11. package/skills/design-planning/enterprise-spec/SKILL.md +52 -3
  12. package/skills/design-planning/flutter-av/SKILL.md +44 -34
  13. package/skills/design-planning/flutter-map/SKILL.md +41 -31
  14. package/skills/design-planning/function-sdd/SKILL.md +54 -0
  15. package/skills/design-planning/sdd-code/SKILL.md +347 -0
  16. package/skills/design-planning/sdd-deploy/SKILL.md +501 -0
  17. package/skills/design-planning/sdd-ops/SKILL.md +306 -0
  18. package/skills/design-planning/sdd-test/SKILL.md +383 -0
  19. package/skills/design-planning/ui-sdd/SKILL.md +291 -0
  20. package/skills/design-planning/ui-sdd-specialized/SKILL.md +46 -40
  21. package/skills/design-planning/writing-plans/SKILL.md +144 -0
  22. package/skills/development-execution/flutter-errors/SKILL.md +44 -34
  23. package/skills/development-execution/sdd-add/SKILL.md +540 -0
  24. package/skills/development-execution/systematic-debugging/SKILL.md +298 -0
  25. package/skills/development-execution/test-driven-development/SKILL.md +373 -0
  26. package/skills/development-execution/verification-before-completion/SKILL.md +141 -0
  27. package/skills/knowledge-precipitation/claudeception/SKILL.md +96 -0
  28. package/skills/knowledge-precipitation/mempalace-auto-saver/SKILL.md +302 -0
  29. package/skills/quality-assurance/bdd-acceptance/SKILL.md +44 -37
  30. package/skills/quality-assurance/flutter-test/SKILL.md +56 -0
  31. package/skills/quality-assurance/quality-gate/SKILL.md +350 -0
  32. package/skills/quality-assurance/security-audit/SKILL.md +386 -0
  33. package/skills/release-ops/finishing-a-development-branch/SKILL.md +202 -0
  34. package/skills/release-ops/release-flow/SKILL.md +404 -0
  35. package/skills/requirement-analysis/brainstorming/SKILL.md +166 -0
  36. package/skills/requirement-analysis/competitive-brief/SKILL.md +121 -0
  37. package/skills/requirement-analysis/market-research/SKILL.md +143 -0
  38. package/skills/requirement-analysis/prd-write/SKILL.md +111 -0
  39. package/skills/requirement-analysis/requirement-completion-officer/SKILL.md +124 -0
  40. package/skills/requirement-analysis/sdd/SKILL.md +1044 -0
  41. package/skills/requirement-analysis/sdd-full/SKILL.md +717 -36
  42. package/skills/requirement-analysis/unified-flow/SKILL.md +128 -26
  43. package/skills/rules/project_rules.md +167 -0
  44. package/skills/rules/user_rules.md +254 -69
  45. package/skills/special-tools/env-check/SKILL.md +40 -34
  46. package/skills/special-tools/receiving-code-review/SKILL.md +215 -0
  47. package/skills/special-tools/requesting-code-review/SKILL.md +107 -0
  48. package/skills/special-tools/using-superpowers/SKILL.md +117 -0
  49. package/skills/templates/API-SDD.md +31 -0
  50. package/skills/templates/Andrej Karpathy AI/347/274/226/347/240/201/350/247/204/345/210/231/350/220/275/345/234/260SDD.md" +117 -0
  51. package/skills/templates/BDD/351/243/216/346/240/274/351/252/214/346/224/266/346/240/207/345/207/206SDD.md +147 -0
  52. package/skills/templates/Base-SDD.md +38 -0
  53. package/skills/templates/Brain-SDD.md +36 -0
  54. package/skills/templates/Code-SDD.md +41 -0
  55. package/skills/templates/Competitor-SDD.md +34 -0
  56. package/skills/templates/Env-SDD.md +37 -0
  57. package/skills/templates/Flutter/345/205/250/347/261/273/345/236/213/346/265/213/350/257/225/347/255/226/347/225/245SDD.md +162 -0
  58. package/skills/templates/Flutter/345/234/260/345/233/276/345/257/274/350/210/252/344/270/232/345/212/241SDD.md +136 -0
  59. package/skills/templates/Flutter/345/270/270/350/247/201/345/274/202/345/270/270/344/270/223/351/241/271SDD.md +159 -0
  60. package/skills/templates/Flutter/351/237/263/350/247/206/351/242/221/345/205/250/346/240/210SDD.md +121 -0
  61. package/skills/templates/PRD-SDD.md +45 -0
  62. package/skills/templates/SKILL.md +91 -0
  63. package/skills/templates/Test-SDD.md +34 -0
  64. package/skills/templates/UI-SDD.md +38 -0
  65. package/skills/templates/UI-SDD/344/270/223/347/224/250/346/250/241/346/235/277.md +141 -0
  66. package/skills/templates/UI/350/265/204/346/272/220/346/217/220/347/244/272/350/257/215/347/224/237/346/210/220SDD.md +67 -0
  67. package/skills/templates//344/274/201/344/270/232/347/272/247/345/205/250/346/240/210/345/267/245/347/250/213/350/247/204/350/214/203SDD.md +152 -0
  68. package/skills/templates//345/205/250/346/265/201/347/250/213SDD/350/236/215/345/220/210/344/275/223/347/263/273.md +198 -0
  69. package/skills/templates//345/212/237/350/203/275SDD/344/270/223/347/224/250/346/250/241/346/235/277.md +132 -0
  70. package/skills/templates//347/216/257/345/242/203/351/242/204/346/243/200/346/240/207/345/207/206/345/214/226SDD.md +153 -0
  71. package/skills/templates//351/253/230/344/277/235/347/234/237/350/256/276/350/256/241/350/275/254/344/273/243/347/240/201SDD.md +119 -0
  72. package/skills//345/256/214/346/225/264/345/274/200/345/217/221/346/265/201/347/250/213/346/211/213/345/206/214.md +408 -0
  73. package/skills//346/212/200/350/203/275/344/275/223/347/263/273/345/256/214/345/226/204/345/273/272/350/256/256.md +305 -0
  74. package/skills//346/212/200/350/203/275/344/275/277/347/224/250/346/214/207/345/215/227.md +285 -0
  75. package/skills//346/212/200/350/203/275/345/206/263/347/255/226/346/240/221.md +320 -0
  76. package/skills/brainstorming/SKILL.md +0 -164
  77. package/skills/brainstorming/scripts/frame-template.html +0 -214
  78. package/skills/brainstorming/scripts/helper.js +0 -88
  79. package/skills/brainstorming/scripts/server.cjs +0 -338
  80. package/skills/brainstorming/scripts/start-server.sh +0 -153
  81. package/skills/brainstorming/scripts/stop-server.sh +0 -55
  82. package/skills/brainstorming/spec-document-reviewer-prompt.md +0 -48
  83. package/skills/brainstorming/visual-companion.md +0 -286
  84. package/skills/chinese-code-review/SKILL.md +0 -277
  85. package/skills/chinese-commit-conventions/SKILL.md +0 -364
  86. package/skills/chinese-documentation/SKILL.md +0 -448
  87. package/skills/chinese-git-workflow/SKILL.md +0 -510
  88. package/skills/dispatching-parallel-agents/SKILL.md +0 -182
  89. package/skills/executing-plans/SKILL.md +0 -175
  90. package/skills/finishing-a-development-branch/SKILL.md +0 -200
  91. package/skills/mcp-builder/SKILL.md +0 -255
  92. package/skills/receiving-code-review/SKILL.md +0 -213
  93. package/skills/requesting-code-review/SKILL.md +0 -105
  94. package/skills/requesting-code-review/code-reviewer.md +0 -146
  95. package/skills/rules/skill-map.md +0 -97
  96. package/skills/subagent-driven-development/SKILL.md +0 -277
  97. package/skills/subagent-driven-development/code-quality-reviewer-prompt.md +0 -26
  98. package/skills/subagent-driven-development/implementer-prompt.md +0 -113
  99. package/skills/subagent-driven-development/spec-reviewer-prompt.md +0 -61
  100. package/skills/systematic-debugging/CREATION-LOG.md +0 -119
  101. package/skills/systematic-debugging/SKILL.md +0 -296
  102. package/skills/systematic-debugging/condition-based-waiting-example.ts +0 -158
  103. package/skills/systematic-debugging/condition-based-waiting.md +0 -115
  104. package/skills/systematic-debugging/defense-in-depth.md +0 -122
  105. package/skills/systematic-debugging/find-polluter.sh +0 -63
  106. package/skills/systematic-debugging/root-cause-tracing.md +0 -169
  107. package/skills/systematic-debugging/test-academic.md +0 -14
  108. package/skills/systematic-debugging/test-pressure-1.md +0 -58
  109. package/skills/systematic-debugging/test-pressure-2.md +0 -68
  110. package/skills/systematic-debugging/test-pressure-3.md +0 -69
  111. package/skills/test-driven-development/SKILL.md +0 -371
  112. package/skills/test-driven-development/testing-anti-patterns.md +0 -299
  113. package/skills/using-git-worktrees/SKILL.md +0 -218
  114. package/skills/using-superpowers/SKILL.md +0 -134
  115. package/skills/using-superpowers/references/codex-tools.md +0 -25
  116. package/skills/using-superpowers/references/gemini-tools.md +0 -33
  117. package/skills/verification-before-completion/SKILL.md +0 -139
  118. package/skills/workflow-runner/SKILL.md +0 -172
  119. package/skills/writing-plans/SKILL.md +0 -152
  120. package/skills/writing-plans/plan-document-reviewer-prompt.md +0 -49
  121. package/skills/writing-skills/SKILL.md +0 -654
  122. package/skills/writing-skills/anthropic-best-practices.md +0 -1149
  123. package/skills/writing-skills/examples/CLAUDE_MD_TESTING.md +0 -189
  124. package/skills/writing-skills/graphviz-conventions.dot +0 -172
  125. package/skills/writing-skills/persuasion-principles.md +0 -187
  126. package/skills/writing-skills/render-graphs.js +0 -168
  127. package/skills/writing-skills/testing-skills-with-subagents.md +0 -384
@@ -1,175 +0,0 @@
1
- ---
2
- name: executing-plans
3
- description: 当你有一份书面实现计划需要在单独的会话中执行,并设有审查检查点时使用
4
- ---
5
-
6
- # 执行计划
7
-
8
- ## 概述
9
-
10
- 加载计划,批判性审查,执行所有任务,完成后报告。
11
-
12
- **开始时宣布:** "我正在使用 executing-plans 技能来实现此计划。"
13
-
14
- **注意:** 告诉你的人类伙伴,Superpowers 在有子代理支持时效果好得多。如果在支持子代理的平台上运行(如 Claude Code 或 Codex),其工作质量会显著提高。如果子代理可用,请使用 superpowers:subagent-driven-development 而非此技能。
15
-
16
- ## 流程
17
-
18
- ### 步骤 1:加载并审查计划
19
-
20
- 1. 读取计划文件
21
- 2. 批判性审查——识别计划中的任何问题或疑虑
22
- 3. 如果有疑虑:在开始之前向你的人类伙伴提出
23
- 4. 如果没有疑虑:创建 TodoWrite 并继续
24
-
25
- **审查时重点检查:**
26
- - 步骤之间是否有依赖遗漏?(A 依赖 B,但 B 排在 A 之后)
27
- - 验证条件是否明确?("确认可用"不算,"运行 `npm test` 全部通过"才算)
28
- - 是否有隐含的环境假设?(Node 版本、数据库连接、API Key)
29
-
30
- **审查示例:**
31
- ```
32
- 计划文件:docs/plan.md
33
- 任务清单:5 个任务
34
-
35
- 审查发现:
36
- - 任务 3(添加数据库迁移)应在任务 2(编写数据模型)之后,顺序正确 ✓
37
- - 任务 4 的验证条件写的是"确认功能正常"→ 需澄清:具体跑什么测试?
38
- - 计划未提及 Python 版本要求 → 需确认
39
-
40
- 向伙伴提出:
41
- "计划整体可执行。有两个问题:(1) 任务 4 的验证条件不够具体,建议改为
42
- '运行 pytest tests/test_api.py 全部通过';(2) 需要确认 Python 版本要求。"
43
- ```
44
-
45
- ### 步骤 2:执行任务
46
-
47
- 对于每个任务:
48
-
49
- 1. **标记为进行中** — 更新 TodoWrite
50
- 2. **理解目标** — 重读任务描述,明确完成标准
51
- 3. **执行实现** — 严格按照计划步骤执行(计划已有小步骤)
52
- 4. **运行验证** — 按要求运行测试或检查
53
- 5. **提交变更** — 每完成一个任务提交一次,commit message 引用任务编号
54
- 6. **标记为已完成** — 更新 TodoWrite
55
-
56
- **每个任务的节奏:**
57
- ```
58
- --- 任务 2/5:添加用户验证 ---
59
- [标记进行中]
60
-
61
- 目标:为 /api/users 添加输入验证
62
- 完成标准:所有验证测试通过,无效输入返回 400
63
-
64
- [实现]
65
- - 添加 validateUser() 中间件
66
- - 编写 3 个验证规则(email 格式、密码强度、用户名长度)
67
-
68
- [验证]
69
- $ npm test -- --grep "validation"
70
- ✓ 拒绝无效 email (12ms)
71
- ✓ 拒绝弱密码 (8ms)
72
- ✓ 拒绝过长用户名 (5ms)
73
- 3 passing
74
-
75
- [提交]
76
- $ git add src/middleware/validate.js tests/validation.test.js
77
- $ git commit -m "feat: 添加用户输入验证(任务 2/5)"
78
-
79
- [标记完成]
80
- --- 任务 2/5 完成 ---
81
- ```
82
-
83
- **批量审查检查点:**
84
- - 每完成 3 个任务后,暂停回顾:整体方向还对吗?有没有偏离计划?
85
- - 如果发现前面的实现有问题,先修复再继续,不要带着问题往下走
86
-
87
- ### 步骤 3:处理常见异常
88
-
89
- **测试失败:**
90
- 1. 读错误信息,定位失败原因
91
- 2. 区分:是实现 bug?还是测试本身有问题?还是计划描述有误?
92
- 3. 实现 bug → 修复并重跑
93
- 4. 测试有问题 → 修复测试,向伙伴说明
94
- 5. 计划有误 → 停下来,向伙伴报告并建议修正
95
-
96
- **依赖缺失:**
97
- ```
98
- 任务 3 需要 Redis 连接,但计划中没有提及 Redis 配置。
99
- → 停止执行
100
- → 向伙伴报告:"任务 3 需要 Redis,计划中未包含配置步骤。
101
- 建议:在任务 3 前插入 '配置 Redis 连接' 步骤。"
102
- ```
103
-
104
- **指令不清:**
105
- - 不要猜测意图,不要"合理推断"
106
- - 列出你的理解和困惑,让伙伴澄清
107
- - 等待回复后再继续
108
-
109
- ### 步骤 4:完成开发
110
-
111
- 所有任务完成并验证后:
112
- - 宣布:"我正在使用 finishing-a-development-branch 技能来完成此工作。"
113
- - **必需子技能:** 使用 superpowers:finishing-a-development-branch
114
- - 按照该技能的指引验证测试、展示选项、执行选择
115
-
116
- **完成报告模板:**
117
- ```
118
- ## 执行报告
119
-
120
- **计划:** docs/plan.md
121
- **分支:** feature/user-validation
122
- **任务:** 5/5 已完成
123
-
124
- ### 完成的任务
125
- 1. ✅ 初始化项目结构
126
- 2. ✅ 添加用户验证
127
- 3. ✅ 添加数据库迁移
128
- 4. ✅ 实现 API 端点
129
- 5. ✅ 添加集成测试
130
-
131
- ### 验证结果
132
- - 单元测试:23/23 通过
133
- - 集成测试:8/8 通过
134
- - lint 检查:0 个警告
135
-
136
- ### 偏离计划的地方
137
- - 任务 3:Redis 配置从 env 改为 config.yaml(经伙伴同意)
138
-
139
- ### 下一步
140
- 按 finishing-a-development-branch 技能处理合并/PR
141
- ```
142
-
143
- ## 何时停下来求助
144
-
145
- **在以下情况立即停止执行:**
146
- - 遇到阻塞(缺少依赖、测试失败、指令不清)
147
- - 计划有严重缺陷导致无法开始
148
- - 你不理解某条指令
149
- - 验证反复失败(同一测试失败 2 次以上)
150
-
151
- **不确定时就问,不要猜测。**
152
-
153
- ## 何时回到之前的步骤
154
-
155
- **回到审查(步骤 1)当:**
156
- - 伙伴根据你的反馈更新了计划
157
- - 根本性的方案需要重新考虑
158
-
159
- **不要硬闯阻塞** — 停下来问。
160
-
161
- ## 注意事项
162
- - 先批判性审查计划
163
- - 严格按照计划步骤执行
164
- - 不要跳过验证
165
- - 每个任务单独提交,commit message 引用任务编号
166
- - 计划要求时引用相应技能
167
- - 遇到阻塞时停下来,不要猜测
168
- - 未经用户明确同意,绝不在 main/master 分支上开始实现
169
-
170
- ## 集成
171
-
172
- **必需的工作流技能:**
173
- - **superpowers:using-git-worktrees** - 必需:开始前建立隔离的工作空间
174
- - **superpowers:writing-plans** - 创建此技能要执行的计划
175
- - **superpowers:finishing-a-development-branch** - 所有任务完成后收尾开发
@@ -1,200 +0,0 @@
1
- ---
2
- name: finishing-a-development-branch
3
- description: 当实现完成、所有测试通过、需要决定如何集成工作时使用——通过提供合并、PR 或清理等结构化选项来引导开发工作的收尾
4
- ---
5
-
6
- # 完成开发分支
7
-
8
- ## 概述
9
-
10
- 通过提供清晰的选项并执行所选工作流来引导开发工作的收尾。
11
-
12
- **核心原则:** 验证测试 → 展示选项 → 执行选择 → 清理。
13
-
14
- **开始时宣布:** "我正在使用 finishing-a-development-branch 技能来完成这项工作。"
15
-
16
- ## 流程
17
-
18
- ### 步骤 1:验证测试
19
-
20
- **在展示选项之前,验证测试通过:**
21
-
22
- ```bash
23
- # 运行项目的测试套件
24
- npm test / cargo test / pytest / go test ./...
25
- ```
26
-
27
- **如果测试失败:**
28
- ```
29
- 测试失败(<N> 个失败)。必须先修复才能继续:
30
-
31
- [显示失败信息]
32
-
33
- 在测试通过之前无法进行合并/PR。
34
- ```
35
-
36
- 停止。不要继续到步骤 2。
37
-
38
- **如果测试通过:** 继续步骤 2。
39
-
40
- ### 步骤 2:确定基础分支
41
-
42
- ```bash
43
- # 尝试常见的基础分支
44
- git merge-base HEAD main 2>/dev/null || git merge-base HEAD master 2>/dev/null
45
- ```
46
-
47
- 或者询问:"这个分支是从 main 分出来的——对吗?"
48
-
49
- ### 步骤 3:展示选项
50
-
51
- 展示以下 4 个选项:
52
-
53
- ```
54
- 实现已完成。你想怎么做?
55
-
56
- 1. 在本地合并回 <base-branch>
57
- 2. 推送并创建 Pull Request
58
- 3. 保持分支现状(我稍后处理)
59
- 4. 丢弃这项工作
60
-
61
- 选哪个?
62
- ```
63
-
64
- **不要添加解释** - 保持选项简洁。
65
-
66
- ### 步骤 4:执行选择
67
-
68
- #### 选项 1:本地合并
69
-
70
- ```bash
71
- # 切换到基础分支
72
- git checkout <base-branch>
73
-
74
- # 拉取最新代码
75
- git pull
76
-
77
- # 合并功能分支
78
- git merge <feature-branch>
79
-
80
- # 在合并结果上验证测试
81
- <test command>
82
-
83
- # 如果测试通过
84
- git branch -d <feature-branch>
85
- ```
86
-
87
- 然后:清理工作树(步骤 5)
88
-
89
- #### 选项 2:推送并创建 PR
90
-
91
- ```bash
92
- # 推送分支
93
- git push -u origin <feature-branch>
94
-
95
- # 创建 PR
96
- gh pr create --title "<title>" --body "$(cat <<'EOF'
97
- ## 摘要
98
- <2-3 条变更要点>
99
-
100
- ## 测试计划
101
- - [ ] <验证步骤>
102
- EOF
103
- )"
104
- ```
105
-
106
- 然后:清理工作树(步骤 5)
107
-
108
- #### 选项 3:保持现状
109
-
110
- 报告:"保留分支 <name>。工作树保留在 <path>。"
111
-
112
- **不要清理工作树。**
113
-
114
- #### 选项 4:丢弃
115
-
116
- **先确认:**
117
- ```
118
- 这将永久删除:
119
- - 分支 <name>
120
- - 所有提交:<commit-list>
121
- - 工作树 <path>
122
-
123
- 输入 'discard' 确认。
124
- ```
125
-
126
- 等待精确的确认。
127
-
128
- 确认后:
129
- ```bash
130
- git checkout <base-branch>
131
- git branch -D <feature-branch>
132
- ```
133
-
134
- 然后:清理工作树(步骤 5)
135
-
136
- ### 步骤 5:清理工作树
137
-
138
- **对于选项 1、2、4:**
139
-
140
- 检查是否在工作树中:
141
- ```bash
142
- git worktree list | grep $(git branch --show-current)
143
- ```
144
-
145
- 如果是:
146
- ```bash
147
- git worktree remove <worktree-path>
148
- ```
149
-
150
- **对于选项 3:** 保留工作树。
151
-
152
- ## 快速参考
153
-
154
- | 选项 | 合并 | 推送 | 保留工作树 | 清理分支 |
155
- |------|------|------|-----------|---------|
156
- | 1. 本地合并 | ✓ | - | - | ✓ |
157
- | 2. 创建 PR | - | ✓ | ✓ | - |
158
- | 3. 保持现状 | - | - | ✓ | - |
159
- | 4. 丢弃 | - | - | - | ✓(强制) |
160
-
161
- ## 常见错误
162
-
163
- **跳过测试验证**
164
- - **问题:** 合并损坏的代码、创建失败的 PR
165
- - **修复:** 在提供选项前始终验证测试
166
-
167
- **开放式问题**
168
- - **问题:** "接下来该做什么?" → 含糊不清
169
- - **修复:** 准确展示 4 个结构化选项
170
-
171
- **自动清理工作树**
172
- - **问题:** 在可能还需要工作树时就删除了(选项 2、3)
173
- - **修复:** 只在选项 1 和 4 时清理
174
-
175
- **丢弃时不确认**
176
- - **问题:** 意外删除工作成果
177
- - **修复:** 要求输入 "discard" 确认
178
-
179
- ## 红线
180
-
181
- **绝不:**
182
- - 在测试失败时继续
183
- - 合并前不验证测试结果
184
- - 不确认就删除工作成果
185
- - 未经明确请求就强制推送
186
-
187
- **始终:**
188
- - 在提供选项前验证测试
189
- - 准确展示 4 个选项
190
- - 选项 4 要求输入确认
191
- - 只在选项 1 和 4 时清理工作树
192
-
193
- ## 集成
194
-
195
- **被以下技能调用:**
196
- - **subagent-driven-development**(步骤 7)- 所有任务完成后
197
- - **executing-plans**(步骤 5)- 所有批次完成后
198
-
199
- **配合使用:**
200
- - **using-git-worktrees** - 清理由该技能创建的工作树
@@ -1,255 +0,0 @@
1
- ---
2
- name: mcp-builder
3
- description: MCP 服务器构建方法论 — 系统化构建生产级 MCP 工具,让 AI 助手连接外部能力
4
- ---
5
-
6
- # MCP 服务器构建
7
-
8
- 系统化设计、实现、测试和部署 Model Context Protocol 服务器的方法论。
9
-
10
- ## 1. 协议核心概念
11
-
12
- MCP 定义三种原语:
13
-
14
- - **Tools(工具)**:AI 助手主动调用的函数,有副作用。如搜索、创建、删除操作。
15
- - **Resources(资源)**:AI 助手只读访问的数据源,用 URI 标识。如 `users://{id}/profile`。
16
- - **Prompts(提示词模板)**:预定义交互模板,引导用户触发工作流。
17
-
18
- **选择原则:** 执行操作 → Tool | 读取数据 → Resource | 引导交互 → Prompt
19
-
20
- ## 2. 项目结构规范
21
-
22
- ### TypeScript
23
- ```
24
- my-mcp-server/
25
- ├── src/
26
- │ ├── index.ts # 入口,注册 tools/resources
27
- │ ├── tools/ # 按功能拆分
28
- │ ├── resources/
29
- │ └── lib/ # 客户端封装、校验逻辑
30
- ├── tests/
31
- ├── package.json
32
- └── tsconfig.json
33
- ```
34
-
35
- 关键依赖:`@modelcontextprotocol/sdk` + `zod`
36
-
37
- ### Python
38
- ```
39
- my-mcp-server/
40
- ├── src/my_mcp_server/
41
- │ ├── server.py
42
- │ ├── tools/
43
- │ └── lib/
44
- ├── tests/
45
- └── pyproject.toml
46
- ```
47
-
48
- 关键依赖:`mcp` + `pydantic`
49
-
50
- ## 3. Tool 设计原则
51
-
52
- ### 命名
53
- - `snake_case` 格式,动词开头:`search_users`、`create_issue`、`delete_file`
54
- - 名称自解释,AI 助手靠名称选工具,模糊命名导致误调用
55
-
56
- ### 参数
57
- - 每个参数有类型约束和 `.describe()` 描述
58
- - 可选参数给默认值,减少 AI 决策负担
59
- - 用枚举代替布尔开关
60
-
61
- ```typescript
62
- server.tool("search_issues", {
63
- query: z.string().describe("搜索关键词"),
64
- status: z.enum(["open", "closed", "all"]).default("open").describe("状态筛选"),
65
- limit: z.number().min(1).max(100).default(20).describe("返回上限"),
66
- }, async ({ query, status, limit }) => { /* ... */ });
67
- ```
68
-
69
- ### 描述
70
- 说明**用途 + 返回内容 + 限制**,这是 AI 选择工具的关键依据:
71
-
72
- ```typescript
73
- server.tool("search_users",
74
- "根据姓名或邮箱搜索用户。返回 ID、姓名、邮箱列表。模糊匹配,最多 50 条。",
75
- schema, handler);
76
- ```
77
-
78
- ### 输出
79
- - 结构化数据 → JSON,人类可读内容 → Markdown
80
- - 始终用 `content: [{ type: "text", text: "..." }]` 格式返回
81
-
82
- ## 4. 输入验证和错误处理
83
-
84
- 用 Zod/Pydantic 做 Schema 级校验,业务级校验放 handler 开头:
85
-
86
- ```typescript
87
- server.tool("get_user", { id: z.string() }, async ({ id }) => {
88
- try {
89
- const user = await db.getUser(id);
90
- if (!user) {
91
- return {
92
- content: [{ type: "text", text: `用户 ${id} 不存在,请检查 ID。` }],
93
- isError: true,
94
- };
95
- }
96
- return { content: [{ type: "text", text: JSON.stringify(user, null, 2) }] };
97
- } catch (err) {
98
- return {
99
- content: [{ type: "text", text: `查询失败:${err.message}` }],
100
- isError: true,
101
- };
102
- }
103
- });
104
- ```
105
-
106
- **错误处理四原则:**
107
- 1. 永远不让服务器崩溃 — try/catch 包裹所有外部调用
108
- 2. 返回可操作的错误信息 — 告诉 AI 问题是什么、能做什么
109
- 3. 使用 `isError: true` — 让 AI 知道调用失败
110
- 4. 区分错误类型 — 参数错误、权限不足、资源不存在、服务不可用
111
-
112
- ## 5. 资源管理和生命周期
113
-
114
- ```typescript
115
- // 资源注册
116
- server.resource("user-profile", "users://{userId}/profile", async (uri) => {
117
- const profile = await db.getProfile(extractId(uri));
118
- return { contents: [{ uri: uri.href, mimeType: "application/json", text: JSON.stringify(profile) }] };
119
- });
120
-
121
- // 生命周期:先初始化 → 再 connect → 监听关闭信号
122
- const db = await Database.connect(config.dbUrl);
123
- await server.connect(new StdioServerTransport());
124
- process.on("SIGINT", async () => { await db.disconnect(); await server.close(); process.exit(0); });
125
- ```
126
-
127
- 关键点:使用连接池、所有外部调用设超时、优雅关闭清理资源。
128
-
129
- ## 6. 测试策略
130
-
131
- ### 单元测试 — 业务逻辑与 MCP 注册分离
132
- ```typescript
133
- // tools/search.ts 导出纯函数
134
- export async function searchUsers(query: string, limit: number) { /* ... */ }
135
-
136
- // search.test.ts 独立测试
137
- test("返回匹配结果", async () => {
138
- const results = await searchUsers("alice", 10);
139
- expect(results[0].name).toContain("Alice");
140
- });
141
- ```
142
-
143
- ### 集成测试 — 用 SDK Client 做端到端验证
144
- ```typescript
145
- const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair();
146
- await server.connect(serverTransport);
147
- const client = new Client({ name: "test", version: "1.0.0" });
148
- await client.connect(clientTransport);
149
- const result = await client.callTool("search_users", { query: "test" });
150
- expect(result.isError).toBeFalsy();
151
- ```
152
-
153
- ### MCP Inspector — 交互式调试
154
- ```bash
155
- npx @modelcontextprotocol/inspector node dist/index.js
156
- ```
157
-
158
- 在浏览器中查看所有 tools/resources,手动调用并查看结果。
159
-
160
- **测试要点:** 每个 Tool 覆盖正常 + 异常路径、边界值、外部服务失败模拟。
161
-
162
- ## 7. 安全考虑
163
-
164
- **权限控制:**
165
- - 最小权限原则,读写 Tool 分离
166
- - 危险操作要求确认参数(如 `confirm: true`)
167
-
168
- **输入安全:**
169
- - SQL 注入 → 参数化查询,绝不拼接
170
- - 路径遍历 → 校验路径,禁止 `../`
171
- - 命令注入 → 用 `execFile` 而非 `exec`
172
-
173
- **敏感数据:**
174
- - 密钥通过环境变量传入,不硬编码
175
- - 日志不打印完整敏感信息
176
- - 返回数据做脱敏处理
177
-
178
- **沙箱:** 文件操作限制目录、网络请求限制白名单、设置资源配额。
179
-
180
- ## 8. 部署和分发
181
-
182
- ### npm 发布
183
- ```json
184
- { "bin": { "mcp-server-myservice": "dist/index.js" }, "files": ["dist"] }
185
- ```
186
-
187
- 用户配置:
188
- ```json
189
- { "mcpServers": { "myservice": { "command": "npx", "args": ["@yourorg/mcp-server-myservice"], "env": { "API_KEY": "xxx" } } } }
190
- ```
191
-
192
- ### pip 发布
193
- ```toml
194
- [project.scripts]
195
- mcp-server-myservice = "my_mcp_server.server:main"
196
- ```
197
-
198
- ### Docker — 适用于复杂依赖或隔离场景
199
- ```dockerfile
200
- FROM node:20-slim
201
- WORKDIR /app
202
- COPY package*.json ./ && RUN npm ci --production
203
- COPY dist ./dist
204
- ENTRYPOINT ["node", "dist/index.js"]
205
- ```
206
-
207
- ## 9. 调试技巧
208
-
209
- **关键:MCP 用 stdio 通信,不能用 `console.log`,会破坏协议流。**
210
-
211
- ```typescript
212
- // 错误
213
- console.log("debug");
214
- // 正确
215
- console.error("[DEBUG]", info);
216
- // 更好
217
- server.sendLoggingMessage({ level: "info", data: "处理中" });
218
- ```
219
-
220
- **常见问题:**
221
-
222
- | 症状 | 原因 | 解决 |
223
- |------|------|------|
224
- | 启动无响应 | transport 未连接 | 检查 `server.connect()` |
225
- | Tool 不出现 | 注册在 connect 之后 | 先注册再 connect |
226
- | AI 不调用 Tool | 描述不清晰 | 改善名称和描述 |
227
- | 参数总错 | Schema 不明确 | 添加 `.describe()` |
228
- | 调用超时 | 外部服务慢 | 加超时和缓存 |
229
-
230
- **调试流程:** Inspector 验证基本功能 → 手动调用确认输入输出 → 连接真实 AI 客户端观察调用模式 → 根据实际行为调整设计。
231
-
232
- ## 10. 构建检查清单
233
-
234
- ### 设计
235
- - [ ] 明确 Tools vs Resources vs Prompts 分工
236
- - [ ] Tool 命名 `动词_名词`,描述说明用途和返回内容
237
- - [ ] 参数简洁,可选参数有合理默认值
238
-
239
- ### 实现
240
- - [ ] 输入用 Zod/Pydantic 校验
241
- - [ ] 外部调用有 try/catch 和超时
242
- - [ ] 错误返回 `isError: true` 并附可操作信息
243
- - [ ] 不用 `console.log`(用 stderr 或 SDK 日志)
244
- - [ ] 敏感数据走环境变量
245
-
246
- ### 测试
247
- - [ ] 核心逻辑有单元测试
248
- - [ ] 有集成测试验证 MCP 协议交互
249
- - [ ] 用 MCP Inspector 手动验证过
250
- - [ ] 用真实 AI 客户端测试过
251
-
252
- ### 部署
253
- - [ ] README 含安装和配置说明
254
- - [ ] 提供客户端配置 JSON 示例
255
- - [ ] 遵循 semver,无硬编码密钥