Overview: FileScopeMCP (Model Context Protocol) Server

Title

FileScopeMCP (Model Context Protocol) Server

✨ Instantly understand and visualize your codebase structure & dependencies! ✨

How to Use

1. Installation

   • Clone the repository and run the build script (build.bat for Windows or build.sh for Linux).
   • Configure the mcp.json file in your project's .cursor directory.
   • Set the --base-dir argument to your project's base path.

2. Features & Tools

   • Use commands like list_files, get_file_importance, and generate_diagram to analyze and visualize your codebase.
   • Manage file trees, track dependencies, and assign summaries to files.

3. Integration

   • Works with Cursor’s Model Context Protocol (MCP) for AI-assisted code understanding.

Key Features

🚀 Supercharge Your Code Understanding!

• 🎯 File Importance Analysis
  • Ranks files (0-10) based on dependencies, location, and naming.
• 🔗 Dependency Tracking
  • Maps bidirectional dependencies across multiple languages (Python, JS/TS, C/C++, Rust, Lua, Zig).
• 📊 Visualization
  • Generates Mermaid diagrams (color-coded by importance) with HTML output.
• 📝 File Summaries
  • Add and retrieve human/AI-generated summaries for quick context.
• 📚 Multiple Project Support
  • Manage separate file trees for different projects.
• 💾 Persistent Storage
  • Saves data in JSON for fast reloading.

Use Cases

• Onboarding: Quickly grasp critical files in a new codebase.
• Refactoring: Identify high-impact dependencies before making changes.
• Documentation: Auto-generate visual maps of file relationships.
• AI Assistance: Feed structured code insights to AI tools like Cursor.
• Debugging: Trace dependency chains to locate issues.

Built with TypeScript/Node.js, FileScopeMCP helps developers and AI tools navigate complex projects efficiently.

---

For detailed commands and technical specs, refer to the full documentation.