Zhiwen Assistant MCP

# 智文助手 (Zhiwen Assistant) [](https://python.org) [](LICENSE) [](https://modelcontextprotocol.io) 🚀 **智能文档生成工具** - 自动为项目文件夹生成中文README和思维导图 基于MCP协议，支持多层级嵌套结构，让文档管理变得轻松高效。 ## ✨ 功能特点 - 🇨🇳 **完全中文化** - 符合中文用户使用习惯 - 🔄 **自动化生成** - 基于文件夹结构自动生成README文档 - 🧠 **思维导图** - 自动生成项目结构思维导图 - 📊 **批量更新** - 支持批量更新项目文档 - ⚙️ **配置管理** - 支持YAML/JSON配置文件 - 🔒 **安全验证** - 路径验证、敏感信息检测 - 📈 **性能优化** - 缓存系统、异步处理 ## 🛠️ 技术栈 - **核心框架**: Python 3.8+ - **MCP协议**: FastMCP框架 - **配置管理**: PyYAML - **数据验证**: Pydantic - **缓存系统**: 内置缓存机制 ## 🚀 快速开始 ### 环境要求 - Python 3.8 或更高版本 - 操作系统: Windows, macOS, Linux ### 安装 1. **克隆仓库** ```bash git clone https://github.com/kscz0000/Zhiwen-Assistant-MCP.git cd Zhiwen-Assistant-MCP ``` 2. **安装依赖** ```bash pip install -r requirements.txt ``` 3. **运行服务器** ```bash python folder_documentation_mcp.py ``` ### 基础使用 1. **生成README文档** ```python # 使用MCP工具调用 generate_readme_files({ "root_dir": "/path/to/your/project", "exclude_dirs": [".git", "__pycache__"], "force_update": False }) ``` 2. **生成思维导图** ```python # 使用MCP工具调用 generate_mindmap({ "root_dir": "/path/to/your/project", "output_file": "structure_mindmap.md", "exclude_dirs": [".git", "__pycache__"] }) ``` ## 📖 详细文档 - [安装指南](docs/INSTALL.md) - 详细的安装和配置说明 - [使用指南](docs/USAGE.md) - 完整的功能使用说明 - [API文档](docs/API.md) - 详细的API接口文档 - [配置说明](docs/CONFIGURATION.md) - 配置选项详细说明 ## 🏗️ 项目结构 ``` 智文助手/ ├── folder_documentation_mcp.py # 核心主程序 ├── enhanced_folder_docs_mcp.py # 增强版服务器 ├── mcp_config.yaml # 配置文件 ├── config/ # 配置模块 ├── security/ # 安全验证模块 ├── monitoring/ # 监控模块 ├── MCP分发包/ # 分发包 └── 优化版本/ # 优化版本 ``` ## 🤝 贡献指南 我们欢迎所有形式的贡献！请查看 [贡献指南](CONTRIBUTING.md) 了解详细信息。 ### 开发环境搭建 1. **Fork 项目** 2. **创建功能分支** ```bash git checkout -b feature/amazing-feature ``` 3. **提交更改** ```bash git commit -m 'Add some amazing feature' ``` 4. **推送分支** ```bash git push origin feature/amazing-feature ``` 5. **创建 Pull Request** ## 📝 更新日志 ### v2.0.0 (2025-12-19) - ✨ 新增增强版服务器 - 🔒 集成安全验证模块 - 📊 添加性能监控 - ⚙️ 完善配置管理 - 🧠 优化思维导图生成 ### v1.0.0 (2025-12-17) - 🎉 初始版本发布 - 📝 基础文档生成功能 - 🧠 思维导图生成 ## 📄 许可证 本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。 ## 🙋‍♂️ 支持 如果您有任何问题或建议，请： - 创建 [Issue](https://github.com/kscz0000/Zhiwen-Assistant-MCP/issues) - 发送邮件到：[your-email@example.com] ## 🌟 致谢 感谢所有为这个项目做出贡献的开发者！ --- <div align="center"> <p>用 ❤️ 和 ☕ 制作</p> <p>© 2025 智文助手团队</p> </div>