Filesystem MCP Server Vrm

🚀 File System MCP Server

This is an MCP service implementation that offers file system operations, analysis, and management capabilities, providing services through standardized tool interfaces.

🚀 Quick Start

The File System MCP Server is a powerful tool for handling file system operations. It provides a standardized interface for various file system tasks.

✨ Features

• Comprehensive Functionality: Offers a wide range of file system operations, analysis, and management features.
• Standardized Interface: Provides services through standardized tool interfaces, ensuring compatibility and ease of use.
• Modular Architecture: Based on the MCP SDK, it is divided into different layers for better organization and maintainability.

📦 Installation

1. Clone the repository:

git clone <repository-url>
cd filesystem-server

2. Install dependencies:

npm install

3. Build the server:

npm run build

4. Configure MCP settings (cline_mcp_settings.json):

{
  "mcpServers": {
    "filesystem": {
      "command": "node",
      "args": ["path/to/filesystem-server/build/index.js"]
    }
  }
}

💻 Usage Examples

Basic Usage

The server provides a set of tools for file system operations. Here are some examples of using these tools:

Directory Operations

list_directory

Lists the contents of a directory along with their metadata.

interface ListDirectoryParams {
    path: string;       // Directory path
    recursive?: boolean; // Whether to list recursively (default: false)
}

interface ListDirectoryResult {
    entries: {
        name: string;
        path: string;
        isDirectory: boolean;
        size: number;
        created: string;
        modified: string;
        accessed: string;
    }[];
}

create_directory

Creates a new directory.

interface CreateDirectoryParams {
    path: string;       // Directory path
}

interface CreateDirectoryResult {
    success: boolean;
    message?: string;
}

File Operations

read_file

Reads the content of a file.

interface ReadFileParams {
    path: string;         // File path
    encoding?: string;   // Character encoding (default: utf-8)
}

interface ReadFileResult {
    content: Buffer | string;
    mimeType: string;
}

write_file

Writes content to a file.

interface WriteFileParams {
    path: string;       // File path
    content: string | Buffer; // File content
    encoding?: string;  // Character encoding (default: utf-8)
}

interface WriteFileResult {
    success: boolean;
    message?: string;
}

delete_file

Deletes a file.

interface DeleteFileParams {
    path: string;       // File path
}

interface DeleteFileResult {
    success: boolean;
    message?: string;
}

Error Handling

The MCP protocol defines the following error codes:

• 100: General error
• 101: Authentication failed
• 102: Permission denied
• 103: File or directory does not exist
• 104: Insufficient system resources
• 105: Operation timed out
• 106: Invalid parameter

The error response format is as follows:

{
    "error": {
        "code": number,
        "message": string
    }
}

📚 Documentation

Architecture

The server is based on the MCP SDK and is divided into different layers:

graph TD
    A[MCP Server Layer] --> B[Tool Registry]
    B --> C[Operation Layer]
    C --> D[File System Operations]
    C --> E[Analysis Operations]
    C --> F[Stream Operations]

Components

• Server Layer: Handles MCP protocol communication and tool scheduling.
• Tool Registry: Manages tool registration and execution.
• Operation Layer: Implements core functions.
• File System Interface: Provides secure file system access.

Development Information

Project Structure

.
├── operations/         # Core operation implementations
├── tools/             # MCP tool definitions and handlers
├── __tests__/         # Test suites
├── index.ts           # Entry point
├── server.ts          # MCP server settings
├── types.ts           # Type definitions
└── utils.ts           # Utility functions

Running Tests

Run the test suite:

npm test

Run with coverage:

npm run test:coverage

Development Mode

Run in watch mode:

npm run watch

Code Quality

Check the code baseline:

npm run lint

Perform type checking:

npm run type-check

Dependencies

Core Dependencies

• @modelcontextprotocol/sdk: MCP server implementation
• file-type: File type detection
• mime-types: MIME type lookup
• crypto-js: File hashing
• archiver: ZIP creation
• extract-zip: ZIP extraction
• iconv-lite: Text encoding
• chardet: Encoding detection

Development Dependencies

• typescript: Type system
• jest: Testing
• eslint: Linting
• prettier: Formatting
• ts-node: TypeScript execution
• nodemon: Development server

🤝 Contribution Guidelines

1. Fork the repository.
2. Create a feature branch.
3. Write tests for new features.
4. Ensure all tests pass.
5. Submit a pull request.

📄 License

MIT