filesystem-mcp

filesystem-mcp

0
file_systems

Filesystem MCP is a Node.js server that provides secure, relative filesystem access for AI agents like Cline and Claude. It offers features like secure access, relative path support, and TypeScript integration, enhancing the interaction between AI and the filesystem.

Filesystem MCP 🌐

GitHub Release Node.js

Welcome to the Filesystem MCP repository! This project provides a Node.js Model Context Protocol (MCP) server designed to offer secure, relative filesystem access for AI agents such as Cline and Claude.

Table of Contents

Features ✨

  • Secure Access: Ensures that AI agents interact with the filesystem in a safe manner.
  • Relative Paths: Simplifies the process of accessing files without needing absolute paths.
  • Support for AI Agents: Specifically designed to work with Cline and Claude.
  • Built with Node.js: Utilizes the power of Node.js for efficient server-side operations.
  • TypeScript Support: Offers type safety and improved developer experience.

Installation ⚙️

To get started with the Filesystem MCP server, follow these simple steps:

  1. Clone the Repository:

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

  2. Install Dependencies: Make sure you have Node.js installed. Then run:

    npm install

  3. Download the Latest Release: You can find the latest release here. Download the appropriate file and execute it.

Usage 🚀

To start the server, run the following command:

npm start

Example Configuration

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

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

Making Requests

Once the server is running, you can make requests to access the filesystem. Here’s an example using curl:

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

Error Handling

The server returns appropriate HTTP status codes and messages for various error scenarios. For example:

  • 404 Not Found: The requested file does not exist.
  • 403 Forbidden: Access to the file is denied.

API Documentation 📚

The Filesystem MCP server exposes a simple API for interacting with the filesystem. Here are the main endpoints:

GET /files/{path}

Retrieves the contents of a file at the specified relative path.

  • Parameters:

    • path: The relative path to the file.

  • Response:

    • 200 OK: Returns the file contents.
    • 404 Not Found: File does not exist.
    • 403 Forbidden: Access denied.

POST /files/{path}

Creates or updates a file at the specified relative path.

  • Parameters:

    • path: The relative path to the file.

  • Body:

    • content: The content to write to the file.

  • Response:

    • 201 Created: File created successfully.
    • 400 Bad Request: Invalid request.

Contributing 🤝

We welcome contributions! If you’d like to help improve the Filesystem MCP, please follow these steps:

  1. Fork the repository.
  2. Create a new branch: 
    git checkout -b feature/YourFeature
  3. Make your changes.
  4. Commit your changes: 
    git commit -m "Add some feature"
  5. Push to the branch: 
    git push origin feature/YourFeature
  6. Open a pull request.

License 📜

This project is licensed under the MIT License. See the file for details.

Contact 📫

For any questions or feedback, feel free to reach out:

For the latest updates, releases, and documentation, visit our Releases section.

Happy coding! 🎉