金大哥 - tsuki_mcp_filesystem

article

README

🚀 tsuki_mcp_filesystem_server

MCP文件提供程序，这是一个符合模型上下文协议（MCP）的自定义服务器，可与OpenAI的Agent SDK集成，实现在本地文件系统上进行文件搜索和打开操作，为文件资源交互提供便利。

🚀 快速开始

本项目是一个用于在本地文件系统上执行文件搜索的自定义MCP兼容服务器。它与OpenAI的Agent SDK集成，支持通过resources/list方法进行资源列表操作。下面将为你介绍如何快速启动该服务器。

✨ 主要特性

📂 通过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

🛠️ 配置指南

复制环境变量示例文件

将 .env.example 复制到 .env 并进行配置：

cp .env.example .env

编辑环境变量文件

根据需要编辑 .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：获取目标目录中的文件列表

开发指南

如果您希望贡献代码，请遵循以下准则：

遵循 PEP 8 的编程风格
为新功能添加适当的测试
在提交Pull Request之前，确保所有测试均通过

📄 许可证

本项目采用 MIT License。

👨‍💻 作者

[yuutotsukitocu]

🌟 贡献

欢迎提出 Pull Request。对于重大更改，请先打开一个 Issues 进行讨论，再进行代码提交。

tsuki_mcp_filesystem_server