文件关键词搜索工具

一个基于MCP服务器的文件关键词搜索工具,支持大小写敏感和大小写不敏感搜索,返回匹配行号和内容。

  • by r1cksync
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 r1cksync/RESSL-MCP-SERVER

使用说明

MCP服务器-文件关键字搜索

该项目实现了一个模型上下文协议(MCP)服务器,其中包含一个在文件中搜索关键字的工具。

项目结构

ressl assignment/
├── backend/               # MCP Server implementation
│   ├── src/
│   │   ├── index.ts      # Main server entry point
│   │   └── fileSearch.ts # File search tool implementation
│   ├── package.json
│   ├── tsconfig.json
│   └── README.md         # Detailed backend documentation
├── frontend/             # (Reserved for future UI)
└── task.txt             # Project requirements

任务描述

任务:MCP服务器开发

  • 构建MCP服务器
  • 实现一个在文件中搜索指定关键字的工具

快速开始

  1. 导航到后端目录:

    cd backend
    
  2. 安装依赖项:

    npm install
    
  3. 构建项目:

    npm run build
    
  4. 运行服务器:

    npm start
    

特性

✅ 使用@modelcontextprotocol/sdk实现MCP服务器 ✅ 具有以下功能的文件关键字搜索工具:

  • 在任何文本文件中搜索指定的关键字
  • 区分大小写和不区分大小写的搜索模式
  • 返回带有突出显示匹配项的行号和内容
  • 每行处理多个匹配
  • 全面的错误处理

工具:搜索文件

所实现的工具允许在文件中搜索关键字:

参数:

  • filePath:要搜索的文件的路径
  • keyword:要搜索的关键字
  • caseSensitive:区分大小写搜索的可选布尔值(默认值:false)

退货:

  • 所有带有行号的匹配行
  • 用**标记突出显示的匹配项
  • 比赛总数

技术栈

  • 语言:TypeScript
  • 运行时:Node.js
  • MCP-SDK:@modelcontextprotocol/sdk
  • 模块系统:ES模块(ESM)

文档

有关MCP服务器实现的详细信息,请参阅 后端/README.md.

测试

测试文件提供于 backend/test-file.txt 用于测试搜索功能。

许可证

麻省理工学院