使用说明
项目简介
Deep Directory Tree MCP 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在帮助 AI 助手理解和导航项目目录结构。通过该服务器,AI 助手可以获取项目目录的树状可视化结构,从而更有效地进行代码导航、项目理解和组织。
主要功能点
- 深度目录树可视化: 生成项目目录的树状结构,方便AI助手理解目录层级关系。
- 可配置的深度: 允许用户自定义目录树的展示深度,控制信息的详细程度。
- 模式化文件/目录排除: 支持根据预设或自定义模式排除特定文件或目录(如 'node_modules', '.git'),减少噪声信息。
- 清晰易读的树状输出: 以文本形式返回结构化的目录树,易于AI助手解析和理解。
- 实时目录结构更新: (根据代码分析,此处描述可能为期望功能,代码未明确体现实时更新,实际为启动时生成) 能够反映最新的目录结构状态。
- 目标目录分析: 可以指定要分析的根目录,灵活应用于不同项目或子目录。
安装步骤
方法一:使用 Smithery (推荐)
如果使用 Smithery 工具链,可以通过以下命令快速安装和配置:
npx -y @smithery/cli install deep-directory-tree-mcp --client cursor
方法二:手动安装
-
环境准备: 确保已安装 Node.js (v18 或更高版本)。
-
安装软件包: 使用 npm 或 yarn 安装 '@andredezzy/deep-directory-tree-mcp' 包。
npm install -g @andredezzy/deep-directory-tree-mcp或
yarn global add @andredezzy/deep-directory-tree-mcp
服务器配置
配置信息 (JSON 格式)
将以下配置添加到您的 MCP 客户端 (如 Cursor 或 Claude) 的服务器配置中。请注意,您无需修改以下 JSON 代码,只需复制粘贴到 MCP 客户端的配置中即可。
Cursor IDE 配置:
打开 Cursor 设置 → MCP → 添加新的 MCP 服务器,然后添加以下配置:
{ "@andredezzy/deep-directory-tree-mcp": { "command": "npx", "args": ["-y", "@andredezzy/deep-directory-tree-mcp"] } }
Claude Desktop 配置:
在 Claude 的 MCP 配置文件中添加以下配置:
{ "mcpServers": { "@andredezzy/deep-directory-tree": { "command": "npx", "args": ["-y", ["@andredezzy/deep-directory-tree-mcp"]] } } }
配置参数说明:
- 'command': 指定启动 MCP 服务器的命令,这里使用 'npx' 来运行全局安装的 '@andredezzy/deep-directory-tree-mcp' 包。
- 'args': 传递给命令的参数,'-y' 用于自动确认 'npx' 的安装提示,'@andredezzy/deep-directory-tree-mcp' 是要执行的包名。
基本使用方法
配置完成后,在您的 AI 助手 (如 Cursor, Claude) 中,可以使用以下指令来调用 Deep Directory Tree MCP 服务器:
- "Show me the directory structure": 显示当前工作目录的目录结构 (默认深度)。
- "Visualize project tree up to depth 4": 显示当前工作目录的目录结构,深度为 4 层。
- "Show files excluding test directories": 显示当前工作目录的目录结构,并排除包含 "test" 关键词的目录 (需要更精细的配置或指令,默认排除规则见功能点描述)。
提示: 您可以根据 AI 助手的具体指令格式,结合上述示例进行提问,以获取所需的目录结构信息。
信息
分类
开发者工具