Filesystem MCP Server (@shtse8filesystem Mcp)

🚀 File System MCP Server (@sylphlab/filesystem-mcp)

A file system toolkit adhering to the Model [Context Protocol](https://github.com/Modelคณะกรรม parchain/model-context-protocol), providing powerful control over the file system through a standard input-output protocol, suitable for AI agents or other applications requiring efficient file operations.

🚀 Quick Start

The File System MCP Server is a versatile tool designed to offer robust file system management capabilities for AI agents and other applications. It adheres to the Model Context Protocol, ensuring seamless integration and efficient operation.

✨ Features

This server equips your AI agents with a comprehensive file system toolkit:

• File and Directory Management: Create, delete, move, and copy files and directories.
• Content Reading and Writing: Read, write, and append file contents, with support for recursive creation of parent directories.
• Permission Control: Modify POSIX permissions and ownership of files and directories.
• Search and Replace: Perform precise editing, searching, and replacement across multiple files.
• Listing and Statistics: List files and directories (optionally recursively) and obtain detailed status information.

All tools support batch operations, and each operation returns a detailed execution result report.

🔧 Technical Details

Core Advantages

1. Efficiency: Reduces communication overhead through batch processing, minimizing the number of calls from AI agents.
2. Security: Strictly confines operations within the project root directory to prevent out-of-bounds access.
3. Reliability: Provides detailed error reports and success status information.
4. Ease of Use: Follows a unified API interface, simplifying the integration process.

📦 Installation

Install via npm

npm install @sylphlab/filesystem-mcp

💻 Usage Examples

Basic Usage

import { createClient } from '@sylphlab/filesystem-mcp';

const client = createClient();

// Example: List files and subdirectories in the current directory
client.listFiles({
  path: '.',
  recursive: false,
  showHidden: true,
}).then((result) => {
  console.log('Operation Result:', result);
});

📚 Documentation

• Full Documentation: For detailed API references and examples, please visit the Documentation Website.
• Protocol Specification: Adheres to the Model Context Protocol to ensure compatibility with AI agents.

🛠️ Development

1. Clone the repository:

git clone https://github.com/sylphlab/filesystem-mcp.git

2. Install dependencies:

cd filesystem-mcp && pnpm install

3. Build the project:

pnpm run build

4. Monitor development (optional):

pnpm run dev

🚀 Release

This repository utilizes GitHub Actions for an automated release process:

• npm Publishing: Automatically publishes to npm when a version tag (v*.*.*) is pushed to the main branch.
• Docker Image Building and Pushing: Simultaneously builds and pushes Docker images to Docker Hub.

The following secrets need to be configured in the GitHub repository settings:

• NPM_TOKEN
• DOCKERHUB_USERNAME
• DOCKERHUB_TOKEN

🤝 Contribution

Contributions are welcome! Please submit issues or pull requests via the GitHub Repository.

📄 License

This project is released under the MIT License.