# 智文助手详细说明
## 创建信息
- **创建者**: 用户自主开发
- **创建日期**: 2025年12月17日 15:25
- **项目性质**: 原创智文助手
## 服务器概述
**服务器名称**: zhiwen_assistant
**主要功能**: 为项目中的每个主要文件夹添加中文说明文件和思维导图
**技术栈**: Python + FastMCP框架
## 功能特点
### 1. 中文README文档生成
- 为项目中的每个主要文件夹自动生成中文README.md文件
- 包含该文件夹的中文功能说明及内部文件简要描述
- 支持强制更新现有README.md文件
### 2. 项目结构思维导图
- 生成项目文件夹结构的思维导图
- 支持多层嵌套结构展示
- 便于理解项目层级关系
### 3. 文档更新管理
- 支持批量更新项目文档
- 自动标注时间,便于追踪变更
- 内容准确、易懂,符合中文表达习惯
## 技术实现
### 核心依赖
```python
from mcp.server.fastmcp import FastMCP
from pydantic import BaseModel, Field
from typing import Optional, List, Dict, Any
import os
import datetime
import json
```
### 主要工具函数
1. **generate_readme_files** - 生成README.md文件
2. **generate_mindmap** - 生成思维导图
3. **update_documentation** - 更新文档
### 输入模型
- **GenerateReadmeInput**: 生成README.md文件输入模型
- **GenerateMindmapInput**: 生成思维导图输入模型
- **UpdateDocumentationInput**: 更新文档输入模型
## 文件位置
- **主要位置**: `E:/MCP/folder_documentation_mcp.py`
- **备份位置**: `e:/skills技能/folder_documentation_mcp.py`
- **创建时间**: 2025/12/17 15:25:22
## 符合的用户规范
根据用户设定的项目规范,该MCP服务器严格遵循:
1. ✅ **中文命名**: 所有文件夹名称使用中文命名
2. ✅ **功能说明**: 在每个主要文件夹中创建 README.md 文件
3. ✅ **思维导图**: 为多层嵌套结构制作思维导图展示层级关系
4. ✅ **时间标注**: 所有说明文件和图表中新增内容标注时间
5. ✅ **准确易懂**: 说明内容准确、易懂,符合中文表达习惯
6. ✅ **及时更新**: 结构调整时更新对应说明文档和思维导图
## 使用场景
1. **项目初始化**: 为新项目快速生成文档结构
2. **文档维护**: 保持项目文档与代码同步更新
3. **团队协作**: 提供统一的中文文档标准
4. **项目交接**: 便于新成员理解项目结构
## 优势特点
- 🇨🇳 **完全中文化**: 符合中文用户使用习惯
- 🔧 **自动化程度高**: 减少手工编写文档的工作量
- 📊 **可视化强**: 思维导图清晰展示项目结构
- 🔄 **易于维护**: 支持批量更新和增量更新
- 📝 **标准化**: 统一的文档格式和命名规范
## 技术架构图
```
用户请求 → FastMCP框架 → 文档生成器 → 文件系统
↓
参数验证 → 模型处理 → 内容生成 → 文档写入
↓
错误处理 → 日志记录 → 完成反馈 → 状态返回
```
## 总结
这是用户完全自主开发的MCP服务器,专门用于解决中文项目文档管理问题。该服务器紧密结合用户的项目规范,提供了完整的中文文档生成和管理解决方案,是项目标准化管理的重要工具。