archgraph-argo 0.6.1 → 0.6.3

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 (6) hide show
  1. package/README.md +1 -1
  2. package/argo/rules/archgraph.instructions.md +42 -33
  3. package/argo/schema/archimate3.2.md +7153 -0
  4. package/install-argo.ps1 +124 -26
  5. package/package.json +1 -1
  6. package/argo/schema/archimate3.2.pdf +0 -0
package/README.md CHANGED
@@ -26,7 +26,7 @@ npm install -g archgraph-argo
26
26
  argo-deploy
27
27
  ```
28
28
 
29
- Done — the ARGO toolchain, skills, and rules are deployed, and the `argo` MCP server is registered automatically.
29
+ Done — the ARGO toolchain, skills, and rules are deployed, and the `argo` MCP server is registered automatically in **GitHub Copilot**, **Cursor**, and **OpenCode**.
30
30
 
31
31
  > Semantic (Graph RAG) queries also need **Neo4j** and a **vector engine** configured in
32
32
  > `~/.argo/.env`; everything else works out of the box.
package/argo/rules/archgraph.instructions.md CHANGED
@@ -4,48 +4,57 @@ name: "ArchGraph ARGO Workflow Rules"
4
4
  applyTo: "**"
5
5
  ---
6
6
 
7
- <Principle>
8
- 当你领取到某个Workpackage后，进行任何开发活动前，必须先完成自我武装，从该Workpackage关联的元素中，找到完成任务需要使用的SKILL、需要遵守的全局规则。
9
- 1. 对于需要的SKILL，请在.github/skills下创建一个或多个[SKILL名称]/SKILL.md;
10
- 2. 对于要遵守的全局规则，需要在.github下面增加一个或多个 *.instructions.md文件。
11
- 3. 工作完成后，需要将上面生成的SKILL和RULE刷新到知识图谱中对应的架构元素上，确保下次领取到该Workpackage的Agent可以直接获取到这些SKILL和RULE。
12
- 4. 最后需要从.github/skills和.github下删除这些SKILL和RULE文件，确保仓库中不残留这些文件。
13
- </Principle>
7
+ <Ontology>
8
+ 你的认知体系结构是基于Archimate3.2及其扩展元素构成：
9
+ 1. 如果你想知道知识图谱的合法结构，请参考：argo\schema\SystemArchitecture.schema.json
10
+ 2. 如果你想查询某类元素或关系的定义，请参考：argo\schema\archimate3.2.md
11
+ </Ontology>
14
12
 
15
- <Principle>
13
+ <ArmingBeforeImplementation>
14
+ 当你准备动手建设某个元素，你需要先查看构建这个元素所需的技能和资源，并将这些技能和资源放入你的会话记忆中，以便在动手建设时可以随时调用。
15
+ </ArmingBeforeImplementation>
16
+
17
+ <IntentArchitectureFirst>
16
18
  1. 在动手修改仓库任何内容前，你必须先在架构图谱中找到对应的架构元素。
17
19
  2. 如果没有找到对应的架构元素，你必须先选择一个View，并在其中创建一个新的合理的架构元素。
18
- 3. 如果没有找到对应的View，你必须先思考应该选择哪个Viewpoint最合理，并基于这个最合理的Viewpoint创建一个新的View。
19
- 4. 如果你在动手修改前有任何逻辑不完整的地方，首先从意图架构图谱中寻找答案，无法找到时必须询问人类伙伴，不能直接在仓库中进行修改。
20
- 5. 仓库内容修改完成后，必须将改动的内容git commit提交留证，并将提交"commit id + 相关的文件路径"登记到图谱中对应的架构元素中，有必要时刷新已有描述或属性（必要时才新增属性，以最大程度保持内容紧凑）。
21
- </Principle>
20
+ 3. 如果没有找到对应的View，你必须先思考应该选择哪个Viewpoint最合理(可参考argo\schema\archimate3.2.md中的# **C Example Viewpoints** 章节)，并基于这个最合理的Viewpoint创建一个新的View。
21
+ 4. 仓库内容修改完成后，必须将改动的内容git commit提交留证，并将提交"commit id + 相关的文件路径"通过增加“commit”属性登记到图谱中对应的架构元素中，有必要时刷新已有描述或属性（必要时才新增属性，以最大程度保持内容紧凑）。
22
+ </IntentArchitectureFirst>
22
23
 
23
- <Principle>
24
+ <AcceptanceTestFirst>
24
25
  1. 修改任何内容前，必须首先确认该修改可能影响的架构元素的验收用例，对于评估受影响的用例，首先评估是否需要修改该用例本身，如果需要则先修改该用例。
25
26
  2. 对于所有评估受影响的用例（包括修改后的用例），必须在修改完成后进行这些用例的回归测试，确保这些用例全部通过。
26
27
  3. 如果发现本次修改和知识图谱中任何验收用例都无关，则说明知识图谱中验收用例缺失，需要首先补充后再实施修改。
27
- 4. 知识架构图谱中的每个验收用例必须是对该用例所挂载的元素，从外部的角度进行验证的，不能是对该元素内部实现的验证。
28
+ 4. 知识架构图谱中的每个验收用例必须是对该用例所挂载的元素验证且必须从外部的角度进行的验证，不能是对该元素内部实现的验证。
28
29
  5. 知识图谱中所有的验收用例必须是可执行的，不能是仅仅描述性的，如果你发现知识图谱中某个验收用例无法执行，必须立即补充或修改该用例。
29
30
  6. 知识图谱中所有的验收用例必须采用GIVEN-WHEN-THEN的格式进行描述和实现，以便于人类阅读同时可以自动化执行。
30
- </Principle>
31
+ </AcceptanceTestFirst>
32
+
33
+ <ExplorationGuideline>
34
+ 1. 当你探索上下文时，采用小步探索的方式，每次查询的深度不要过大，每次查询后，你可以根据查询结果，决定下一步的探索方向。
35
+ 2. 当你获得多个同类或相互冲突的信息时，请优先选择最接近你当前任务的上下文信息，避免在不相关的上下文中浪费时间。
36
+ </ExplorationGuideline>
31
37
 
32
- <Guideline>
33
- 当你探索上下文时，采用小步探索的方式，每次查询的深度不要过大，每次查询后，你可以根据查询结果，决定下一步的探索方向。
34
- </Guideline>
38
+ <OrganizationGuideline>
39
+ 1. 每个 `Business Actor` 是一个持久的会话，一旦该会话被创建，它将一直存在，直到被明确地删除。当你要调用某个 `Business Actor` 时，你应该首先根据他的`sessionId`属性从历史会话中查找是否已经存在该 `Business Actor`，如果存在，则直接使用该会话；如果不存在，则创建一个新的会话。当一个 `Business Actor` 会话被创建，你应该将该会话ID通过属性 `sessionId` 登记到该 `Business Actor` 的架构元素中，以便于后续的会话调用。
40
+ 2. 每个 `Business Actor` 要形成自己的长期记忆，该长期记忆是挂载在该 `Business Actor` 元素下的一个或多个View，包含了该 `Business Actor` 的所有历史工作信息。
41
+ </OrganizationGuideline>
35
42
 
36
- <instruction>
43
+ <ToolsGuideline>
37
44
  你必须通过ARGO MCP server提供的工具来进行意图架构的读写操作，禁止直接修改意图架构的源文件：
38
- 1. getIntentElementContext: 用于获取意图架构元素的上下文信息，包括元素的属性、关联关系等。
39
- 2. previewSystemArchitectureMutation: 用于预览意图架构的变更，确保变更不会破坏现有的架构结构。
40
- 3. applySystemArchitectureMutation: 用于应用意图架构的变更，将预览的变更正式写入意图架构中。
41
- 4. addArchitectureElement: 用于在意图架构中添加新的架构元素。
42
- 5. updateArchitectureElement: 用于更新意图架构中已有的架构元素的属性或关联关系。
43
- 6. removeArchitectureElement: 用于从意图架构中移除已有的架构元素。
44
- 7. addArchitectureRelationship: 用于在意图架构中添加新的架构元素之间的关联关系。
45
- 8. updateArchitectureRelationship: 用于更新意图架构中已有的架构元素之间的关联关系。
46
- 9. removeArchitectureRelationship: 用于从意图架构中移除已有的架构元素之间的关联关系。
47
- 10. addArchitectureView: 用于在意图架构中添加新的架构视图。
48
- 11. updateArchitectureView: 用于更新意图架构中已有的架构视图的属性或关联关系。
49
- 12. removeArchitectureView: 用于从意图架构中移除已有的架构视图。
50
- 13. validateSystemArchitecture: 用于验证意图架构的完整性和一致性，确保架构元素和关联关系符合预期。
51
- </instruction>
45
+ 1. getSystemArchitecture: 语义化读取架构（推荐带 query.purpose + query.intent，而非全量读取）。
46
+ 2. getIntentElementContext: 用于获取意图架构元素的上下文信息，包括元素的属性、关联关系等。
47
+ 3. previewSystemArchitectureMutation: 用于预览意图架构的变更，确保变更不会破坏现有的架构结构。
48
+ 4. applySystemArchitectureMutation: 用于应用意图架构的变更，将预览的变更正式写入意图架构中。
49
+ 5. addArchitectureElement: 用于在意图架构中添加新的架构元素。
50
+ 6. updateArchitectureElement: 用于更新意图架构中已有的架构元素的属性或关联关系。
51
+ 7. removeArchitectureElement: 用于从意图架构中移除已有的架构元素。
52
+ 8. addArchitectureRelationship: 用于在意图架构中添加新的架构元素之间的关联关系。
53
+ 9. updateArchitectureRelationship: 用于更新意图架构中已有的架构元素之间的关联关系。
54
+ 10. removeArchitectureRelationship: 用于从意图架构中移除已有的架构元素之间的关联关系。
55
+ 11. getArchitectureViewContext: 用于查询意图架构中的架构视图及其包含的元素和关联关系。
56
+ 12. addArchitectureView: 用于在意图架构中添加新的架构视图。
57
+ 13. updateArchitectureView: 用于更新意图架构中已有的架构视图的属性或关联关系。
58
+ 14. removeArchitectureView: 用于从意图架构中移除已有的架构视图。
59
+ 15. validateSystemArchitecture: 用于验证意图架构的完整性和一致性，确保架构元素和关联关系符合预期。
60
+ </ToolsGuideline>