mcp-file-navigator

🚀 MCP 文件服务器

MCP 文件服务器是一个基于 Node.js 的模块化文件管理工具，它支持多种文件操作功能。通过配置不同的服务，用户可以对其功能进行扩展，实现诸如压缩、加密或其他自定义需求。

🚀 快速开始

安装依赖

npm install express fs-extra shelljs

启动服务器

node mcp_server.js

默认端口为 3000。如需更改端口，请在启动时指定：

PORT=8080 node mcp_server.js

✨ 主要特性

核心功能

设置基础目录

参数：

• path：新的基础目录路径（必须是绝对路径）

返回：

• 确认信息

获取当前基础目录

参数：

• 无

返回：

• 当前基础目录路径

列出文件

参数：

• directory（可选）：要列出的目录路径（默认为根目录）

返回：

• 文件和目录的格式化列表

读取文件内容

参数：

• path：要读取的文件路径

返回：

• 文件内容

写入文件

参数：

• path：要写入的文件路径
• content：要写入的内容

返回：

• 确认信息

删除文件或目录

参数：

• path：要删除的文件或目录路径

返回：

• 确认信息

扩展功能

Git 命令执行

在基础目录中执行 Git 命令。

参数：

• command：要执行的 Git 命令（不带 git 前缀）
• shell（可选）：执行命令所用的 Shell（cmd、powershell、bash）

返回：

• 命令输出（标准输出和错误输出）

📚 详细文档

日志与调试

检查位于 log/mcp_debug.log 的日志文件，获取服务器操作的详细信息及可能发生的错误。

问题排查

常见问题：

1. 路径访问错误：确保 BASE_DIRECTORY 设置为进程可访问的位置。
2. 连接被拒绝：确认服务器正在运行。
3. 工具未找到：验证配置文件中的工具名称与服务器定义的完全一致。
4. 端口冲突：运行多个 MCP 服务时，确保使用不同的端口。
5. 无效基础目录：在从聊天中设置基础目录时，请提供绝对路径（非相对路径）。
6. Git 命令错误：确保 Git 已安装且基础目录是一个有效的 Git 仓库。

贡献指南

如何贡献

• 提交问题报告：提交详细的错误报告，附上复现步骤。
• 功能请求：提出新功能或改进建议。
• 文档改进：帮助完善或扩展现有文档。
• 代码贡献：提交修复错误或实现新功能的拉取请求。

开发流程

1. 分支创建：在自己的仓库中为每个特性或修正创建独立分支。
2. 遵循编码标准：保持代码风格的一致性。
3. 编写测试：为新增功能或修复添加相应的测试用例。
4. 更新文档：修改相关文档，反映所做的更改。
5. 提交拉取请求：提交一个清晰描述变更的拉取请求。

拉取请求指南

• 每个 PR 集中处理单一特性或修正。
• 包括对变更的详细说明和理由。
• 确保所有测试通过。
• 使用英文作为主要语言，除非另有规定。

文档历史

• 版本 1.0：初始发布（2023 年 10 月）
• 版本 1.1：添加 Git 命令支持及日志功能（2023 年 11 月）

如需进一步了解或寻求帮助，请参考项目文档或联系维护团队。