Filescope

🚀 File Scope

The MCP (Multi-Protocol Communication) server is primarily used to analyze and manage files and their dependencies in a project. It helps developers quickly understand the project structure, important files, and their relationships, and provides functions such as generating diagrams and setting file summaries.

🚀 Quick Start

✨ Features

1. File Tree Management

• list_saved_trees: List all saved file tree configurations.
• create_file_tree: Create a new file tree configuration for directory analysis.
• select_file_tree: Select an existing file tree configuration for operations.
• delete_file_tree: Delete a specific file tree configuration.

2. File Analysis

• list_files: List all files in the project and their importance scores.
• get_file_importance: Get detailed information about a specified file, including its dependencies and dependents.
• find_important_files: Filter the most important files according to set criteria.
• read_file_content: Read the content of a specific file.
• recalculate_importance: Recalculate the importance scores of all files.

3. File Summary

• get_file_summary: Get the stored summary information of a specified file.
• set_file_summary: Set or update the summary information of a file.

4. File Monitoring

• toggle_file_watching: Turn on or off the automatic file monitoring function.
• get_file_watching_status: Check the current file monitoring status.
• update_file_watching_config: Modify the relevant configuration parameters of file monitoring.

5. Diagram Generation

• generate_diagram: Generate different styles of diagrams as required, supporting output in text or HTML format.
• Supported diagram styles include: default, dependency relationship, directory structure, or mixed view.
• Provide filtering options such as depth limit and minimum importance threshold.
• Allow custom layout parameters.

💻 Usage Examples

Analyze the Project

1. Create a file tree configuration:

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

2. Find the top 5 most important files:

   find_important_files(limit: 5, minImportance: 5)
   

3. Get detailed information about a file:

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

Use File Summaries

1. Read file content:

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

2. Add a file summary:

   set_file_summary(filepath: "/path/to/project/src/main.ts", summary: "Main entry point, responsible for initializing the application, setting up routes, and starting the server.")
   

3. Get file summary information:

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

Generate Diagrams

1. Create a project structure diagram:

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

2. Generate an HTML diagram with dependency relationships:

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

3. Customize layout parameters:

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

File Monitoring

1. Turn on automatic file monitoring:

   toggle_file_watching(enabled: true)
   

2. Update monitoring configuration:

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

📚 Documentation

Future Improvements

• Support more programming languages and file types.
• Add visualization functions for file relationships.
• Provide code snippet extraction based on importance.
• Develop a UI interface for more intuitive viewing of file structures and dependencies.

📄 License

This project follows the MIT open-source license, allowing users to freely use, modify, and distribute the code.