文档生成与合规检查工具

AKR MCP服务器为GitHub Copilot提供文档模板、合规检查和代码分析工具,帮助团队在代码演进过程中保持架构和设计文档的准确性。

  • by reyesmelvinr-emr
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 reyesmelvinr-emr/akr-mcp-server

使用说明

AKR MCP文档服务器

AKR MCP服务器在VS code中为GitHub Copilot提供文档模板、执行和代码分析工具。它帮助团队随着代码的发展保持架构和设计文档的准确性。


此服务器的功能

  • 为Copilot提供AKR模板和指南
  • 从代码库(C#、TypeScript、SQL)中提取数据
  • 生成具有结构化部分的文档存根
  • 在编写之前强制执行文档合规性
  • 记录遥测数据以进行验证和工作流洞察

从这里开始

文件入口点

安装和设置

项目工作流

开发人员参考

系统架构


快速入门(服务器工作区)

# Clone and navigate to the server repository
cd akr-mcp-server

# Initialize submodule (templates)
git submodule update --init --recursive

# Create virtual environment
python -m venv venv

# Activate virtual environment
# On Windows (PowerShell):
.\venv\Scripts\Activate.ps1
# On macOS/Linux:
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

# Verify installation
python test_jinja2_pipeline.py

要将VS Code连接到MCP服务器,请按照中的配置步骤进行操作 docs/INSTALLION_AND_SETUP.md.


存储库结构

akr-mcp-server/
├── docs/                       # Consolidated documentation
├── src/                        # MCP server and tool implementations
├── templates/                  # Jinja2 templates
├── akr_content/                # Charters, guides, and template content
├── scripts/                    # Validation and utility scripts
├── tests/                      # Unit and integration tests
├── logs/                       # Telemetry and enforcement logs
└── README.md                   # You are here

关键配置文件

MCP服务器配置(此仓库)

MCP配置所在的工作区 /.vcode/mcp.json.

项目配置(您的应用程序仓库)

每个应用程序仓库应包括 /.akr-config.json 定义文档映射和验证首选项。


验证和执行

文档在编写之前经过验证。主要执行规则包括:

  • 必需的部分必须存在
  • 章节顺序必须与模板匹配
  • YAML frontmatter必须存在
  • 必须满足完整性阈值

看 docs/DEVELOPER_REFERENCE.md 了解完整的执行细节。


写入操作(默认禁用)

写入工具是封闭的,以防止意外更改。要启用写入,请执行以下操作:

  1. 设置环境变量: AKR_ENABLE_WRITE_OPS=true
  2. 通过 allowWrites=true 在工具调用中

如果缺少任一检查,写入操作将返回权限错误。看 安全.md 了解详情。


故障排除


贡献

对于开发工作流程、模板更改和验证逻辑,请使用:


最后更新时间: 2026-02-19