【Agent】Microsoft Agent Framework 实战：打造智能 Git 周报生成工具

Microsoft Agent Framework 实战打造智能 Git 周报生成工具从手动写周报到 AI 自动生成用 Python Microsoft Agent Framework RC6 构建你的第一个 Agent 应用一、前言程序员周报的痛点每周五下班前你是不是都在对着 Git 提交记录发愁git log --since1 week ago --oneline看着一堆fix bug、add feature、update config这样的提交记录手动整理成一份专业的周报。这个过程既枯燥又容易遗漏重要内容。如果能有一个智能助手自动把原始提交记录转化成结构清晰、语言专业的周报岂不是美滋滋今天我们就用Microsoft Agent Framework RC6来构建这样一个 Git 周报生成工具体验 Agent 开发的完整流程。二、Microsoft Agent Framework 简介Microsoft Agent Framework 是微软推出的轻量级 AI Agent 开发框架核心特点特点说明轻量级仅需少量代码即可构建 Agent工具集成支持将 Python 函数自动注册为 Agent 工具流式输出支持 streaming 模式实时展示生成过程兼容性好支持 OpenAI API 及各类兼容模型本地模型、Azure 等相比 LangChain、AutoGen 等框架Microsoft Agent Framework 更专注于工具调用 任务执行的简洁范式非常适合快速构建实用性 Agent。安装依赖pipinstallagent-framework python-dotenv三、核心设计思路3.1 整体架构用户输入仓库路径、天数范围 ↓ Agent 调用工具获取 Git 数据 ↓ ├── get_git_commit_logs() → 提交记录 ├── get_git_stats() → 统计数据 ↓ LLM 将原始数据转化为专业周报 ↓ 输出 Markdown 格式周报并保存3.2 工具函数设计Agent 需要两个核心工具工具一获取提交记录defget_git_commit_logs(repo_path:Annotated[str,Field(descriptionGit 仓库路径)].,days:Annotated[int,Field(description获取过去 N 天的提交记录)]7,)-str:获取指定路径下过去 N 天的 Git 提交记录since_date(datetime.now()-timedelta(daysdays)).strftime(%Y-%m-%d)cmd[git,-C,repo_path,log,f--since{since_date},--oneline,--prettyformat:%s (%ad),--dateshort,]resultsubprocess.run(cmd,capture_outputTrue,textTrue,encodingutf-8)returnf过去{days}天的提交记录\n{result.stdout}工具二获取统计数据defget_git_stats(repo_path:str.,days:int7)-str:获取提交次数、新增/删除行数、变更文件数等统计# 统计提交数量# 统计代码行变化# 统计变更文件数returnf提交次数:{count}\n新增行数:{added}\n删除行数:{deleted}3.3 使用 Pydantic 进行工具定义Microsoft Agent Framework 使用 Pydantic 的AnnotatedField进行参数定义这样可以自动生成工具的 JSON Schema提供参数说明description支持类型验证和默认值fromtypingimportAnnotatedfrompydanticimportFielddefget_git_commit_logs(repo_path:Annotated[str,Field(descriptionGit 仓库路径默认当前目录)].,days:Annotated[int,Field(description获取过去 N 天的提交记录)]7,)-str:LLM 会根据这些描述自动决定何时调用工具、如何传参。四、完整实现代码4.1 创建 Agent 系统classGitWeeklyReportSystem:基于 Microsoft Agent Framework RC6 的 Git 周报生成系统def__init__(self):self._setup_chat_client()def_setup_chat_client(self):设置 OpenAI 兼容的 Chat Clientfromagent_framework.openaiimportOpenAIChatCompletionClient modelos.getenv(OPENAI_CHAT_MODEL)oros.getenv(OPENAI_MODEL,gpt-4o-mini)base_urlos.getenv(OPENAI_BASE_URL)api_keyos.getenv(OPENAI_API_KEY,sk-placeholder)ifbase_url:# 支持本地模型如 Ollama、vLLM 等self.chat_clientOpenAIChatCompletionClient(modelmodel,base_urlbase_url,api_keyapi_key)else:# 使用 OpenAI 官方 APIself.chat_clientOpenAIChatCompletionClient(modelmodel,api_keyapi_key)关键点说明使用OpenAIChatCompletionClientChat Completions API而非OpenAIChatClientResponses API这样可以兼容本地模型Ollama、vLLM、LocalAI 等通过环境变量灵活配置模型端点4.2 创建 Agent 实例asyncdefgenerate_report(self,repo_path:str.,days:int7)-str:fromagent_frameworkimportAgent# 创建周报专家 Agent配备工具report_agentAgent(nameReport_Specialist,clientself.chat_client,instructions你是一个擅长写周报的职场专家。 你的任务是将原始的代码提交记录转化为一份结构清晰、语言专业的周报。 要求 1. 将提交记录分类为【新功能开发】、【问题修复与优化】、【常规维护】三大类 2. 将口语化的提交记录转化为专业描述 3. 突出工作价值和成果使用主动语态 4. 使用 Markdown 格式输出,tools[get_git_commit_logs,get_git_stats],)# 构建任务提示task_promptf请帮我生成一份专业的周报 1. 获取仓库 {repo_path} 过去{days}天的提交记录 2. 获取统计数据 请调用工具获取数据后合成 Markdown 格式周报。resultawaitself._run_agent(report_agent,task_prompt)returnresultAgent 创建要点name: Agent 名称用于识别client: LLM 客户端实例instructions: Agent 的角色定义和行为准则tools: 可调用的工具函数列表4.3 流式输出实现asyncdef_run_agent(self,agent,prompt:str)-str:运行 Agent 并流式打印输出chunks:list[str][]asyncforupdateinagent.run(prompt,streamTrue):ifhasattr(update,text)andupdate.text:chunks.append(update.text)print(update.text,end,flushTrue)# 实时输出return.join(chunks)流式输出的好处用户可以看到生成过程体验更流畅避免长时间等待无响应便于调试和观察 Agent 思考过程4.4 交互式运行模式asyncdefinteractive_mode(self):交互式运行模式print(Git 周报生成系统 (Microsoft Agent Framework RC6))whileTrue:print(\n请选择操作)print( 1. 生成周报默认当前目录过去 7 天)print( 2. 自定义参数生成周报)print( 3. 退出)choiceinput(请输入选项: ).strip()ifchoice1:reportawaitself.generate_report()self._save_report(report)elifchoice2:repo_pathinput(仓库路径: )or.daysint(input(天数: )or7)reportawaitself.generate_report(repo_path,days)self._save_report(report)五、配置与使用5.1 环境变量配置创建.env文件# 方式一使用 OpenAI 官方 API OPENAI_API_KEYsk-your-api-key OPENAI_MODELgpt-4o-mini # 方式二使用本地模型Ollama OPENAI_BASE_URLhttp://localhost:11434/v1 OPENAI_MODELqwen2.5:7b OPENAI_API_KEYollama # Ollama 不需要真实 key # 方式三使用其他兼容服务如 DeepSeek、Moonshot 等 OPENAI_BASE_URLhttps://api.deepseek.com/v1 OPENAI_API_KEYsk-your-deepseek-key OPENAI_MODELdeepseek-chat5.2 运行程序python git_weekly_report_agent.py输出示例 Git 周报生成系统 - 配置检查 使用 OpenAI 兼容模型端点 端点: http://localhost:11434/v1 模型: qwen2.5:7b 请选择操作 1. 生成周报默认当前目录过去 7 天 2. 自定义参数生成周报 3. 退出 请输入选项 (1/2/3): 1 正在生成周报... # 本周工作总结 ## 工作摘要 本周主要完成了用户认证模块的开发工作修复了若干系统稳定性问题 并进行了代码结构优化和文档更新。整体提升了系统的安全性和可维护性。 ## 【新功能开发】 - 完成了用户登录认证模块的开发与测试工作 - 实现了 JWT 令牌生成与验证机制 - 新增了用户权限管理功能 ## 【问题修复与优化】 - 修复了系统运行过程中的异常问题提升了稳定性 - 优化了数据库查询性能响应时间缩短 30% - 解决了前端页面渲染闪烁问题 ## 【常规维护】 - 更新了项目技术文档补充了关键接口说明 - 清理了冗余代码提升了可维护性 - 配置了开发环境依赖项 ## 数据统计 - 提交次数: 12 - 新增行数: 856 - 删除行数: 234 - 变更文件数: 15 周报已保存至: reports/weekly_report_20260403_143052.md六、技术亮点解析6.1 工具自动注册框架会自动将 Python 函数转换为 Agent 可调用的工具tools[get_git_commit_logs,get_git_stats]LLM 根据函数签名、参数类型和 Field 描述自动决定是否需要调用工具调用哪个工具如何传递参数6.2 编码问题处理Windows 环境下 Git 命令可能返回 GBK 编码代码做了兼容处理resultsubprocess.run(cmd,capture_outputTrue,textTrue,encodingutf-8,errorsreplace,# 非法字符替换而非报错)输出时也处理了 GBK 编码问题try:print(update.text,end,flushTrue)exceptUnicodeEncodeError:safe_textupdate.text.encode(gbk,errorsreplace).decode(gbk)print(safe_text,end,flushTrue)6.3 模型兼容性使用OpenAIChatCompletionClient而非OpenAIChatClient客户端类型API 类型兼容性OpenAIChatClientResponses API仅 OpenAI 官方OpenAIChatCompletionClientChat Completions API兼容所有 OpenAI 兼容服务这样可以使用OpenAI GPT 系列Ollama 本地模型vLLM、LocalAI 等推理服务DeepSeek、Moonshot、Qwen 等 API 服务七、扩展思路7.1 添加更多工具可以扩展更多 Git 分析工具defget_branch_info(repo_path:str.)-str:获取分支信息defget_code_review_suggestions(repo_path:str.,days:int7)-str:分析代码变更并给出改进建议defget_issue_links(repo_path:str.)-str:从提交信息中提取关联的 Issue/PR 编号7.2 多 Agent 协作可以引入多个 Agent 进行协作data_collectorAgent(nameData_Collector,tools[get_git_logs,get_stats,get_branch_info],instructions负责收集和整理 Git 数据,)report_writerAgent(nameReport_Writer,instructions负责将数据转化为专业周报,)# Data_Collector 收集数据 → Report_Writer 撰写周报7.3 接入企业系统定时任务自动生成周报并发送邮件集成到钉钉/飞书/企业微信与 Jira、GitLab 等平台对接八、总结Microsoft Agent Framework RC6 提供了一个简洁高效的 Agent 开发范式定义工具函数使用Annotated Field描述参数创建 Agent配置 client、instructions 和 tools运行 Agent调用agent.run()执行任务整个 Git 周报生成工具仅 300 行代码却实现了自动获取 Git 数据智能转化专业周报流式输出实时展示本地模型兼容交互式用户体验这正是 Agent 开发的魅力所在——让 AI 真正成为可编程的智能助手。相关资源Microsoft Agent Framework: https://github.com/microsoft/agent-framework完整代码: https://github.com/loveStudyWjj/git_weekly_report_agentOllama 本地模型: https://ollama.ai如果觉得有帮助欢迎点赞收藏有问题欢迎评论区讨论