Zhiwen Assistant MCP

# 智文助手部署与使用指南 ## 🎯 如何将你的智文助手分享给他人使用 ### 📋 前置条件 - Python 3.8+ 环境 - 已安装mcp包：`pip install mcp` - 具备基本的命令行操作能力 --- ## 🚀 **方法一：完整项目分发（推荐）** ### 步骤1：准备分发包 ```bash # 创建分发文件夹 mkdir MCP分发包 cd MCP分发包 # 复制核心文件 cp "e:/skills技能/我的MCP服务器/folder_documentation_mcp.py" ./ cp "e:/skills技能/我的MCP服务器/README.md" ./ # 创建安装脚本 ``` ### 步骤2：创建安装脚本 创建 `install.py`： ```python #!/usr/bin/env python3 """ MCP服务器自动安装脚本 """ import os import sys import subprocess import json def check_python_version(): """检查Python版本""" if sys.version_info < (3, 8): print("❌ 错误：需要Python 3.8或更高版本") sys.exit(1) print(f"✅ Python版本检查通过：{sys.version}") def install_dependencies(): """安装依赖包""" try: print("📦 正在安装MCP依赖...") subprocess.check_call([sys.executable, "-m", "pip", "install", "mcp", "pydantic"]) print("✅ 依赖安装完成") except subprocess.CalledProcessError: print("❌ 依赖安装失败") sys.exit(1) def create_config(): """创建MCP配置文件""" config = { "mcpServers": { "Folder Documentation MCP": { "command": "python", "args": [os.path.abspath("folder_documentation_mcp.py")], "type": "stdio", "disabled": False } } } config_path = "mcp_config.json" with open(config_path, "w", encoding="utf-8") as f: json.dump(config, f, indent=2, ensure_ascii=False) print(f"✅ 配置文件已创建：{config_path}") return config_path def main(): """主函数""" print("🚀 开始安装文件夹文档生成MCP服务器...") print("=" * 50) check_python_version() install_dependencies() config_path = create_config() print("=" * 50) print("🎉 安装完成！") print("\n📖 使用方法：") print(f"1. 将配置文件 {config_path} 添加到你的MCP客户端") print("2. 启动MCP客户端即可开始使用") if __name__ == "__main__": main() ``` ### 步骤3：创建用户使用手册 创建 `用户手册.md`： ```markdown # 文件夹文档生成MCP - 用户手册 ## 快速开始 ### 1. 运行安装脚本 ```bash python install.py ``` ### 2. 配置MCP客户端 将生成的 `mcp_config.json` 配置添加到你的MCP客户端中。 ### 3. 开始使用 重启MCP客户端，即可使用以下功能： - 生成项目README文件 - 创建项目结构思维导图 - 更新现有文档 ## 常见问题 ### Q: 如何指定要处理的文件夹？ A: 在MCP客户端中调用相应工具时，传入文件夹路径参数。 ### Q: 可以自定义排除的文件夹吗？ A: 可以，在调用工具时传入 `exclude_dirs` 参数。 ### Q: 如何强制更新现有README文件？ A: 将 `force_update` 参数设置为 `true`。 ``` --- ## 🌐 **方法二：PyPI包发布** ### 步骤1：创建包结构 ``` folder-docs-mcp/ ├── setup.py ├── README.md ├── requirements.txt └── folder_docs_mcp/ ├── __init__.py └── server.py ``` ### 步骤2：创建setup.py ```python from setuptools import setup, find_packages setup( name="folder-docs-mcp", version="1.0.0", description="MCP服务器：文件夹中文说明文件生成器", author="你的名字", author_email="你的邮箱", packages=find_packages(), install_requires=[ "mcp>=1.0.0", "pydantic>=2.0.0" ], entry_points={ "console_scripts": [ "folder-docs-mcp=folder_docs_mcp.server:main", ], }, python_requires=">=3.8", classifiers=[ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", ], ) ``` ### 步骤3：发布到PyPI ```bash # 构建包 python setup.py sdist bdist_wheel # 发布到测试PyPI twine upload --repository testpypi dist/* # 发布到正式PyPI twine upload dist/* ``` ### 步骤4：用户安装使用 ```bash # 安装 pip install folder-docs-mcp # 运行 folder-docs-mcp # 或者在MCP配置中： { "mcpServers": { "folder-docs-mcp": { "command": "folder-docs-mcp", "type": "stdio" } } } ``` --- ## 🐳 **方法三：Docker容器分发** ### 步骤1：创建Dockerfile ```dockerfile FROM python:3.11-slim WORKDIR /app # 安装依赖 RUN pip install mcp pydantic # 复制服务器文件 COPY folder_documentation_mcp.py . # 设置入口点 ENTRYPOINT ["python", "folder_documentation_mcp.py"] ``` ### 步骤2：构建和发布 ```bash # 构建镜像 docker build -t folder-docs-mcp . # 发布到Docker Hub docker tag folder-docs-mcp yourusername/folder-docs-mcp docker push yourusername/folder-docs-mcp ``` ### 步骤3：用户使用 ```bash # 拉取镜像 docker pull yourusername/folder-docs-mcp # 运行容器 docker run -v /path/to/project:/project yourusername/folder-docs-mcp # MCP配置 { "mcpServers": { "folder-docs-mcp": { "command": "docker", "args": ["run", "-v", "${projectPath}:/project", "yourusername/folder-docs-mcp"], "type": "stdio" } } } ``` --- ## 🔧 **方法四：GitHub源码分发** ### 步骤1：创建GitHub仓库 ```bash git init git add . git commit -m "Initial commit: 文件夹文档生成MCP服务器" git branch -M main git remote add origin https://github.com/你的username/folder-docs-mcp.git git push -u origin main ``` ### 步骤2：创建完整的项目README ```markdown # 文件夹文档生成MCP服务器 [](https://python.org) [](LICENSE) ## 功能特点 - 🇨🇳 为项目文件夹自动生成中文README文档 - 📊 创建项目结构思维导图 - 🔄 支持批量更新和增量处理 - ⚙️ 可自定义排除目录和模板 ## 快速开始 ### 安装依赖 ```bash pip install mcp pydantic ``` ### 下载服务器 ```bash git clone https://github.com/你的username/folder-docs-mcp.git cd folder-docs-mcp ``` ### 配置MCP客户端 将以下配置添加到你的MCP客户端： ```json { "mcpServers": { "folder-docs-mcp": { "command": "python", "args": ["folder_documentation_mcp.py"], "type": "stdio" } } } ``` ## 使用方法 详细使用方法请参考 [用户手册](用户手册.md) ## 贡献 欢迎提交Issue和Pull Request！ ``` --- ## 🎯 **推荐分发策略** ### 🔥 **对于普通用户**：使用方法一（完整项目分发） - 安装简单，一键部署 - 包含完整的使用文档 - 适合非技术用户 ### ⚡ **对于开发者**：使用方法二（PyPI包发布） - 标准的Python包管理 - 易于集成到现有项目 - 支持版本管理 ### 🌐 **对于企业用户**：使用方法三（Docker容器分发） - 环境隔离，部署简单 - 支持跨平台使用 - 便于CI/CD集成 ### 🔧 **对于技术用户**：使用方法四（GitHub源码分发） - 完全透明，可自定义修改 - 适合技术社区贡献 - 支持实时更新 --- ## 📞 技术支持 1. **问题反馈**：通过GitHub Issues提交问题 2. **使用咨询**：创建讨论区或QQ群 3. **文档更新**：定期更新使用文档和FAQ ## 🔄 版本管理 - **主版本**：重大功能更新（1.0.0 → 2.0.0） - **次版本**：新功能添加（1.0.0 → 1.1.0） - **修订版本**：Bug修复（1.0.0 → 1.0.1） 通过以上方法，你的MCP服务器可以轻松分享给其他用户使用！