MCP File Tool

🚀 MCP File Server

A server implementation based on the Model Context Protocol (MCP), providing file system operations through standardized interfaces.

🚀 Quick Start

The MCP File Server enables AI models to perform file operations on the local file system via a standardized API. It is built using the Model Context Protocol SDK and offers tools for reading, creating, and listing files.

✨ Features

• Create File: Create a new file at the specified path and write content to it.
• Read File: Read the content of an existing file.
• List Directory Contents: List files and directories under the specified path along with their detailed information.
• Performance Monitoring: Built - in Sentry integration for error tracking and performance monitoring.

📦 Installation

npm install

💻 Usage Examples

Basic Usage

Start the MCP File Server:

node src/index.js

The server communicates using the MCP protocol via stdin/stdout.

Available Tools

createfile

Create a new file at the specified path and write content to it. Parameters:

• filePath: The path where the file should be created.
• content: The content to be written to the file.

Returns:

• A success message containing information about the file path and size.

readfile

Read the content of the file at the specified path. Parameters:

• filePath: The path of the file to be read.

Returns:

• The content of the file.

listfiles

List files and directories under the specified path. Parameters:

• path: The path of the directory whose contents are to be listed.

Returns:

• A Markdown table containing file names, sizes, and types.

Environment Variables

• SENTRY_DSN: Sentry Data Source Name for error tracking (optional).

Dependencies

Advanced Usage

Examples of calling these tools via the MCP protocol:

{
  "name": "createfile",
  "params": {
    "filePath": "example/test.txt",
    "content": "Hello, world!"
  }
}

{
  "name": "readfile",
  "params": {
    "filePath": "example/test.txt"
  }
}

{
  "name": "listfiles",
  "params": {
    "path": "example"
  }
}