Filescopemcp

🚀 MCP Server for Project Analysis and Diagram Generation

This is a documentation for an MCP (Multi - Component Protocol) server that analyzes project files and generates diagrams. Below are its features and usage instructions.

📂 File Tree Management Tools

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

📄 File Analysis Tools

• list_files: List all files in the project and their importance rankings.
• get_file_importance: Get detailed information about a specific file, including its dependencies and related files.
• find_important_files: Find the most important files in the project based on configurable criteria.
• read_file_content: Read the content of a specific file.
• recalculate_importance: Recalculate the importance values of all files based on their dependencies.

📝 File Summary Tools

• get_file_summary: Get the storage summary of a specific file.
• set_file_summary: Set or update the summary of a specific file.

👀 File Monitoring Tools

• toggle_file_watching: Enable or disable the file monitoring function.
• get_file_watching_status: Get the current file monitoring status.
• update_file_watching_config: Update the file monitoring configuration.

📊 Diagram Generation Tools

• generate_diagram: Generate diagrams according to custom options:
  • Output format: Mermaid text (.mmd) or HTML embedded rendering.
  • Diagram style: Default, dependency, directory, or hybrid view.
  • Filter options: Maximum depth, minimum importance threshold.
  • Layout options: Direction (TB, BT, LR, RL), node spacing, rank spacing.

💻 Usage Examples

Analyze a Project

1. Create a file tree for the project:

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

2. Find the most important files:

   find_important_files(limit: 5, minImportance: 5)
   

3. Get detailed information about a specific file:

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

Operate on Summaries

1. Read the file content to understand it:

   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, initializes the application, sets up routes, and starts the server.")
   

3. Retrieve the summary later:

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

Generate Diagrams

1. Create a basic project structure diagram:

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

2. Generate an HTML diagram with dependencies:

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

3. Customize the diagram layout:

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

🌟 Future Improvements

• Add support for more programming languages.
• Provide interactive diagram features, allowing users to zoom and pan.
• Support exporting diagrams in multiple formats (e.g., PNG, SVG).

📄 License

The code and related resources of this project are licensed under the MIT License. Please refer to the LICENSE file in the project root directory for details.