架构决策记录工具

一个基于Python MCP服务器的架构决策记录工具,支持自动生成MADR格式的决策记录,包含自动编号、模板化格式化和多传输协议支持。

  • by abest0
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 abest0/adr-mcp

使用说明

adr制剂

概述

该存储库将ADR(架构决策记录)代理工具实现为Python MCP(模型上下文协议)服务器。它根据对话上下文自动生成MADR格式的架构决策记录,其功能包括自动ADR编号、基于模板的格式化和多种传输协议(HTTP、stdio、WebSocket)。该工具遵循使用Nx工作区的单仓库结构,并通过为开发过程中做出的架构决策生成自己的ADR来演示自我文档。

✨ 你的新的,闪亮的 Nx工作区 已成功创建! ✨.

了解有关此工作区设置和@aws/nx插件的更多信息。现在,让我们让你加快速度!

安装Nx控制台

Nx Console是一个编辑器扩展,可以丰富您的开发人员体验。它允许您运行任务、生成代码,并改进IDE中的代码自动补全功能。它可用于VSCode和IntelliJ。

安装Nx控制台»

可用发电机

以下是目前可用的发电机列表 @aws/nx-plugin:

  • ts#项目:生成TypeScript项目

  • py#项目:生成Python项目

  • py#快速api:生成FastAPI Python项目

  • ts#react网站:生成React静态网站

  • ts#react网站#auth:将auth添加到现有的React网站

  • ts#基础设施:生成cdk应用程序

  • ts#lambda函数:生成TypeScript lambda函数

  • ts#trpc api:创建trpc后端

  • api连接:将源项目与目标API项目集成

  • 许可证:添加许可证文件并配置源代码许可证头

  • py#lambda函数:将lambda函数添加到python项目中

  • ts#nx发电机:用于将Nx生成器添加到现有TypeScript项目的生成器

  • ts#mcp服务器:生成一个TypeScript模型上下文协议(MCP)服务器,为大型语言模型提供上下文

  • ts#nx插件:生成自己的Nx插件!通过MCP自动构建可用于AI vibe编码的自定义生成器

  • 地形#项目:生成Terraform项目

  • py#mcp服务器:生成Python模型上下文协议(MCP)服务器,为大型语言模型提供上下文

  • py#股线剂:将Strands代理添加到Python项目中

您还可以选择使用其他 社区插件 根据需要。

调用生成器

pnpm exec nx g @aws/nx-plugin:<generator-name>

或者,您可以使用NX IDE插件来调用生成器。

请参阅 全部文件 为每台发电机提供额外指导。

常见任务

构建单个项目

pnpm exec nx build <project-name>

构建所有项目

pnpm exec nx run-many --target build --all
# or
pnpm exec build:all

运行任意任务

pnpm exec nx <target> <project-name>

抓取(并修复)所有项目

pnpm exec nx run-many --target lint --configuration=fix --all

测试所有项目(并更新快照)

pnpm exec nx run-many --target test --all --update

这些目标要么 自动推断 或定义于 project.json 或 package.json 文件夹。

有关在Nx文档中运行任务的更多信息»

保持TypeScript项目引用的最新状态

Nx自动更新TypeScript 项目引用 在……里面 tsconfig.json 文件,以确保它们根据您的项目依赖关系保持准确(import 声明)。此同步是在运行以下任务时自动完成的 build,需要更新引用才能正常运行。

要手动触发将项目图依赖关系信息同步到TypeScript项目引用的过程,请运行以下命令:

pnpm exec nx sync

您可以通过在CI作业配置中添加一个运行以下命令的步骤来强制TypeScript项目引用在CI中运行时始终处于正确状态:

pnpm exec nx sync:check

了解有关nx-sync的更多信息

设置CI!

使用以下命令为您的工作区配置CI工作流:

pnpm exec nx g ci-workflow

了解有关CI上Nx的更多信息

有用的链接

了解更多: