Tsuki MCP Filesystem Server

🚀 tsuki_mcp_filesystem_server

A custom server compliant with the MCP standard for searching files in the local file system. It integrates with OpenAI's Agent SDK and supports resource listing operations through the resources/list method.

🚀 Quick Start

This is a custom server that adheres to the Model Context Protocol (MCP). It is designed to integrate with OpenAI's Agent SDK, enabling file search and opening operations on the local file system.

✨ Features

• Provide file system resources via MCP (support file search and opening operations).
• Automatically detect MIME types.
• Implement flexible configuration using environment variables.
• Support the JSON-RPC protocol.

📦 Installation

# Clone the repository
git clone https://github.com/yuutotsuki/tsuki_mcp_filesystem_server.git
cd tsuki_mcp_filesystem_server

# Install dependencies
pip install -r requirements.txt

📚 Documentation

Configuration Guide

1. Copy .env.example to .env and configure it:

   cp .env.example .env
   

2. Edit the .env file as needed:

   ROOT_PATH=/path/to/your/search/directory  # Path to the directory to search
   HOST=127.0.0.1                            # Server host address
   PORT=5001                                 # Server port number
   LOG_LEVEL=INFO                            # Log level (DEBUG / INFO / WARNING / ERROR)
   

Usage Instructions

# Start the server
python main.py

The server will start on the specified host and port, waiting for requests from MCP clients.

API Endpoints

Currently supported methods:

• resources/list: Get the list of files in the target directory.

Development Guide

If you wish to contribute code, please follow these guidelines:

1. Follow the programming style of PEP 8.
2. Add appropriate tests for new features.
3. Ensure all tests pass before submitting a Pull Request.

📄 License

This project is under the MIT License.

👨‍💻 Author

[yuutotsukitocu]

🤝 Contribution

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.