文件搜索工具

一个基于Ktor的文件搜索工具,用于在服务器文件系统中搜索关键词并返回匹配行。

  • by thekaailashsharma
  • Kotlin
  • 混合部署
  • 更新于
在 GitHub 查看 thekaailashsharma/file-system-mcp

使用说明

文件系统mcp

此项目是使用创建的 Ktor项目生成器.

以下是一些帮助您入门的有用链接:

特性

以下是此项目中包含的功能列表:

名称 描述
路由 允许定义结构化路由和相关处理程序。
文件搜索工具 MCP工具,用于在文件中搜索关键字。

建筑与运营

要构建或运行项目,请使用以下任务之一:

任务 描述
./gradlew test 运行测试
./gradlew build 构建一切
./gradlew buildFatJar 构建包含所有依赖项的服务器的可执行JAR
./gradlew buildImage 构建docker镜像以与胖JAR一起使用
./gradlew publishImageToLocalRegistry 在本地发布docker镜像
./gradlew run 运行服务器
./gradlew runDocker 使用本地docker镜像运行

如果服务器成功启动,您将看到以下输出:

2024-12-04 14:32:45.584 [main] INFO  Application - Application started in 0.303 seconds.
2024-12-04 14:32:45.682 [main] INFO  Application - Responding at http://0.0.0.0:3001

MCP工具

文件搜索工具

文件搜索工具允许您在服务器文件系统上的文件中搜索关键字。

工具详细信息

  • 工具名称: search-file
  • 说明: 在文件中搜索关键字并返回匹配的行

输入参数

  • filePath (string,必填):要搜索的文件的路径
  • keyword (string,必填):要在文件中搜索的关键字

输出

该工具返回一个包含以下字段的JSON对象:

  • message:显示搜索结果的消息
  • matches:找到的匹配项数
  • results:一个包含以下内容的对象数组:
    • lineNumber:找到匹配项的行号
    • lineContent:包含匹配项的行的内容

光标使用示例

  1. 使用启动MCP服务器 ./gradlew run
  2. 在Cursor中,使用以下设置配置MCP服务器:
    {
        "mcpServers": {
            "file-system-mcp": {
                "url": "http://localhost:3001/sse"
            }
        }
    }
    
  3. 使用Cursor中的工具在文件中搜索关键字