文件系统 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 -X GET http://localhost:3000/files/path/to/your/file

错误处理

服务器针对不同错误返回相应的 HTTP 状态码。例如：

• 404 Not Found：资源未找到。
• 500 Internal Server Error：服务器内部错误。

API 文档

以下是文件系统 MCP 服务器的 API 文档：

获取文件内容

URL: /files/:filename
方法: GET

示例响应

成功时：

{
  "content": "...",
  "status": "success"
}

失败时：

{
  "message": "...",
  "status": "error"
}

创建新文件

URL: /files
方法: POST
请求体:
{
  "filename": "string",
  "content": "string"
}

贡献指南 🤝

要为项目做贡献，请按照以下步骤操作：

1. Fork 仓库： 在 GitHub 上 Fork 本仓库。

2. 创建功能分支：

   git checkout -b feature/your-feature-name main
   

3. 提交更改： 提交你的更改并遵循 commit message 格式规范。

4. 推送至远程仓库：

   git push origin feature/your-feature-name
   

5. 创建 Pull Request： 在 GitHub 上为您的分支创建 Pull Request。

许可证

本项目采用 MIT 许可证。请参考 LICENSE 文件获取详细信息。

联系方式 📬

作者：[你的名字]
邮箱：[你的邮箱]
GitHub 仓库：https://github.com/Tabeeh/filesystem-mcp

感谢您使用文件系统 MCP！更多更新请访问 Releases 页面 。