Filescope

🚀 文件作用域

本MCP（多协议通信）服务器专注于分析和管理项目中的文件及其依赖关系。它能助力开发者迅速掌握项目结构、关键文件及其相互联系，还具备生成图表、设置文件摘要等实用功能。

🚀 快速开始

此MCP服务器为开发者提供了强大的文件管理与分析能力，通过一系列功能模块和工具示例，能高效地处理项目文件。接下来将详细介绍其各功能模块和使用示例。

✨ 主要特性

1. 文件树管理

• list_saved_trees：可列出所有已保存的文件树配置。
• create_file_tree：能创建新的文件树配置，用于指定目录的分析。
• select_file_tree：可选择已有的文件树配置进行操作。
• delete_file_tree：能够删除某个文件树配置。

2. 文件分析

• list_files：列出项目中的所有文件及其重要性评分。
• get_file_importance：获取指定文件的详细信息，涵盖其依赖项和被依赖项。
• find_important_files：依据设定标准筛选最重要的文件。
• read_file_content：读取特定文件的内容。
• recalculate_importance：重新计算所有文件的重要性评分。

3. 文件摘要

• get_file_summary：获取指定文件的存储摘要信息。
• set_file_summary：设置或更新某个文件的摘要信息。

4. 文件监控

• toggle_file_watching：开启或关闭文件自动监控功能。
• get_file_watching_status：查看当前文件监控状态。
• update_file_watching_config：修改文件监控的相关配置参数。

5. 图表生成

• generate_diagram：根据需求生成不同样式的图表，支持输出为文本或HTML格式。
• 支持的图表样式包括：默认、依赖关系、目录结构或混合视图。
• 提供深度限制、最小重要性阈值等过滤选项。
• 允许自定义布局参数。

💻 使用示例

分析项目

基础用法

创建一个文件树配置：

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

高级用法

查找最重要的5个文件：

find_important_files(limit: 5, minImportance: 5)

获取某个文件的详细信息：

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

使用文件摘要

基础用法

阅读文件内容：

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

高级用法

添加文件摘要：

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

获取文件摘要信息：

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

生成图表

基础用法

创建项目结构图：

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

高级用法

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

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

自定义布局参数：

generate_diagram(style: "dependency", layout: { direction: "LR", nodeSpacing: 50, rankSpacing: 70 }, outputPath: "diagrams/dependencies", outputFormat: "html")

文件监控

基础用法

开启文件自动监控：

toggle_file_watching(enabled: true)

高级用法

更新监控配置：

update_file_watching_config(interval: 60, ignorePatterns: ["node_modules/**", "*.md"])

📚 详细文档

未来改进方向

• 支持更多编程语言和文件类型。
• 增加文件间关系的可视化功能。
• 提供基于重要性的代码片段提取功能。
• 开发UI界面以便更直观地查看文件结构和依赖关系。

📄 许可证

本项目遵循MIT开源协议，允许用户自由使用、修改和分发代码。