FileScopeMCP

🚀 MCP（多语言组件协议）服务器文档

这是一个 MCP（多语言组件协议）服务器的文档，该服务器用于分析项目文件并生成图表。以下是其功能和使用说明。

✨ 主要特性

文件树管理工具

• list_saved_trees：列出所有已保存的文件树。
• create_file_tree：为特定目录创建一个新的文件树配置。
• select_file_tree：选择一个现有的文件树进行操作。
• delete_file_tree：删除一个文件树配置。

文件分析工具

• list_files：列出项目中的所有文件及其重要性排名。
• get_file_importance：获取特定文件的详细信息，包括其依赖项和相关文件。
• find_important_files：根据可配置的标准查找项目中最重要的文件。
• read_file_content：读取特定文件的内容。
• recalculate_importance：重新计算所有文件的重要值，基于它们的依赖关系。

文件摘要工具

• get_file_summary：获取特定文件的存储摘要。
• set_file_summary：设置或更新特定文件的摘要。

文件监控工具

• toggle_file_watching：启用或禁用文件监控功能。
• get_file_watching_status：获取当前文件监控状态。
• update_file_watching_config：更新文件监控配置。

图表生成工具

• generate_diagram：根据自定义选项生成图表：
  • 输出格式：Mermaid 文本（.mmd）或 HTML 嵌入式渲染。
  • 图表样式：默认、依赖关系、目录或混合视图。
  • 过滤选项：最大深度、最低重要性阈值。
  • 布局选项：方向（TB、BT、LR、RL）、节点间距、排名间距。

📦 安装指南

文档未提及安装步骤，故跳过。

💻 使用示例

基础用法

分析项目

1. 创建一个项目的文件树：

create_file_tree(filename: "my-project.json", baseDirectory: "/path/to/project")

2. 找到最重要的文件：

find_important_files(limit: 5, minImportance: 5)

3. 获取特定文件的详细信息：

get_file_importance(filepath: "/path/to/project/src/main.ts")

操作摘要

1. 读取文件内容以理解它：

read_file_content(filepath: "/path/to/project/src/main.ts")

2. 添加文件摘要：

set_file_summary(filepath: "/path/to/project/src/main.ts", summary: "主入口点，初始化应用程序、设置路由并启动服务器。")

3. 后续获取摘要：

get_file_summary(filepath: "/path/to/project/src/main.ts")

生成图表

1. 创建基本项目结构图：

generate_diagram(style: "directory", maxDepth: 3, outputPath: "diagrams/project-structure", outputFormat: "mmd")

2. 生成包含依赖关系的 HTML 图表：

generate_diagram(style: "hybrid", maxDepth: 2, minImportance: 5, showDependencies: true, outputPath: "diagrams/important-files", outputFormat: "html")

3. 自定义图表布局：

generate_diagram(style: "dependency", layout: { direction: "TB", nodeSpacing: 20, rankSpacing: 15 }, outputPath: "diagrams/custom-layout", outputFormat: "html")

🔧 技术细节

文档未提及技术实现细节，故跳过。

📄 许可证

本项目的代码和相关资源受 MIT 许可证的约束。详细内容请参考项目根目录下的 LICENSE 文件。