[OSS26] 关键词搜索代码 search_code_by_keyword

接口介绍

在指定代码仓库内按关键词检索代码,支持普通字符串与正则两种模式,返回所有命中的文件路径、行号与代码片段(含上下文行)。

工具名

search_code_by_keyword

背景与目标

很多程序分析场景的第一步是定位代码:LLM Agent 接到一个安全审计任务时,先要找到"潜在风险关键词"出现的位置(例如 Runtime.exec、eval、SELECT *)。这是程序分析 MCP 的基础能力,要求在指定本地仓库范围内可用,不依赖外部 SaaS。

目标:实现一个 MCP tool,接收关键词和(可选的)路径前缀,返回所有匹配位置 + 命中行片段。

输入参数

输出结构

{
  "total_matches": 42,
  "results": [
    {
      "file_path": "src/main/java/com/example/UserController.java",
      "line_number": 87,
      "column_start": 12,
      "column_end": 28,
      "line_content": "    Runtime.exec(userInput);",
      "context_before": ["    public void run(String userInput) {"],
      "context_after": ["    }"]
    }
  ]
}

验收标准

• 在 1k-file 中等仓库上搜索高频词响应 < 2s
• 二进制文件、.git/、node_modules/、target/ 默认排除
• 支持 path_prefix 过滤
• 单元测试覆盖:正则模式、大小写、空结果、超过 max_results 截断
• 与 bootstrap_mcp_framework 的注册机制对齐

预估工作量

1-2 人日

Start by locating the MCP tool registration mechanism used by bootstrap_mcp_framework and the project's unit-test layout. Implement the search_code_by_keyword entry point according to the listed inputs and output, then add tests for regex, case sensitivity, empty results, and max_results truncation. Done means the exclusions, path_prefix filtering, registration, and stated response-time target are covered.