Zhiwen Assistant MCP

# 📝 智文助手 [](https://python.org) [](LICENSE) [](https://modelcontextprotocol.io) 一个专为中文项目设计的MCP服务器，能够自动为项目文件夹生成中文README文档和思维导图。 ## ✨ 功能特点 - 🇨🇳 **完全中文化**：专为中文项目设计，符合中文使用习惯 - 📊 **可视化思维导图**：自动生成项目结构的Mermaid思维导图 - 🔄 **批量处理**：支持一键更新整个项目的文档 - ⚙️ **高度可定制**：支持自定义排除目录和模板 - 🚀 **易于部署**：提供一键安装脚本，开箱即用 ## 🚀 快速开始 ### 一键安装 ```bash python install.py ``` ### 配置MCP客户端 将生成的 `mcp_config.json` 配置添加到你的MCP客户端中。 ### 开始使用 重启MCP客户端，即可使用所有功能！ ## 📋 系统要求 - Python 3.8 或更高版本 - Windows/Linux/macOS 操作系统 - 支持MCP协议的客户端 ## 🛠️ 主要功能 ### 📝 自动生成README文档 为项目中的每个文件夹自动生成包含以下内容的中文README： - 文件夹用途说明 - 子文件夹列表和描述 - 文件类型说明 - 更新时间记录 ### 📊 生成思维导图 创建项目结构的可视化思维导图： - Mermaid格式，支持多种查看器 - 多层级结构展示 - 清晰的依赖关系 ### 🔄 批量更新文档 一键更新整个项目的文档： - 智能检测变更 - 保留自定义内容 - 增量更新机制 ## 📖 使用示例 ### 基本使用 ```json { "root_dir": "/path/to/your/project", "exclude_dirs": ["node_modules", "build"], "force_update": true } ``` ### 高级配置 ```json { "root_dir": "/path/to/your/project", "output_file": "项目结构图.md", "exclude_dirs": ["temp", "cache", "logs"], "update_mindmap": true } ``` ## 📁 文件结构 ``` MCP分发包/ ├── install.py # 一键安装脚本 ├── folder_documentation_mcp.py # MCP服务器主程序 ├── README.md # 项目说明文档 ├── 用户手册.md # 详细使用手册 ├── 快速开始指南.md # 快速入门指南（安装后生成） └── mcp_config.json # MCP配置文件（安装后生成） ``` ## 🔧 安装详细步骤 ### 1. 环境准备 确保已安装Python 3.8+： ```bash python --version ``` ### 2. 下载MCP服务器 ```bash # 如果使用Git git clone <repository-url> cd folder-docs-mcp # 或直接下载压缩包解压 ``` ### 3. 运行安装脚本 ```bash python install.py ``` 安装脚本会自动： - 检查Python版本 - 安装必要的依赖包 - 创建MCP配置文件 - 验证安装结果 ### 4. 配置MCP客户端 将生成的 `mcp_config.json` 内容添加到你的MCP客户端配置中。 ## 🎯 适用场景 - **项目管理**：为项目结构提供清晰的中文文档 - **团队协作**：统一团队的文档标准和格式 - **代码交接**：快速了解项目结构和文件用途 - **开源项目**：为中文用户提供友好的项目文档 ## 🛠️ 故障排除 ### 常见问题 **Q: Python版本不兼容** A: 请升级到Python 3.8或更高版本 **Q: 依赖包安装失败** A: 尝试使用国内镜像源： ```bash pip install -i https://pypi.tuna.tsinghua.edu.cn/simple/ mcp pydantic ``` **Q: MCP客户端无法识别服务器** A: 检查配置文件格式和文件路径是否正确 ## 📞 技术支持 - 📖 **详细文档**：查看 `用户手册.md` 获取完整使用指南 - 🐛 **问题反馈**：通过GitHub Issues提交问题 - 💬 **社区支持**：加入技术讨论群组 ## 🔄 版本历史 - **v1.0.0** (2025-12-17)：初始版本发布 - 基本的README生成功能 - 思维导图生成 - 批量更新功能 ## 🤝 贡献指南 欢迎提交Issue和Pull Request！ 1. Fork本项目 2. 创建功能分支 3. 提交更改 4. 发起Pull Request ## 📄 许可证 本项目采用MIT许可证，详见[LICENSE](LICENSE)文件。 ## 🌟 致谢 感谢所有为中文项目文档标准化做出贡献的开发者！ --- *让中文项目文档管理变得简单高效！* 🚀