文件关键词搜索服务

一个基于Model Context Protocol (MCP)的文件关键词搜索工具,用于在文件中查找关键词并返回匹配的行和列位置。

  • by programming-warrior
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 programming-warrior/keyword-search-mcp

使用说明

搜索文件MCP服务器

该项目实现了一个模型上下文协议(MCP)stdio服务器,该服务器提供了一个用于在文件中搜索关键字的单一工具。服务器是用TypeScript编写的,使用官方 模型上下文协议TypeScript SDK.

安装

npm install

构建

在运行服务器之前,将TypeScript源代码编译为JavaScript:

npm run build

编译后的输出被放置在 dist/ 目录。

运行服务器

构建后启动stdio服务器:

node dist/index.js

为了快速迭代,你可以直接运行TypeScript入口点:

npm run dev

要运行mcp检查器,请使用:

npm run inspect

可用工具

search_keyword

在文件中搜索关键字的出现,并返回每个匹配项的行和列。

参数 类型 默认值 说明
filePath string – 要检查的文件的相对或绝对路径。
keyword string – 要搜索的文本。
caseSensitive 布尔值 false 在以下情况下,将大写字母和小写字母视为不同的 true.

工具响应将每个匹配项列为 Line X, Column Y: <line contents>。如果匹配次数达到 maxMatches,回复指出结果被截断。