Information
周报系统
周报系统旨在简化周报的创建和管理,这些报告存储在 reports 目录中,并带有时间戳以便于跟踪。
设置
要开始使用周报系统,请按照以下步骤操作:
安装依赖项:
通过运行以下命令确保你拥有所有必要的 Python 包:
pip install -r requirements.txt
运行 MCP 服务器:
启动 MCP 服务器以启用报告创建:
python weekly_report_server.py
使用方法
该系统提供了两种创建周报的方法:
方法 1: 直接使用 Python 脚本
通过执行 create_weekly_report.py 脚本来创建周报:
python create_weekly_report.py
此脚本利用了来自 weekly_report_server.py 的 write_weekly_report 函数来生成报告内容。
方法 2: MCP 工具(需要安装有 Claude 扩展的 VSCode)
利用 VSCode 中的 Claude 扩展与 MCP 服务器功能结合使用:
MCP 配置:
确保 .fastmcp.toml 和 mcp.json 中的 MCP 设置正确配置。
VSCode 扩展配置:
检查扩展设置是否正确,在如下路径中:
~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
配置完成后,可以使用 MCP 服务器中的 write_weekly_report 工具直接在 VSCode 内创建报告。
报告格式
报告存储在 reports 目录下,文件名格式为 weekly_report_YYYYMMDD_HHMMSS.txt。
建议的报告结构如下所示:
Weekly Report - [Date]
Accomplishments:
1. [Accomplishment 1]
2. [Accomplishment 2]
3. [Accomplishment 3]
4. [Accomplishment 4]
Next Steps:
1. [Next Step 1]
2. [Next Step 2]
3. [Next Step 3]
4. [Next Step 4]
项目文件
weekly_report_server.py: 核心服务器文件,定义了 write_weekly_report 函数并设置了 MCP 服务器。
create_weekly_report.py: 一个调用 write_weekly_report 函数生成报告的脚本。
test_weekly_report.py: 用于验证 write_weekly_report 函数的测试脚本。
reports/: 保存所有生成报告的目录。
其他信息
如需进一步的帮助或查询,请参考项目的文档或联系开发团队。