Tsuki MCP Filesystem Server

🚀 月之MCP文件系統服務器

本項目是一個符合模型上下文協議（MCP）的自定義服務器，可與OpenAI的Agent SDK集成，實現在本地文件系統上進行文件搜索和打開操作，為MCP客戶端提供文件資源服務。

🚀 快速開始

本服務器旨在與OpenAI的Agent SDK集成，支持通過MCP協議在本地文件系統上進行文件搜索和打開操作。啟動服務器後，它將在指定的IP地址和端口號下運行，準備接收來自MCP客戶端的請求。

# 啟動服務器
python main.py

✨ 主要特性

• 📂 通過MCP提供文件系統資源（支持文件搜索和打開操作）
• 📄 自動檢測 MIME 類型
• ⚙️ 使用環境變量實現靈活配置
• 📡 支持 JSON-RPC 協議

📦 安裝指南

# 克隆倉庫
git clone https://github.com/yuutotsuki/tsuki_mcp_filesystem_server.git
cd tsuki_mcp_filesystem_server

# 安裝依賴項
pip install -r requirements.txt

🛠️ 配置指南

1. 將 .env.example 複製到 .env 並進行配置：

cp .env.example .env

2. 根據需要編輯 .env 文件：

ROOT_PATH=/path/to/your/search/directory  # 要搜索的目錄路徑
HOST=127.0.0.1                            # 服務器主機地址
PORT=5001                                 # 服務器端口號
LOG_LEVEL=INFO                            # 日誌級別（DEBUG / INFO / WARNING / ERROR）

💻 使用示例

基礎用法

# 啟動服務器
python main.py

服務器將在指定的主機和端口上啟動，並等待MCP客戶端的請求。

📚 詳細文檔

API 端點

目前支持的方法：

• resources/list：獲取目標目錄中的文件列表

👨‍💻 開發指南

如果您希望貢獻代碼，請遵循以下準則：

1. 遵循 PEP 8 的編程風格。
2. 為新功能添加適當的測試。
3. 在提交Pull Request之前，確保所有測試均通過。

📄 許可證

本項目採用 MIT License 許可協議。

🧑‍💻 作者

[yuutotsukitocu]

👏 貢獻指南

歡迎提出 Pull Request。對於重大更改，請先打開一個 Issues 進行討論，再進行代碼提交。