使用说明

项目简介

本项目实现了一个基于Model Context Protocol (MCP) 的文件服务器，旨在为AI模型提供访问本地文件系统的能力。通过此服务器，模型可以安全地执行文件创建、读取和目录列表等操作，从而扩展模型的功能并实现更复杂的数据交互场景。

主要功能点

• 创建文件 (createfile): 允许AI模型在指定路径创建新文件，并写入指定内容。
• 读取文件 (readfile): 允许AI模型读取指定路径文件的内容。
• 列出目录内容 (listfiles): 允许AI模型列出指定目录下文件和子目录的信息，包括名称、大小和类型。
• 错误监控: 集成Sentry，用于错误跟踪和性能监控（可选，需配置Sentry DSN环境变量）。

安装步骤

1. 确保已安装 Node.js 和 npm。
2. 克隆本仓库到本地：'git clone https://github.com/codyde/mcp-file-tool.git'
3. 进入仓库目录：'cd mcp-file-tool'
4. 安装依赖：'npm install'

服务器配置

以下 JSON 配置信息用于配置 MCP 客户端连接到此文件服务器。客户端需要配置 'command' 和 'args' 来启动服务器进程，并指定 'transport' 为 'stdio'。

{
  "serverName": "File MCP Server",
  "command": "node",
  "args": ["src/index.js"],
  "transport": "stdio",
  "description": "MCP文件系统操作服务器，通过标准输入/输出进行通信。"
}

配置参数说明:

• 'serverName': 服务器名称，可自定义，用于在客户端标识该服务器。
• 'command': 启动服务器的命令，这里使用 'node' 运行 JavaScript 文件。
• 'args': 启动命令的参数，这里指定服务器入口文件为 'src/index.js'。
• 'transport': MCP 服务器使用的传输协议，这里使用 'stdio' (标准输入/输出)。
• 'description': 服务器的描述信息，可自定义，用于提供服务器的简要说明。

基本使用方法

1. 启动 MCP 文件服务器：在仓库目录下，运行命令 'node src/index.js'。服务器将通过标准输入/输出等待接收 MCP 客户端的请求。
2. 配置 MCP 客户端：在您的 MCP 客户端应用中，根据上述“服务器配置”部分提供的信息配置连接。
3. 调用工具：客户端可以使用 MCP 协议向服务器发送 JSON-RPC 请求，调用 'createfile', 'readfile', 'listfiles' 等工具，实现文件操作。具体的工具参数和请求格式请参考仓库 README.md 文件中 "Available Tools" 部分的说明。

示例请求 (JSON-RPC over stdio):

创建文件:

{
  "jsonrpc": "2.0",
  "method": "tool/invoke",
  "params": {
    "tool_name": "createfile",
    "arguments": {
      "filePath": "example/test.txt",
      "content": "Hello, world!"
    }
  },
  "id": 1
}

读取文件:

{
  "jsonrpc": "2.0",
  "method": "tool/invoke",
  "params": {
    "tool_name": "readfile",
    "arguments": {
      "filePath": "example/test.txt"
    }
  },
  "id": 2
}

列出目录:

{
  "jsonrpc": "2.0",
  "method": "tool/invoke",
  "params": {
    "tool_name": "listfiles",
    "arguments": {
      "path": "example"
    }
  },
  "id": 3
}