文件系统 MCP 🌐

欢迎来到 文件系统 MCP 仓库！本项目提供了一个 Node.js 模型上下文协议 (MCP) 服务器，旨在为 AI 代理（如 Cline 和 Claude）提供安全、相对的文件系统访问。

目录

• 特性
• 安装
• 使用
• API 文档
• 贡献
• 许可
• 联系方式

特性 ✨

• 安全访问: 确保 AI 代理以安全的方式与文件系统交互。
• 相对路径: 简化了访问文件的过程，无需绝对路径。
• 支持 AI 代理: 专门设计用于与 Cline 和 Claude 配合使用。
• 基于 Node.js 构建: 利用 Node.js 的强大功能进行高效的服务器端操作。
• TypeScript 支持: 提供类型安全性和改进的开发者体验。

安装 ⚙️

要开始使用文件系统 MCP 服务器，请按照以下简单步骤操作：

1. 克隆仓库:

   git clone https://github.com/Tabeeh/filesystem-mcp.git
   cd filesystem-mcp
   

2. 安装依赖: 确保您已安装 Node.js。然后运行：

   npm install
   

3. 下载最新版本: 您可以在这里找到最新版本。下载相应的文件并执行它。

使用 🚀

要启动服务器，请运行以下命令：

npm start

示例配置

您可以通过修改 config.json 文件来配置服务器。这是一个示例配置：

{
  "port": 3000,
  "secure": true,
  "allowedAgents": ["Cline", "Claude"]
}

发送请求

服务器运行后，您可以发送请求来访问文件系统。这是一个使用 curl 的示例：

curl -X GET http://localhost:3000/files/path/to/your/file

错误处理

服务器为各种错误场景返回适当的 HTTP 状态代码和消息。例如：

• 404 Not Found: 请求的文件不存在。
• 403 Forbidden: 拒绝访问该文件。

API 文档 📚

文件系统 MCP 服务器公开了一个简单的 API 用于与文件系统交互。以下是主要端点：

GET /files/{path}

检索指定相对路径的文件内容。

• 参数:

  • path: 文件的相对路径。

• 响应:

  • 200 OK: 返回文件内容。
  • 404 Not Found: 文件不存在。
  • 403 Forbidden: 拒绝访问。

POST /files/{path}

在指定的相对路径创建或更新文件。

• 参数:

  • path: 文件的相对路径。

• 请求体:

  • content: 要写入文件的内容。

• 响应:

  • 201 Created: 文件创建成功。
  • 400 Bad Request: 无效请求。

贡献 🤝

我们欢迎贡献！如果您想帮助改进文件系统 MCP，请按照以下步骤操作：

1. Fork 仓库。
2. 创建一个新分支：

   git checkout -b feature/YourFeature
   

3. 进行更改。
4. 提交更改：

   git commit -m "Add some feature"
   

5. 推送到分支：

   git push origin feature/YourFeature
   

6. 打开一个 pull request。

许可 📜

本项目根据 MIT 许可证获得许可。有关详细信息，请参阅 LICENSE 文件。

联系方式 📫

如有任何问题或反馈，请随时联系：

• 作者: 您的名字
• 邮箱: your.email@example.com

---

有关最新的更新、版本和文档，请访问我们的 Releases 部分。

祝你编码愉快！ 🎉