FileScopeMCP (Model Context Protocol) Server
2025.04.03
64
TypeScript代码分析可视化工具开发效率
FileScopeMCP是一个基于TypeScript的工具，用于分析和可视化代码库结构，通过计算文件的重要性评分、跟踪依赖关系以及提供文件摘要，帮助开发者快速理解代码库。它支持多种编程语言，包括Python、JavaScript、TypeScript、C/C++、Rust、Lua和Zig。
View on GitHub
Overview
基本能力
产品定位
FileScopeMCP旨在帮助开发者快速理解代码库结构，通过分析文件依赖关系和重要性评分，提供代码库的可视化和摘要功能。
核心功能
- 文件重要性分析：根据依赖关系计算文件的重要性评分（0-10）。
- 依赖跟踪：跟踪文件之间的双向依赖关系，支持多种编程语言。
- 可视化：生成Mermaid图表，展示文件关系和目录结构。
- 文件摘要：支持添加和检索文件摘要，帮助快速理解文件用途。
- 多项目支持：管理多个项目的文件树，支持快速切换和缓存。
- 持久化存储：所有数据自动保存为JSON格式，支持快速加载。
适用场景
- 代码库结构分析和理解。
- 快速定位关键文件。
- 生成代码库的可视化图表。
- 为文件添加摘要，便于团队协作。
工具列表
- 文件树管理：
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。
常见问题解答
- 如何安装：克隆仓库后运行
build.bat（Windows）或build.sh（Linux）。 - 如何配置：修改
mcp.json中的--base-dir参数为项目路径。 - 如何生成图表：使用
generate_diagram工具，支持多种输出格式和自定义选项。
使用教程
使用依赖
- 确保已安装Node.js（版本≥18.x）。
安装教程
- 克隆仓库：
bash git clone https://github.com/admica/FileScopeMCP.git - 构建项目：
- Windows:
bash build.bat - Linux:
bash build.sh - 配置
mcp.json：json { "mcpServers": { "FileScopeMCP": { "command": "node", "args": ["<build script sets this>/mcp-server.js","--base-dir=C:/Users/admica/my/project/base"], "transport": "stdio", "disabled": false, "alwaysAllow": [] } } }
调试方式
- 启动服务后，使用以下命令测试功能：
bash list_files - 生成图表：
bash generate_diagram(style: "directory", maxDepth: 3, outputPath: "diagrams/project-structure", outputFormat: "mmd") - 检查文件摘要：
bash get_file_summary(filepath: "/path/to/project/src/main.ts")