🚀 文件系统 MCP 服务器 (@sylphlab/filesystem-mcp)
这是一个强大的文件系统工具包，遵循 [Model Context Protocol](https://github.com/Modelคณะกรรม parchain/model-context-protocol) 标准。它借助标准的输入输出协议，为 AI 代理或其他有高效文件操作需求的应用，提供对文件系统的强大控制能力。
🚀 快速开始
文件系统 MCP 服务器是一个遵循标准协议的工具包，能为 AI 代理等应用提供强大的文件系统控制能力。以下是快速使用的示例：
import { createClient } from '@sylphlab/filesystem-mcp';
const client = createClient();
// 示例：列出当前目录下的文件和子目录
client.listFiles({
path: '.',
recursive: false,
showHidden: true,
}).then((result) => {
console.log('操作结果:', result);
});
✨ 主要特性
这个服务器为您的 AI 代理提供了丰富的文件系统工具箱，具体功能如下：
- 文件和目录管理：可轻松创建、删除、移动和复制文件及目录。
- 内容读写：支持读取、写入和追加文件内容，还能递归创建父目录。
- 权限控制：能够更改文件和目录的 POSIX 权限和所有权。
- 搜索与替换：可在多个文件中进行精确编辑、查找和替换操作。
- 列表与统计：可以列出文件和目录（支持递归操作），并获取详细的状态信息。
所有工具均支持批处理操作，且每个操作都会返回详细的执行结果报告。
🔧 核心优势
- ⚡ 高效性：通过批处理减少通信开销，降低 AI 代理的调用次数。
- 🔒 安全性：严格限制在项目根目录内操作，防止越界访问。
- ✅ 可靠性：提供详细的错误报告和成功状态信息。
- 👐 易用性：遵循统一的 API 接口，简化集成过程。
📦 安装指南
通过 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);
});
📚 详细文档
- 完整文档：包括详细的 API 参考和示例，请访问 文档网站。
- 协议规范：遵循 Model Context Protocol，确保与 AI 代理的兼容性。
🔧 开发
克隆仓库
git clone https://github.com/sylphlab/filesystem-mcp.git
安装依赖
cd filesystem-mcp && pnpm install
构建项目
pnpm run build
监控开发（可选）
pnpm run dev
🚀 发布
此仓库使用 GitHub Actions 自动化发布流程：
- npm 发布：在将版本标签 (
v*.*.*) 推送到main分支时，自动发布到 npm。 - Docker 镜像构建与推送：同步进行 Docker 镜像的构建和推送至 Docker Hub。
需要在 GitHub 仓库设置中配置以下秘密：
NPM_TOKENDOCKERHUB_USERNAMEDOCKERHUB_TOKEN
👥 贡献
欢迎贡献！请通过 GitHub 仓库 提交问题或拉取请求。
📄 许可证
本项目以 MIT License 发布。