Filesystem MCP

🚀 File System MCP 🌐

Welcome to the File System MCP repository! This project offers a Node.js-based Model Context Protocol (MCP) server, designed to provide secure and relative file system access for AI agents like Cline and Claude.

🚀 Quick Start

This project provides a Node.js-based Model Context Protocol (MCP) server. It allows AI agents such as Cline and Claude to access the file system securely and relatively, enhancing the interaction between AI and file systems.

✨ Features

• Secure Access: Ensures that AI agents interact with the file system in a secure manner.
• Relative Path Support: Simplifies the file access process without the need for absolute paths.
• AI Agent Support: Specifically designed to work with Cline and Claude.
• Built with Node.js: Leverages the power of Node.js for efficient server-side operations.
• TypeScript Support: Offers type safety and a better developer experience.

📦 Installation

To start using the File System MCP server, follow these steps:

1. Clone the repository:

   git clone https://github.com/Tabeeh/filesystem-mcp.git
   cd filesystem-mcp
   

2. Install dependencies: Make sure Node.js is installed. Then run:

   npm install
   

3. Download the latest version: You can download the latest version from here. Execute the corresponding file after downloading.

💻 Usage Examples

Basic Usage

To start the server, run the following command:

npm start

Configuration Example

You can configure the server by modifying the config.json file. Here is an example configuration:

{
  "port": 3000,
  "secure": true,
  "allowedAgents": ["Cline", "Claude"]
}

Sending Requests

After the server is running, you can send requests to access the file system using the following command:

curl -X GET http://localhost:3000/files/path/to/your/file

Error Handling

The server returns corresponding HTTP status codes for different errors. For example:

• 404 Not Found: The resource was not found.
• 500 Internal Server Error: An internal server error occurred.

📚 Documentation

API Documentation

Here is the API documentation for the File System MCP server:

Get File Content

URL: /files/:filename
Method: GET

Example Response

On success:

{
  "content": "...",
  "status": "success"
}

On failure:

{
  "message": "...",
  "status": "error"
}

Create a New File

URL: /files
Method: POST
Request Body:
{
  "filename": "string",
  "content": "string"
}

🤝 Contributing

To contribute to the project, follow these steps:

1. Fork the repository: Fork this repository on GitHub.

2. Create a feature branch:

   git checkout -b feature/your-feature-name main
   

3. Commit your changes: Commit your changes and follow the commit message format guidelines.

4. Push to the remote repository:

   git push origin feature/your-feature-name
   

5. Create a Pull Request: Create a Pull Request for your branch on GitHub.

📄 License

This project is licensed under the MIT License. Refer to the LICENSE file for detailed information.

📬 Contact

Author: [Your Name]
Email: [Your Email]
GitHub Repository: https://github.com/Tabeeh/filesystem-mcp

Thank you for using File System MCP! For more updates, visit the Releases page.