mcpField
A
adr-create

adr-create

github.com/ruvnet开发80.0k741 次安装今天更新
代码仓库

关于 adr-create

用于创建顺序编号的架构决策记录(ADR)并登记到 AgentDB 的 Skill。它还会搜索相关决策,并在 ADR 文档和图中建立关联。

主要功能

  1. 01分配下一个 ADR 编号
  2. 02按模板创建 ADR
  3. 03将决策登记到 AgentDB
  4. 04搜索相关 ADR
  5. 05关联相关决策

适用场景

  1. 01记录影响多个组件的架构选择
  2. 02记录技术或 API 决策
  3. 03将新决策关联到已有 ADR

MCP 相关

它使用 MCP 工具将 ADR 数据存入 AgentDB、搜索相关决策、添加因果边,并保存模式以供后续检索。

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/ruvnet/ruflo --skill adr-create

安装后在 Claude Code 中输入/adr-create确认已加载。

详细介绍

创建 ADR

创建一份新的架构决策记录,使用下一个连续编号,将其登记到 AgentDB 图中,并链接到相关 ADR。

使用时机

当需要记录重要的架构决策时使用,例如采用新技术、API 设计选择、数据模型变更、基础设施决策,或影响多个组件的横切关注点。

步骤

  1. 查找下一个编号 -- 对 docs/adr/ADR-*.md 使用 Glob,并解析已有编号以确定下一个连续 ID(ADR-001、ADR-002 等)。如果 docs/adr/ 不存在,则创建该目录。

  2. 将标题转换为 slug -- 将标题参数转换为小写、以连字符分隔的 slug(例如,“Use PostgreSQL for persistence”会变为 use-postgresql-for-persistence)。

  3. 创建 ADR 文件 -- 使用标准模板,通过 Write 在 docs/adr/ADR-NNN-<slug>.md 创建文件:

    # ADR-NNN: <Title>
    
    - **Status**: proposed
    - **Date**: <today's date YYYY-MM-DD>
    - **Deciders**: <leave blank for author to fill>
    - **Tags**: <leave blank>
    
    ## Context
    
    
    
    ## Decision
    
    
    
    ## Consequences
    
    ### Positive
    -
    
    ### Negative
    -
    
    ### Neutral
    -
    
    ## Links
    
  4. 存储到 AgentDB -- 调用 mcp__plugin_ruflo-core_ruflo__agentdb_hierarchical-store,并传入:

    • key:mem:ADR-NNN
    • tier:semantic
    • value:JSON 编码的字符串:{ "id": "ADR-NNN", "title": "<title>", "status": "proposed", "date": "<today>", "file": "docs/adr/ADR-NNN-<slug>.md" }
  5. 查找相关 ADR -- 在命名空间 adr-patterns 中,以标题为查询内容调用 mcp__plugin_ruflo-core_ruflo__memory_search,查找相关决策。如果找到匹配项,则将其添加到 Links 部分,并针对每个关系调用 mcp__plugin_ruflo-core_ruflo__agentdb_causal-edge,并传入:

    • sourceId:mem:ADR-NNN
    • targetId:mem:ADR-RELATED
    • relation:depends-on
  6. 存储模式 -- 在命名空间 adr-patterns 中调用 mcp__plugin_ruflo-core_ruflo__memory_store,使用 key ADR-NNN,并将标题和上下文作为 value,以便将来进行语义搜索。

  7. 报告 -- 输出创建的文件路径、ADR 编号,以及找到的任何相关 ADR。

评论

支持 Markdown