Auto Doc MCP Server

AutoDoc MCP服务器——AutoDoc

AutoDoc是一种MCP：https://modelcontextprotocol.io/docs/getting-started/intro该服务器作为stdio服务运行，并自动分析Git提交以生成结构化的每日CSV报告。它旨在从存储库历史中生成简洁的活动报告，适用于进度跟踪、状态报告和自动化文档工作流。

核心理念：通过应用可配置的规则和提示，将Git提交历史转换为人类可读的、面向业务的CSV报告。AutoDoc监视存储库位置，提取相关提交，汇总自定义列并将报告保存到磁盘。

主要特点

• 从Git提交历史生成CSV报告的任何日期间隔。
• 作为MCP stdio服务器运行（适用于编辑器和自动化管道中的集成）。
• 可通过环境变量（存储库路径、所有者、区域性、输出路径、规则、列标题）进行配置。
• 专为自定义数据而设计。

入门

1. 使用.NET构建并运行（示例使用项目路径）：

dotnet run --project AutoDocMcpServer/AutoDocMcpServer.csproj

1. 或者通过MCP客户端配置（.MCP.json）运行MCP服务器：

"inputs": [],
"servers": {
	"AutoDocMCPServer": {
		"type": "stdio",
		"command": "dotnet",
		"args": [
			"run",
			"--project",
			"C:/path/to/AutoDocMcpServer/AutoDocMcpServer.csproj"
		],
		"env": {
			"REPOSITORY_PATH": "C:\\path\\to\\repo",
			"OWNER_EMAIL": "owner@example.com",
			"OWNER_NAME": "Project Owner",
			"CULTURE": "en-US",
			"OUTPUT_PATH": "C:\\Reports",
			"REPORT_COLUMNS_TITLES": "Period,Phase/Stage,Activity (Title),Activity Description,Motivation,Process,Outcome,Participants",
			"RULES": "Analyze only relevant commits. Ignore merges and noisy commits. Use phases: Development, Tests, Infrastructure, Integration. Summarize titles using the configured culture. Use OWNER_NAME for Participants. Be brief and objective.",
			"PROJECT_METADATA": "Short project summary to include in report context."
		}
	}
}

解释环境变量

• REPOSITORY_PATH：要分析的本地Git存储库的完整路径。
• OWNER_EMAIL / OWNER_NAME：参与者栏中使用的联系人和姓名。
• CULTURE：用于格式化摘要的语言/文化（例如。， en-US, pt-BR).
• OUTPUT_PATH：编写CSV报告的目录。
• REPORT_COLUMNS_TITLES：生成的CSV文件中使用的逗号分隔的标题。
• RULES：指导提交摘要和过滤的自然语言规则。
• PROJECT_METADATA：在报告中简要介绍项目背景。

使用示例（提示+预期输出）

提示（示例发送到MCP服务）：

“为我本周的提交生成报告并保存。”

AutoDoc打印的示例结果：

Generating report: weekly (2026-02-02 – 2026-02-08)
Processed 18 commits (filtered 5 noisy commits)
Generated and saved: report_project-api_20260208_repeat.csv to C:\Users\eduar\AutoDoc-NiceAcesso-Reports\

CSV行示例（以下列 REPORT_COLUMNS_TITLES):

“2026-02-04”，“开发”，“添加JWT身份验证”，“为API端点实现JWT身份认证”，“为了确保API访问的安全”，“更新了中间件和令牌验证，添加了测试”，“auth现在需要JWT令牌”，Eduardo Rezende

最佳实践

• 改进提交标题和描述，以获得良好的上下文
• 保持本地存储库的最新状态，并在干净的工作树上运行AutoDoc以获得准确的结果。
• 调谐 RULES 与团队的提交风格和你认为“相关”的内容相匹配。
• 使用 REPORT_COLUMNS_TITLES 使输出适应您的内部报告模板。

贡献

欢迎投稿——开放问题和拉取请求。保持更改的重点：添加配置选项、改进提交过滤或增强摘要规则。

许可证

根据存储库中的条款进行分发 LICENSE.txt.

有关详细信息，请参阅项目中的MCP配置示例和 AutoDocMcpServer/README.md 针对特定服务的注意事项。