archgraph-argo 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,115 @@
+# ArchGraph
+
+An architecture-graph driven framework for Agentic Engineering.
+
+## What is this?
+
+`ArchGraph` treats an **intent architecture graph** as the single source of
+truth for agentic engineering. Every piece of work starts from an element in the graph — a Work
+Package, a Skill, a Rule, a Viewpoint, or an Application Component — and every repository change is
+traced back to that element.
+
+The canonical graph lives at [`design/KG/SystemArchitecture.json`](design/KG/SystemArchitecture.json).
+
+## Architecture
+
+The global architecture (Layered Viewpoint) shows how the human, the coding agent, ARGO MCP, the
+intent architecture graph, ArchiMate 3.2, and Enterprise Architect relate in graph-driven agentic
+engineering:
+
+![Global architecture — Layered Viewpoint](docs/diagrams/global-architecture.svg)
+
+Editable source: [`docs/diagrams/global-architecture.excalidraw`](docs/diagrams/global-architecture.excalidraw)
+
+## Core principles
+
+1. **Arm before acting** — before any development, pull the Work Package's associated Skills and
+   Rules and materialize them under `~/.copilot/skills/<name>/SKILL.md` (user-level) or
+   `.github/skills/<name>/SKILL.md` (project) and `*.instructions.md`.
+2. **Find the element first** — every repository change maps to an architecture element. If none
+   exists, create one inside a sensible View and Viewpoint.
+3. **Acceptance tests first** — check the affected acceptance cases before changing anything.
+   Tests verify elements from the outside (GIVEN-WHEN-THEN), never their internals.
+4. **Commit traceability** — after each change, commit and register the commit id plus file paths
+   back into the graph element.
+
+These rules are encoded as user-level instructions `argo-copilot-instructions.instructions.md`
+in the VS Code Copilot prompts folder (`%APPDATA%\Code\User\prompts`).
+
+## Repository map
+
+| Path | Purpose |
+| --- | --- |
+| `design/KG/SystemArchitecture.json` | Canonical intent architecture graph (single source of truth) |
+| `%APPDATA%\Code\User\prompts\argo-copilot-instructions.instructions.md` | Global agent rules (user-level) |
+| `~/.copilot/skills/argo-init/SKILL.md` | ARGO harness init skill (user-level) |
+| `.github/kglibrary.instructions.md` | Global rule for `KGlibrary/*/info.md` frontmatter format |
+| `.github/skills/<name>/SKILL.md` | Skills materialized from the graph (`argo-init`, `create-github-repository-page`, `diagram-draw`, `optimize-web-layout-style`) |
+| `.argo/` | ARGO harness: MCP server, schema, validators, semantic (Graph RAG) lifecycle and Neo4j sync |
+| `KGlibrary/` | Reference project knowledge library |
+| `index.html` | GitHub Pages home site |
+| `tests/` | Executable acceptance tests (Node.js built-in test runner) |
+
+## How to use
+
+`ArchGraph` is an agentic engineering framework driven by a knowledge graph —
+the intent architecture graph — whose schema complies with **ArchiMate 3.2**.
+
+To adopt it as the building framework for another project, copy the following into the target project:
+
+1. **`.argo/`** — the ARGO harness: the MCP server, the ArchiMate 3.2 schema, validators, the
+   semantic (Graph RAG) lifecycle, and Neo4j sync.
+2. **One agent-host configuration directory**, depending on which agent you use:
+   - `.github/` — GitHub Copilot / VS Code
+   - `.opencode/` — opencode
+   - `.cursor/` — Cursor
+
+   Each directory carries the global rules, the materialized skills, and the `argo` MCP wiring.
+3. **The `.feap` Enterprise Architect model** — the ArchiMate 3.2 model used to author the
+   knowledge graph (the `feap` tool).
+
+Then point your agent at the harness (`node .argo/scripts/argo-mcp-server.js`) and bootstrap the
+environment:
+
+```powershell
+node .argo/scripts/ensureArgoHarnessEnvironment.js
+```
+
+## ARGO MCP harness
+
+Read and write the intent architecture through the **ARGO MCP server** — configured in
+[`.github/mcp.json`](.github/mcp.json) and served by `node .argo/scripts/argo-mcp-server.js`.
+Never edit `design/KG/SystemArchitecture.json` directly.
+
+Bootstrap or health-check the harness with:
+
+```powershell
+node .argo/scripts/ensureArgoHarnessEnvironment.js
+```
+
+The harness validates the graph against `.argo/schema/SystemArchitecture.schema.json`, supports a
+semantic (Graph RAG) query lifecycle, and can sync the graph into Neo4j (`neo4j-driver`).
+
+## KGlibrary reference library
+
+Each project under `KGlibrary/<project>/` provides an `info.md` with YAML frontmatter keys
+(`name`, `description`, `repo`, `branch`, `commit_id`) so the home site and agents can uniformly
+consume reference project information. See
+[`.github/kglibrary.instructions.md`](.github/kglibrary.instructions.md).
+
+## Tests
+
+Run the acceptance suite with:
+
+```powershell
+node --test "tests/*.test.js"
+```
+
+## Requirements
+
+- Node.js (built-in `node:test` runner)
+- Optional: a reachable Neo4j database for the semantic lifecycle / sync tooling
+
+## License
+
+[Apache License 2.0](LICENSE)

package/argo/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "argo",
+  "private": true,
+  "description": "Runtime dependencies for the Argo toolchain (deployed alongside argo/scripts).",
+  "dependencies": {
+    "neo4j-driver": "^6.2.0"
+  }
+}

package/argo/rules/intent-architecture-global-rule.md

@@ -0,0 +1,45 @@
+---
+description: "ArchGraph / ARGO 全局工作流规则：动手前先在意图图谱定位架构元素、验收用例先行（可执行 GIVEN-WHEN-THEN）、通过全局 ARGO MCP 读写意图图谱、提交后登记 commit id + 文件路径。Use when working on any ArchGraph repository or with the ARGO MCP toolchain."
+name: "ArchGraph ARGO Workflow Rules"
+applyTo: "**"
+---
+
+<Principle>
+当你领取到某个Workpackage后，进行任何开发活动前，必须先完成自我武装，从该Workpackage关联的元素中，找到完成任务需要使用的SKILL、需要遵守的全局规则。
+1. 对于需要的SKILL，请在.github/skills下创建一个或多个[SKILL名称]/SKILL.md;
+2. 对于要遵守的全局规则，需要在.github下面增加一个或多个 *.instructions.md文件。
+</Principle>
+
+<Principle>
+1. 在动手修改仓库任何内容前，你必须先在架构图谱中找到对应的架构元素。
+2. 如果没有找到对应的架构元素，你必须先选择一个View，并在其中创建一个新的合理的架构元素。
+3. 如果没有找到对应的View，你必须先思考应该选择哪个Viewpoint最合理，并基于这个最合理的Viewpoint创建一个新的View。
+4. 如果你在动手修改前有任何逻辑不完整的地方，首先从意图架构图谱中寻找答案，无法找到时必须询问人类伙伴，不能直接在仓库中进行修改。
+5. 仓库内容修改完成后，必须将改动的内容git commit提交留证，并将提交"commit id + 相关的文件路径"登记到图谱中对应的架构元素中，有必要时刷新已有描述或属性（必要时才新增属性，以最大程度保持内容紧凑）。
+</Principle>
+
+<Principle>
+1. 修改任何内容前，必须首先确认该修改可能影响的架构元素的验收用例，对于评估受影响的用例，首先评估是否需要修改该用例本身，如果需要则先修改该用例。
+2. 对于所有评估受影响的用例（包括修改后的用例），必须在修改完成后进行这些用例的回归测试，确保这些用例全部通过。
+3. 如果发现本次修改和知识图谱中任何验收用例都无关，则说明知识图谱中验收用例缺失，需要首先补充后再实施修改。
+4. 知识架构图谱中的每个验收用例必须是对该用例所挂载的元素，从外部的角度进行验证的，不能是对该元素内部实现的验证。
+5. 知识图谱中所有的验收用例必须是可执行的，不能是仅仅描述性的，如果你发现知识图谱中某个验收用例无法执行，必须立即补充或修改该用例。
+6. 知识图谱中所有的验收用例必须采用GIVEN-WHEN-THEN的格式进行描述和实现，以便于人类阅读同时可以自动化执行。
+</Principle>
+
+<instruction>
+你必须通过ARGO MCP server提供的工具来进行意图架构的读写操作，禁止直接修改意图架构的源文件：
+1. getIntentElementContext: 用于获取意图架构元素的上下文信息，包括元素的属性、关联关系等。
+2. previewSystemArchitectureMutation: 用于预览意图架构的变更，确保变更不会破坏现有的架构结构。
+3. applySystemArchitectureMutation: 用于应用意图架构的变更，将预览的变更正式写入意图架构中。
+4. addArchitectureElement: 用于在意图架构中添加新的架构元素。
+5. updateArchitectureElement: 用于更新意图架构中已有的架构元素的属性或关联关系。
+6. removeArchitectureElement: 用于从意图架构中移除已有的架构元素。
+7. addArchitectureRelationship: 用于在意图架构中添加新的架构元素之间的关联关系。
+8. updateArchitectureRelationship: 用于更新意图架构中已有的架构元素之间的关联关系。
+9. removeArchitectureRelationship: 用于从意图架构中移除已有的架构元素之间的关联关系。
+10. addArchitectureView: 用于在意图架构中添加新的架构视图。
+11. updateArchitectureView: 用于更新意图架构中已有的架构视图的属性或关联关系。
+12. removeArchitectureView: 用于从意图架构中移除已有的架构视图。
+13. validateSystemArchitecture: 用于验证意图架构的完整性和一致性，确保架构元素和关联关系符合预期。
+</instruction>

package/argo/schema/ImplementationToCodingHandoff.schema.json

@@ -0,0 +1,252 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "./.argo/schema/ImplementationToCodingHandoff.schema.json",
+  "title": "Implementation To Coding Handoff Schema",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "stage",
+    "generatedAt",
+    "sourceIntentGraphPath",
+    "implementationContracts",
+    "explicitEntrypoints",
+    "criticalNonExplicitTests",
+    "expectedFailureRecordsPath",
+    "codingTargets",
+    "taskExecutionPlan",
+    "frozenFiles"
+  ],
+  "properties": {
+    "stage": {
+      "type": "string",
+      "const": "implementation-to-coding"
+    },
+    "generatedAt": {
+      "type": "string"
+    },
+    "sourceIntentGraphPath": {
+      "type": "string"
+    },
+    "summary": {
+      "type": "string"
+    },
+    "implementationContracts": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "string"
+      }
+    },
+    "explicitEntrypoints": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/$defs/explicitEntrypoint"
+      }
+    },
+    "criticalNonExplicitTests": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/nonExplicitTest"
+      }
+    },
+    "supportingNonExplicitTests": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/nonExplicitTest"
+      }
+    },
+    "expectedFailureRecordsPath": {
+      "type": "string"
+    },
+    "codingTargets": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/$defs/codingTarget"
+      }
+    },
+    "taskExecutionPlan": {
+      "$ref": "#/$defs/taskExecutionPlan"
+    },
+    "frozenFiles": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "string"
+      }
+    },
+    "openGaps": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "$defs": {
+    "explicitEntrypoint": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "testcaseName",
+        "entryPath",
+        "controlPoint",
+        "observationPoint",
+        "initialExecutionStatus",
+        "initialExecutionCommand"
+      ],
+      "properties": {
+        "testcaseName": {
+          "type": "string"
+        },
+        "entryPath": {
+          "type": "string"
+        },
+        "controlPoint": {
+          "type": "string"
+        },
+        "observationPoint": {
+          "type": "string"
+        },
+        "initialExecutionStatus": {
+          "type": "string",
+          "enum": [
+            "passed",
+            "failed"
+          ]
+        },
+        "initialExecutionCommand": {
+          "type": "string"
+        },
+        "failureReason": {
+          "type": "string"
+        }
+      }
+    },
+    "nonExplicitTest": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "path",
+        "controlPoint",
+        "observationPoint"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "path": {
+          "type": "string"
+        },
+        "kind": {
+          "type": "string"
+        },
+        "controlPoint": {
+          "type": "string"
+        },
+        "observationPoint": {
+          "type": "string"
+        },
+        "expectedStatus": {
+          "type": "string",
+          "enum": [
+            "passed",
+            "failed"
+          ]
+        }
+      }
+    },
+    "codingTarget": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "failureSignal",
+        "nextAction"
+      ],
+      "properties": {
+        "testcaseName": {
+          "type": "string"
+        },
+        "path": {
+          "type": "string"
+        },
+        "failureSignal": {
+          "type": "string"
+        },
+        "nextAction": {
+          "type": "string"
+        }
+      }
+    },
+    "taskExecutionPlan": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "executionStrategy",
+        "tasks"
+      ],
+      "properties": {
+        "executionStrategy": {
+          "type": "string"
+        },
+        "tasks": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/$defs/codingTask"
+          }
+        }
+      }
+    },
+    "codingTask": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "taskId",
+        "title",
+        "objective",
+        "steps",
+        "completionSignal"
+      ],
+      "properties": {
+        "taskId": {
+          "type": "string"
+        },
+        "title": {
+          "type": "string"
+        },
+        "objective": {
+          "type": "string"
+        },
+        "dependsOn": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "relatedTestcases": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "targetPaths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "steps": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "string"
+          }
+        },
+        "completionSignal": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}