Bsmi021 MCP Filesystem Server

🚀 Filesystem MCP Server

A Model Context Protocol (MCP) server implementing a standard tool interface for filesystem operations, analysis, and management based on the MCP protocol.

🚀 Quick Start

This server is built upon the MCP SDK and divided into different layers:

graph TD
    A[ MCP Server Layer ] --> B[ Tool Registry ]
    B --> C[ Operation Layer ]
    C --> D[ Filesystem 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.
• Filesystem Interface: Provides secure filesystem access.

📦 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"]
    }
  }
}

📚 Documentation

Tool Reference

Directory Operations

list_directory

List directory contents and their metadata.

Interface:

interface ListDirectoryParams {
  /** The path of the directory to list */
  path: string;
}

interface ListDirectoryResult {
  /** List of files and subdirectories in the directory */
  entries: Array<{
    /** Name of the file or subdirectory */
    name: string;
    /** File type ('file' or 'directory') */
    type: string;
    /** Modification time */
    modifiedTime: Date;
  }>;
}

Example:

const result = await filesystem.listFiles('/path/to/dir');
// The result structure is as shown above

File Operations

read_file

Read file content.

Interface:

interface ReadFileParams {
  /** The path of the file to read */
  path: string;
}

interface ReadFileResult {
  /** File content (binary buffer) */
  content: Buffer;
}

Example:

const content = await filesystem.readFile('/path/to/file.txt');
// The content variable contains the file data

write_file

Write file content.

Interface:

interface WriteFileParams {
  /** The path of the file to write */
  path: string;
  /** File content */
  content: Buffer | string;
}

interface WriteFileResult {
  /** Number of bytes written */
  bytesWritten: number;
}

Example:

const result = await filesystem.writeFile('/path/to/file.txt', 'Content to write');
// Returns the number of bytes written

Error Handling

Error Codes and Messages

• 400 Bad Request: Invalid request parameters.
• 401 Unauthorized: Insufficient permissions to perform the operation.
• 404 Not Found: The specified file or directory does not exist.
• 500 Internal Server Error: Internal server error.

Development Mode

Watch Mode

npm run watch

Code Quality

Check code:

npm run lint

Type checking:

npm run type-check

🤝 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