AI导哈

关键词搜索工具

一个基于Model Context Protocol (MCP)的关键词搜索工具，提供在文件中搜索关键词的功能。

  • by alfaarghya
  • TypeScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 alfaarghya/mcp-keyword-search

使用说明

MCP关键字搜索

在文件中提供关键字搜索功能的模型上下文协议（MCP）服务器

🚀 安装

步骤1：克隆或创建项目

git clone https://github.com/alfaarghya/mcp-keyword-search
cd mcp-keyword-search

步骤2：安装依赖项

pnpm install

这将安装：

  • @modelcontextprotocol/sdk -MCP-SDK
  • @types/node -Node.js的TypeScript定义
  • typescript -TypeScript编译器

🔨 建设项目

将TypeScript编译为JavaScript：

pnpm run build

这创建了一个 dist/ 包含已编译JavaScript文件的文件夹。

发展模式 （根据更改自动重建）：

pnpm run dev

🧪 测试

使用MCP检查器

MCP检查器为测试提供了一个可视化的web界面。

步骤1：启动检查器

npx @modelcontextprotocol/inspector node dist/index.js

第二步：在浏览器中打开

导航到显示的URL

步骤3：测试工具

  1. 在web界面中，您将看到 “搜索文件” 在工具列表中
  2. 点击它展开输入表单
  3. 输入以下测试数据：
{
  "file_path": "./sample.txt",
  "keyword": "Hello",
  "case_sensitive": false
}
  1. 点击 “执行” 或 “运行工具”

预期产量：

Found 3 match(es) for "hello" in ./test.txt:

Line 1 (position 0): Hello World! This is a test file.
Line 3 (position 0): Hello again on line 3.
Line 5 (position 0): HELLO in uppercase.

🔧 API 参考

服务器信息

  • 名字: file-search-server
  • 版本: 1.0.0
  • 协议：模型上下文协议（MCP）
  • 运输标准： stdio

可用工具

search_file

在文件中搜索关键字。

输入架构：

{
  file_path: string;      // Required: Path to file
  keyword: string;        // Required: Search keyword
  case_sensitive?: boolean; // Optional: Case sensitivity (default: false)
}

输出：

  • 带有行号和位置的匹配行列表
  • 如果找不到文件或其他问题，则显示错误消息

相关 MCP