Filesystem MCP Server (@shtse8filesystem Mcp)

🚀 文件系统 MCP 服务器 (@sylphlab/filesystem-mcp)

这是一个遵守 Model [Context Protocol](https://github.com/Modelคณะกรรม parchain/model-context-protocol) 的文件系统工具包。它借助标准的输入输出协议，为 AI 代理或其他需要高效文件操作的应用，提供对文件系统的强大控制。

🚀 快速开始

此服务器为您的 AI 代理提供了强大的文件系统工具箱，可通过 npm 进行安装。

通过 npm 安装

npm install @sylphlab/filesystem-mcp

使用示例

import { createClient } from '@sylphlab/filesystem-mcp';

const client = createClient();

// 示例：列出当前目录下的文件和子目录
client.listFiles({
  path: '.',
  recursive: false,
  showHidden: true,
}).then((result) => {
  console.log('操作结果:', result);
});

✨ 主要特性

• 文件和目录管理：创建、删除、移动和复制文件及目录。
• 内容读写：读取、写入和追加文件内容，支持递归创建父目录。
• 权限控制：更改文件和目录的 POSIX 权限和所有权。
• 搜索与替换：在多个文件中进行精确编辑、查找和替换。
• 列表与统计：列出文件和目录（可选递归），获取详细状态信息。

所有工具均支持批处理操作，每个操作都会返回详细的执行结果报告。

🔧 技术细节

核心优势

1. 高效性：通过批处理减少通信开销，降低 AI 代理的调用次数。
2. 安全性：严格限制在项目根目录内操作，防止越界访问。
3. 可靠性：提供详细的错误报告和成功状态信息。
4. 易用性：遵循统一的 API 接口，简化集成过程。

📚 详细文档

• 完整文档：包括详细的 API 参考和示例，请访问 文档网站。
• 协议规范：遵循 Model Context Protocol，确保与 AI 代理的兼容性。

🛠️ 开发步骤

1. 克隆仓库：

   git clone https://github.com/sylphlab/filesystem-mcp.git
   

2. 安装依赖：

   cd filesystem-mcp && pnpm install
   

3. 构建项目：

   pnpm run build
   

4. 监控开发（可选）：

   pnpm run dev
   

🚀 发布说明

此仓库使用 GitHub Actions 自动化发布流程：

• npm 发布：在将版本标签 (v*.*.*) 推送到 main 分支时，自动发布到 npm。
• Docker 镜像构建与推送：同步进行 Docker 镜像的构建和推送至 Docker Hub。

需要在 GitHub 仓库设置中配置以下秘密：

• NPM_TOKEN
• DOCKERHUB_USERNAME
• DOCKERHUB_TOKEN

🤝 贡献指南

欢迎贡献！请通过 GitHub 仓库 提交问题或拉取请求。

📄 许可证

本项目以 MIT License 发布。