@guru-ai-product/ai-product-kit 0.2.251113170742 → 0.2.251113181056
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/README.md +4 -5
- package/mcp/skills/init_project/Skills.md +129 -0
- package/{skills/aipk_init_project/template/AGENTS_TEMPLATE_MCP.md → mcp/skills/init_project/template/AGENTS_TEMPLATE.md} +0 -7
- package/mcp/src/server.js +0 -2
- package/package.json +1 -1
- package/skills/aipk_design/GURU_AI.md +1 -1
- package/skills/aipk_development/GURU_AI.md +1 -1
- package/skills/aipk_init_project/GURU_AI.md +4 -4
- package/skills/aipk_init_project/SKILL.md +8 -56
- package/skills/aipk_init_project/skill.ini +1 -0
- package/skills/aipk_operations/GURU_AI.md +1 -1
- package/skills/aipk_requirements/GURU_AI.md +1 -1
- package/skills/aipk_skill_generate/GURU_AI.md +1 -1
- package/skills/aipk_tool_prompts/GURU_AI.md +1 -1
package/README.md
CHANGED
|
@@ -79,10 +79,10 @@ npx -y @guru-ai-product/ai-product-kit@latest ai-product-kit
|
|
|
79
79
|
|
|
80
80
|
This downloads the Skill bundle (templates, scripts, and `GURU_AI.md` files) to `.claude/skills/` in your working tree.
|
|
81
81
|
|
|
82
|
-
#### 2. 🚀 Initialize Your Project
|
|
82
|
+
#### 2. 🚀 Initialize Your Project
|
|
83
83
|
|
|
84
84
|
```text
|
|
85
|
-
Initialize my project
|
|
85
|
+
Initialize my project using the init-project skill.
|
|
86
86
|
```
|
|
87
87
|
|
|
88
88
|
#### 3. 📋 Using Skills
|
|
@@ -166,11 +166,10 @@ The tool returns:
|
|
|
166
166
|
- `description`: Skill description from the SKILL.md file
|
|
167
167
|
- `cache_path`: Absolute path to cached content (for subsequent reading)
|
|
168
168
|
|
|
169
|
-
#### 4. 🚀 Initialize Your Project
|
|
169
|
+
#### 4. 🚀 Initialize Your Project
|
|
170
170
|
|
|
171
171
|
```text
|
|
172
|
-
Initialize my project
|
|
173
|
-
Use the product_kit_skill tool
|
|
172
|
+
Initialize my project using the init-project skill.
|
|
174
173
|
```
|
|
175
174
|
|
|
176
175
|
#### 5. 📚 Supported Skills
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: init-project
|
|
3
|
+
description: Initialize the project Agents playbook, sync the skills inventory into AGENTS.md/templates, and verify the workspace includes a complete AGENTS.md file.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 项目初始化 - MCP 模式
|
|
7
|
+
|
|
8
|
+
## 1. 技能定位
|
|
9
|
+
|
|
10
|
+
- **适用场景**:初始化新项目、检查现有项目的 Agents 配置、更新项目的 Agents 文档
|
|
11
|
+
- **目标人群**:项目管理者、开发团队、文档维护者
|
|
12
|
+
- **价值主张**:确保项目包含完整的 Agents 工作规则,统一项目规范,提高团队协作效率
|
|
13
|
+
|
|
14
|
+
## 2. 快速上手
|
|
15
|
+
|
|
16
|
+
1. 检查项目根目录是否存在 `AGENTS.md` 文件
|
|
17
|
+
2. 验证 `AGENTS.md` 是否符合模板结构 [`AGENTS_TEMPLATE.md`](./AGENTS_TEMPLATE.md)
|
|
18
|
+
3. 如果缺失或不符合规范,使用模板创建或更新相应文档
|
|
19
|
+
|
|
20
|
+
## 3. 标准流程
|
|
21
|
+
|
|
22
|
+
| 阶段 | 说明 |
|
|
23
|
+
| ---- | --- |
|
|
24
|
+
| 检查 | 检查项目根目录是否存在 `AGENTS.md`,如缺失则创建 |
|
|
25
|
+
| 校验 | 对照模板逐节检查文档结构是否完整,必要时重建 |
|
|
26
|
+
|
|
27
|
+
## 4. 文档结构规范
|
|
28
|
+
|
|
29
|
+
项目根目录的 `AGENTS.md` 应严格按照模板创建:[
|
|
30
|
+
`AGENTS_TEMPLATE.md`](./AGENTS_TEMPLATE.md)
|
|
31
|
+
|
|
32
|
+
文档结构如下:
|
|
33
|
+
|
|
34
|
+
1. **Project Overview** - 项目概述,描述项目的核心目标和背景,列出核心功能或特性(**唯一需要根据项目实际情况填写的内容**)
|
|
35
|
+
2. **Conventions** - 惯例说明
|
|
36
|
+
3. **MCP Skill Invocation** - MCP工具调用表
|
|
37
|
+
4. **Agents Workflow Guidelines** - 文档创建与编辑规范
|
|
38
|
+
5. **Agents Prohibited Behaviors** - 禁止事项
|
|
39
|
+
6. **Special Rules** - 特殊规则
|
|
40
|
+
|
|
41
|
+
**重要**:除了 **Project Overview** 部分需要根据项目实际情况填写外,其他所有内容都应严格按照模板内容,不得修改。
|
|
42
|
+
|
|
43
|
+
## 5. AI 协作要点
|
|
44
|
+
|
|
45
|
+
### 5.1 检查脚本
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# 检查根目录是否存在 AGENTS.md
|
|
49
|
+
if [ ! -f "AGENTS.md" ]; then
|
|
50
|
+
echo "缺失 AGENTS.md 文件"
|
|
51
|
+
fi
|
|
52
|
+
|
|
53
|
+
# 检查是否包含模板要求的关键章节
|
|
54
|
+
grep -q "Project Overview" AGENTS.md || echo "缺少 Project Overview"
|
|
55
|
+
grep -q "Agents Workflow Guidelines" AGENTS.md || echo "缺少 Agents Workflow Guidelines"
|
|
56
|
+
grep -q "Agents Prohibited Behaviors" AGENTS.md || echo "缺少 Agents Prohibited Behaviors"
|
|
57
|
+
grep -q "Special Rules" AGENTS.md || echo "缺少 Special Rules"
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### 5.2 文档创建和更新策略
|
|
61
|
+
|
|
62
|
+
1. **如果项目根目录没有 `AGENTS.md`**:
|
|
63
|
+
- 使用模板 [`AGENTS_TEMPLATE.md`](./AGENTS_TEMPLATE.md) 创建
|
|
64
|
+
- 只修改 **Project Overview** 部分,填写项目的实际信息
|
|
65
|
+
- 其他所有内容严格按照模板,不得修改
|
|
66
|
+
|
|
67
|
+
2. **如果项目根目录已有 `AGENTS.md`**:
|
|
68
|
+
- 检查文档结构是否符合模板要求
|
|
69
|
+
- 如果不符合,使用模板重新创建或更新
|
|
70
|
+
- 确保除了 **Project Overview** 外,其他内容与模板一致
|
|
71
|
+
|
|
72
|
+
### 5.3 模板使用规范
|
|
73
|
+
|
|
74
|
+
- **模板文件**:使用 [`AGENTS_TEMPLATE.md`](./AGENTS_TEMPLATE.md)
|
|
75
|
+
- **可修改部分**:仅 **Project Overview** 部分需要根据项目实际情况填写
|
|
76
|
+
- **不可修改部分**:除 Project Overview 外的所有内容都应严格按照模板,不得修改
|
|
77
|
+
- **严格遵循**:确保文档结构与模板完全一致,保持规范统一
|
|
78
|
+
|
|
79
|
+
## 6. 执行步骤
|
|
80
|
+
|
|
81
|
+
### 步骤 1: 检查现有文档
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
# 检查根目录 AGENTS.md
|
|
85
|
+
if [ -f "AGENTS.md" ]; then
|
|
86
|
+
echo "✓ 找到 AGENTS.md"
|
|
87
|
+
else
|
|
88
|
+
echo "✗ 缺失 AGENTS.md"
|
|
89
|
+
fi
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### 步骤 2: 验证文档内容
|
|
93
|
+
|
|
94
|
+
检查 `AGENTS.md` 是否包含以下关键章节:
|
|
95
|
+
|
|
96
|
+
- Project Overview
|
|
97
|
+
- Agents Workflow Guidelines
|
|
98
|
+
- Agents Prohibited Behaviors
|
|
99
|
+
- Special Rules
|
|
100
|
+
|
|
101
|
+
### 步骤 3: 创建或更新文档
|
|
102
|
+
|
|
103
|
+
如果缺失或不符合规范:
|
|
104
|
+
|
|
105
|
+
1. 使用模板 [`AGENTS_TEMPLATE.md`](./AGENTS_TEMPLATE.md)
|
|
106
|
+
2. **仅修改 Project Overview 部分**,填写项目的实际信息
|
|
107
|
+
3. **其他所有内容严格按照模板**,不得修改
|
|
108
|
+
|
|
109
|
+
### 步骤 4: 验证完整性
|
|
110
|
+
|
|
111
|
+
最终 `AGENTS.md` 应包含:
|
|
112
|
+
|
|
113
|
+
- ✅ Project Overview(根据项目实际情况填写)
|
|
114
|
+
- ✅ Agents Workflow Guidelines(严格按照模板)
|
|
115
|
+
- ✅ Agents Prohibited Behaviors(严格按照模板)
|
|
116
|
+
- ✅ Special Rules(严格按照模板)
|
|
117
|
+
- ✅ MCP技能调用表(由脚本自动生成)
|
|
118
|
+
|
|
119
|
+
## 7. 附加资源
|
|
120
|
+
|
|
121
|
+
- [Agents 配置模板](./AGENTS_TEMPLATE.md)
|
|
122
|
+
- [Skill 创建方法](../skill_generate/SKILL.md) - Skill 创建规范
|
|
123
|
+
|
|
124
|
+
## 8. 注意事项
|
|
125
|
+
|
|
126
|
+
- **模板严格遵循**:除 Project Overview 外,所有内容都应严格按照模板,不得修改
|
|
127
|
+
- **Project Overview**:这是唯一需要根据项目实际情况填写的部分
|
|
128
|
+
- **结构一致性**:确保所有项目的 `AGENTS.md` 结构一致,便于维护和理解
|
|
129
|
+
- **文档引用规范**:文档中所有引用必须使用 Markdown 链接形式,例如 `[文件名](./path/to/file.md)` 或 `[目录名](./path/to/directory/)`
|
|
@@ -32,13 +32,6 @@ Use these MCP tools to load a Skill by name. The server maps known Skill names t
|
|
|
32
32
|
<arguments>{"skill_name": "aipk_development"}</arguments>
|
|
33
33
|
</skill>
|
|
34
34
|
|
|
35
|
-
<skill>
|
|
36
|
-
<name>init-project</name>
|
|
37
|
-
<description>Initialize the project Agents playbook, sync the skills inventory into AGENTS.md/templates, and verify the workspace includes a complete AGENTS.md file.</description>
|
|
38
|
-
<tool>product_kit_skill</tool>
|
|
39
|
-
<arguments>{"skill_name": "aipk_init_project"}</arguments>
|
|
40
|
-
</skill>
|
|
41
|
-
|
|
42
35
|
<skill>
|
|
43
36
|
<name>operations</name>
|
|
44
37
|
<description>Canonical entry point for every post-release operating guide; maps scenarios to the available Skills and explains how to invoke them.</description>
|
package/mcp/src/server.js
CHANGED
|
@@ -21,7 +21,6 @@ import { join } from 'path';
|
|
|
21
21
|
const PRODUCT_KIT_SKILLS = {
|
|
22
22
|
"aipk_design": join(PROJECT_ROOT, "skills/aipk_design/SKILL.md"),
|
|
23
23
|
"aipk_development": join(PROJECT_ROOT, "skills/aipk_development/SKILL.md"),
|
|
24
|
-
"aipk_init_project": join(PROJECT_ROOT, "skills/aipk_init_project/SKILL.md"),
|
|
25
24
|
"aipk_operations": join(PROJECT_ROOT, "skills/aipk_operations/SKILL.md"),
|
|
26
25
|
"aipk_requirements": join(PROJECT_ROOT, "skills/aipk_requirements/SKILL.md"),
|
|
27
26
|
"aipk_skill_generate": join(PROJECT_ROOT, "skills/aipk_skill_generate/SKILL.md"),
|
|
@@ -31,7 +30,6 @@ const PRODUCT_KIT_SKILLS = {
|
|
|
31
30
|
const SKILL_DESCRIPTIONS = {
|
|
32
31
|
"aipk_design": "Central hub for automation-ready design workflows, describing how agents split composite boards, prep visual assets, sync requirement docs, and discover the right sub-skill before handling new mocks.",
|
|
33
32
|
"aipk_development": "Development phase index pointing to the single authoritative implementation plan template.",
|
|
34
|
-
"aipk_init_project": "Initialize the project Agents playbook, sync the skills inventory into AGENTS.md/templates, and verify the workspace includes a complete AGENTS.md file.",
|
|
35
33
|
"aipk_operations": "Canonical entry point for every post-release operating guide; maps scenarios to the available Skills and explains how to invoke them.",
|
|
36
34
|
"aipk_requirements": "Central repository for requirement discovery, documentation, review, and change management assets.",
|
|
37
35
|
"aipk_skill_generate": "Standards and methods for creating Agent Skills that extend Claude's capabilities. Use when creating or updating Skills, rules, or documentation that should follow Skill structure.",
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# GURU AI Snapshot
|
|
2
2
|
|
|
3
|
-
Last refreshed: 2025-11-
|
|
3
|
+
Last refreshed: 2025-11-13T10:10:56.892Z
|
|
4
4
|
|
|
5
5
|
| File | Last Modified (UTC) |
|
|
6
6
|
| --- | --- |
|
|
7
7
|
| `scripts/check_agents.sh` | 2025-11-13T09:03:47.702Z |
|
|
8
|
-
| `
|
|
9
|
-
| `
|
|
10
|
-
| `template/AGENTS_TEMPLATE.md` | 2025-11-
|
|
8
|
+
| `skill.ini` | 2025-11-13T09:47:02.793Z |
|
|
9
|
+
| `SKILL.md` | 2025-11-13T10:06:33.764Z |
|
|
10
|
+
| `template/AGENTS_TEMPLATE.md` | 2025-11-13T10:10:56.854Z |
|
|
@@ -14,7 +14,7 @@ description: Initialize the project Agents playbook, sync the skills inventory i
|
|
|
14
14
|
## 2. 快速上手
|
|
15
15
|
|
|
16
16
|
1. 检查项目根目录是否存在 `AGENTS.md` 文件,并确认 `<skills_system>` 区块已经出现
|
|
17
|
-
2. 验证 `AGENTS.md`
|
|
17
|
+
2. 验证 `AGENTS.md` 是否符合模板结构 [`template/AGENTS_TEMPLATE.md`](./template/AGENTS_TEMPLATE.md)
|
|
18
18
|
3. 如果缺失或不符合规范,使用模板创建或更新相应文档,确保 Skills 区块与模板保持一致
|
|
19
19
|
|
|
20
20
|
## 3. 标准流程
|
|
@@ -26,12 +26,11 @@ description: Initialize the project Agents playbook, sync the skills inventory i
|
|
|
26
26
|
|
|
27
27
|
## 4. 文档结构规范
|
|
28
28
|
|
|
29
|
-
项目根目录的 `AGENTS.md`
|
|
29
|
+
项目根目录的 `AGENTS.md` 应严格按照模板创建:
|
|
30
30
|
|
|
31
|
-
-
|
|
32
|
-
- MCP 模式:使用 [`template/AGENTS_TEMPLATE_MCP.md`](./template/AGENTS_TEMPLATE_MCP.md)
|
|
31
|
+
- 使用 [`template/AGENTS_TEMPLATE.md`](./template/AGENTS_TEMPLATE.md)
|
|
33
32
|
|
|
34
|
-
|
|
33
|
+
文档结构如下:
|
|
35
34
|
|
|
36
35
|
1. **Project Overview** - 项目概述,描述项目的核心目标和背景,列出核心功能或特性(**唯一需要根据项目实际情况填写的内容**)
|
|
37
36
|
2. **Agents Workflow Guidelines** - 文档创建与编辑规范
|
|
@@ -67,9 +66,7 @@ grep -q "Special Rules" AGENTS.md || echo "缺少 Special Rules"
|
|
|
67
66
|
### 5.2 文档创建和更新策略
|
|
68
67
|
|
|
69
68
|
1. **如果项目根目录没有 `AGENTS.md`**:
|
|
70
|
-
-
|
|
71
|
-
- Skills 模式:[`template/AGENTS_TEMPLATE.md`](./template/AGENTS_TEMPLATE.md)
|
|
72
|
-
- MCP 模式:[`template/AGENTS_TEMPLATE_MCP.md`](./template/AGENTS_TEMPLATE_MCP.md)
|
|
69
|
+
- 使用模板 [`template/AGENTS_TEMPLATE.md`](./template/AGENTS_TEMPLATE.md) 创建
|
|
73
70
|
- 只修改 **Project Overview** 部分,填写项目的实际信息
|
|
74
71
|
- 其他所有内容严格按照模板,不得修改
|
|
75
72
|
|
|
@@ -80,7 +77,7 @@ grep -q "Special Rules" AGENTS.md || echo "缺少 Special Rules"
|
|
|
80
77
|
|
|
81
78
|
### 5.3 模板使用规范
|
|
82
79
|
|
|
83
|
-
-
|
|
80
|
+
- **模板文件**:使用 [`template/AGENTS_TEMPLATE.md`](./template/AGENTS_TEMPLATE.md)
|
|
84
81
|
- **可修改部分**:仅 **Project Overview** 部分需要根据项目实际情况填写
|
|
85
82
|
- **不可修改部分**:除 Project Overview 外的所有内容都应严格按照模板,不得修改
|
|
86
83
|
- **严格遵循**:确保文档结构与模板完全一致,保持规范统一
|
|
@@ -111,7 +108,7 @@ fi
|
|
|
111
108
|
|
|
112
109
|
如果缺失或不符合规范:
|
|
113
110
|
|
|
114
|
-
1.
|
|
111
|
+
1. 使用模板 [`AGENTS_TEMPLATE.md`](./template/AGENTS_TEMPLATE.md) 创建
|
|
115
112
|
2. **仅修改 Project Overview 部分**,填写项目的实际信息
|
|
116
113
|
3. **其他所有内容严格按照模板**,不得修改
|
|
117
114
|
|
|
@@ -127,8 +124,7 @@ fi
|
|
|
127
124
|
|
|
128
125
|
## 7. 附加资源
|
|
129
126
|
|
|
130
|
-
- [Agents
|
|
131
|
-
- [Agents 配置模板(MCP)](./template/AGENTS_TEMPLATE_MCP.md)
|
|
127
|
+
- [Agents 配置模板](./template/AGENTS_TEMPLATE.md)
|
|
132
128
|
- [Skill 创建方法](../skill_generate/SKILL.md) - Skill 创建规范
|
|
133
129
|
|
|
134
130
|
## 8. 注意事项
|
|
@@ -138,47 +134,3 @@ fi
|
|
|
138
134
|
- **结构一致性**:确保所有项目的 `AGENTS.md` 结构一致,便于维护和理解
|
|
139
135
|
- **模板更新**:模板更新时,应同步更新所有项目的 `AGENTS.md`(保留各自的 Project Overview)
|
|
140
136
|
- **文档引用规范**:文档中所有引用必须使用 Markdown 链接形式,例如 `[文件名](./path/to/file.md)` 或 `[目录名](./path/to/directory/)`
|
|
141
|
-
|
|
142
|
-
## 9. 模式选择与模板拼装
|
|
143
|
-
|
|
144
|
-
为保持 Skills 与 MCP 模式的独立性,模板被拆分为共享部分和模式增补部分:
|
|
145
|
-
|
|
146
|
-
- Shared base: `tools/build_package/partials/AGENTS_BASE.md`
|
|
147
|
-
- Skills appendix: `tools/build_package/partials/AGENTS_SKILLS_APPENDIX.md`
|
|
148
|
-
- MCP appendix: `tools/build_package/partials/AGENTS_MCP_APPENDIX.md`
|
|
149
|
-
|
|
150
|
-
Use the unified builder:
|
|
151
|
-
|
|
152
|
-
```
|
|
153
|
-
node tools/build_package templates
|
|
154
|
-
```
|
|
155
|
-
|
|
156
|
-
脚本会输出:
|
|
157
|
-
|
|
158
|
-
- `AGENTS_TEMPLATE.md`(共享部分 + Skills 增补)
|
|
159
|
-
- `AGENTS_TEMPLATE_MCP.md`(共享部分 + MCP 增补)
|
|
160
|
-
|
|
161
|
-
初始化项目时,只能选择其中一个模式的模板。若需从 Skills 切换到 MCP,必须重新生成 `AGENTS.md` 并删除另一模式的增补内容。
|
|
162
|
-
|
|
163
|
-
### 如何选择模式
|
|
164
|
-
|
|
165
|
-
根据你的集成方式选择模板:
|
|
166
|
-
|
|
167
|
-
- 选择 MCP 模式(使用 `AGENTS_TEMPLATE_MCP.md`),当:
|
|
168
|
-
- 你的 Agent 已配置通过 MCP 连接本仓库的服务(例如配置使用 `node mcp/src/server.js` 作为 stdio server);或
|
|
169
|
-
- 团队以 MCP 工具调用为主,不在仓库内直接读取 `.claude/skills/`。
|
|
170
|
-
- 否则选择 Skills 模式(使用 `AGENTS_TEMPLATE.md`)。这是默认模式,适合 IDE/CLI 直接在项目目录中工作的代理(Cursor、Claude Code、Codex CLI 等)。
|
|
171
|
-
|
|
172
|
-
### 选择后应执行的同步命令
|
|
173
|
-
|
|
174
|
-
- Skills 模式:
|
|
175
|
-
- 刷新 `<skills_system>` 与模板:
|
|
176
|
-
```bash
|
|
177
|
-
node tools/build_package update-skills --assemble
|
|
178
|
-
```
|
|
179
|
-
- MCP 模式:
|
|
180
|
-
- 生成 MCP server 并刷新 MCP 工具表:
|
|
181
|
-
```bash
|
|
182
|
-
node tools/build_package update-mcp
|
|
183
|
-
```
|
|
184
|
-
- MCP 项目中请勿保留 `<skills_system>` 区块。
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
AVAILABLE_IN_MCP=0
|