智文助手 (Zhiwen Assistant)

🚀 智能文档生成工具 - 自动为项目文件夹生成中文README和思维导图

基于MCP协议，支持多层级嵌套结构，让文档管理变得轻松高效。

✨ 功能特点

• 🇨🇳 完全中文化 - 符合中文用户使用习惯
• 🔄 自动化生成 - 基于文件夹结构自动生成README文档
• 🧠 思维导图 - 自动生成项目结构思维导图
• 📊 批量更新 - 支持批量更新项目文档
• ⚙️ 配置管理 - 支持YAML/JSON配置文件
• 🔒 安全验证 - 路径验证、敏感信息检测
• 📈 性能优化 - 缓存系统、异步处理

🛠️ 技术栈

• 核心框架: Python 3.8+
• MCP协议: FastMCP框架
• 配置管理: PyYAML
• 数据验证: Pydantic
• 缓存系统: 内置缓存机制

🚀 快速开始

环境要求

• Python 3.8 或更高版本
• 操作系统: Windows, macOS, Linux

安装

1. 克隆仓库

   git clone https://github.com/kscz0000/Zhiwen-Assistant-MCP.git
   cd Zhiwen-Assistant-MCP
   

2. 安装依赖

   pip install -r requirements.txt
   

3. 环境变量配置（可选）

   # 复制示例文件
   cp .env.example .env
   
   # 根据需要编辑配置
   nano .env
   

MCP 配置

智文助手支持多种AI编辑器的MCP协议集成。请根据您使用的编辑器选择相应的配置：

1. Cursor 编辑器配置

1. 打开 Cursor，进入设置
2. 复制 config/cursor-mcp.json 中的配置
3. 将 {PATH_TO_ZHIWEN_ASSISTANT} 替换为实际的项目路径
4. 将配置添加到 Cursor 的 MCP 服务器设置中

2. Windsurf 编辑器配置

1. 打开 Windsurf，进入设置
2. 复制 config/windsurf-mcp.json 中的配置
3. 将 {PATH_TO_ZHIWEN_ASSISTANT} 替换为实际的项目路径
4. 将配置添加到 Windsurf 的 MCP 服务器设置中

3. Claude Desktop 配置

1. 打开 Claude Desktop 的配置文件 (通常在 ~/Library/Application Support/Claude/claude_desktop_config.json)
2. 复制 config/claude-desktop-mcp.json 中的配置
3. 将 {PATH_TO_ZHIWEN_ASSISTANT} 替换为实际的项目路径
4. 将配置添加到 mcpServers 部分

4. 通用 MCP 配置

使用 config/mcp-config.json 作为参考配置，根据您的MCP客户端进行调整。

启动智文助手

# 启动MCP服务器模式
python run.py server

# 或直接作为CLI工具使用
python run.py generate ./your-project-path

基础使用

1. 生成README文档

   # 使用MCP工具调用
   generate_readme_files({
       "root_dir": "/path/to/your/project",
       "exclude_dirs": [".git", "__pycache__"],
       "force_update": False
   })
   

2. 生成思维导图

   # 使用MCP工具调用
   generate_mindmap({
       "root_dir": "/path/to/your/project",
       "output_file": "structure_mindmap.md",
       "exclude_dirs": [".git", "__pycache__"]
   })
   

📖 详细文档

• 安装指南 - 详细的安装和配置说明
• 使用指南 - 完整的功能使用说明
• API文档 - 详细的API接口文档
• MCP配置指南 - 详细的MCP配置和集成说明
• 配置说明 - 配置选项详细说明

🏗️ 项目结构

智文助手/
├── run.py                    # 入口点
├── src/                      # 源代码目录
├── config/                   # 配置文件和模板
│   ├── mcp-config.json       # 通用MCP配置示例
│   ├── cursor-mcp.json        # Cursor编辑器配置
│   ├── windsurf-mcp.json      # Windsurf编辑器配置
│   └── claude-desktop-mcp.json # Claude Desktop配置
├── deploy/                   # 部署相关文件
├── docs/                     # 文档目录
│   ├── MCP配置指南.md        # 详细MCP配置指南
│   └── ...                   # 其他文档
├── scripts/                  # 脚本目录
├── tests/                    # 测试目录
├── archive/                  # 归档目录
├── .env.example              # 环境变量配置示例
└── requirements.txt           # 依赖列表

🤝 贡献指南

我们欢迎所有形式的贡献！请查看 贡献指南 了解详细信息。

开发环境搭建

1. Fork 项目
2. 创建功能分支

   git checkout -b feature/amazing-feature
   

3. 提交更改

   git commit -m 'Add some amazing feature'
   

4. 推送分支

   git push origin feature/amazing-feature
   

5. 创建 Pull Request

📝 更新日志

v2.0.0 (2025-12-19)

• ✨ 新增增强版服务器
• 🔒 集成安全验证模块
• 📊 添加性能监控
• ⚙️ 完善配置管理
• 🧠 优化思维导图生成
• 🗂️ 重构项目目录结构

v1.0.0 (2025-12-17)

• 🎉 初始版本发布
• 📝 基础文档生成功能
• 🧠 思维导图生成

📄 许可证

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情。

🙋‍♂️ 支持

如果您有任何问题或建议，请：

• 创建 Issue
• 发送邮件到：byilb3619b@gmail.com
• QQ邮箱：1715635335@qq.com
• 微信公众号：ASI-CN

🌟 致谢

感谢所有为这个项目做出贡献的开发者！

---

<div align="center"> <p>用 ❤️ 和 ☕ 制作</p> <p>© 2025 智文助手团队</p> </div>