文件系统服务器

一个基于MCP协议的文件系统服务器,提供文件、目录和搜索操作的工具和资源。

  • by indigobuffalo
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 indigobuffalo/mcp-fs-server

使用说明

mcp-fs服务器

文件系统MCP服务器

需求

此项目使用 紫外线 用于虚拟环境和包管理。您可以安装 uv 使用Homebrew:

brew install uv

设置虚拟环境

要设置具有所有开发依赖项和附加项的虚拟环境,请运行:

uv sync --dev --all-extras

示例目录

这 example/ 目录包含演示如何与MCP文件系统代理交互的脚本。看 example/README.md 有关使用标准输入/输出和SSE传输运行示例的详细信息。

项目结构

主要源代码位于 src/mcp_fs/ 目录。结构如下:

  • main.py / src/mcp_fs/launcher.py:启动服务器的入口点。
  • src/mcp_fs/server.py:定义主 FileSystemMCP 服务器类和注册工具/资源。
  • src/mcp_fs/tools/:包含用于文件、目录和搜索操作的工具类。在此处添加新工具。
  • src/mcp_fs/resources/:包含资源定义。在此处添加新资源。
  • src/mcp_fs/config/:配置常数(例如,搜索时忽略的目录)。
  • src/mcp_fs/utils/:实用功能(例如路径验证)。

贡献者指南

  • 要添加新的文件或目录操作,请将它们实现为类中的方法 src/mcp_fs/tools/ 并用 @mcp_tool.
  • 要添加新资源,请在中定义它们 src/mcp_fs/resources/ 并用 @mcp_resource.
  • 更新中的服务器注册 src/mcp_fs/server.py 如果添加新的工具或资源模块。
  • 使用 example/ 目录以添加或更新使用示例。