From 8f25049718f2bc3f4ee823a4e4c2e3544256a728 Mon Sep 17 00:00:00 2001
From: Claude Lin & Lay <eightborder@gmail.com>
Date: Sat, 23 May 2026 19:59:39 +0900
Subject: [PATCH] docs(mcp-server): refresh npm README to reflect consolidated
 search tool (#151)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

`mcp-server/README.md` の "Tools exposed" セクションが旧 4 ツール構成
(`search` / `get_issue_context` / `get_doc_content` / `list_recent_activity`) のまま
残っていたため、#105 で統合 (#127 で改名) された単一 `search` ツール構成に揃える。

- "Tools exposed" の表を consolidated `search` ベースに置き換え (3 modes と
  type 値の列挙を含む)
- 廃止済みツール名は変更履歴の文脈でのみ言及
- 冒頭のサポート範囲記述に comment / review 面 (issue_comment /
  pr_review / pr_review_comment) を追記し manifest.json と整合
- 詳細パラメータは main repo README にリンク

Refs: #105 #127 #129
---
 mcp-server/README.md | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/mcp-server/README.md b/mcp-server/README.md
index beb735a..b1968c6 100644
--- a/mcp-server/README.md
+++ b/mcp-server/README.md
@@ -1,6 +1,6 @@
 # github-rag-mcp
 
-Stdio MCP proxy that bridges local MCP clients (Claude Desktop, Claude Code, etc.) to a remote [github-rag-mcp](https://github.com/Liplus-Project/github-rag-mcp) Cloudflare Worker for semantic and structured search over GitHub issues, pull requests, releases, documentation, GitHub Wiki pages, and commit diffs.
+Stdio MCP proxy that bridges local MCP clients (Claude Desktop, Claude Code, etc.) to a remote [github-rag-mcp](https://github.com/Liplus-Project/github-rag-mcp) Cloudflare Worker for semantic and structured search over GitHub issues, pull requests, releases, documentation, GitHub Wiki pages, commit diffs, and comment / review surfaces (issue/PR top-level comments, PR review bodies, PR inline review comments).
 
 This package is the **client-side proxy only**. The actual indexing pipeline (Vectorize + D1 FTS5 + Workers AI BGE-M3 + cross-encoder rerank) runs on the Worker. See the [main repository](https://github.com/Liplus-Project/github-rag-mcp) for architecture and self-hosting instructions.
 
@@ -88,14 +88,15 @@ Delete these files to force a fresh authorization flow.
 
 ## Tools exposed
 
+A single consolidated tool, `search`, covers every retrieval mode. Earlier builds split these across `get_issue_context`, `get_doc_content`, and `list_recent_activity`; those tools have been removed and their use cases now fold into the parameters of `search`.
+
 | Tool | Description |
 |---|---|
-| `search` | 3-tier hybrid search (dense BGE-M3 + sparse BM25 + cross-encoder rerank) over issues, pull requests, releases, documentation, **GitHub Wiki pages**, and commit diffs, with structured filters (`repo`, `state`, `labels`, `milestone`, `assignee`, `type`, `top_k`, `fusion`, `rerank`). |
-| `get_issue_context` | Aggregated state for a single issue or PR, including related PRs, branch, and CI status. |
-| `get_doc_content` | Fetch the raw content of a `.md` document from a tracked repository (use after `search` with `type: "doc"`). |
-| `list_recent_activity` | Recent created / updated / closed activity across tracked repositories. |
+| `search` | Unified search across GitHub issues, pull requests, releases, repository documentation, **GitHub Wiki pages**, commit diffs, and comment / review surfaces. Three modes are selected by the combination of `query` and `sort`: (1) **hybrid semantic search** — dense BGE-M3 over Vectorize + sparse BM25 over D1 FTS5, fused via RRF, then re-scored with the `bge-reranker-base` cross-encoder; (2) **time-ordered activity scan** — leave `query` empty and set `sort` to `updated_desc` / `created_desc`, optionally narrowed with `since` / `until`; (3) **doc / wiki content fetch** — set `include_content: true` to inline raw markup on top `doc` and `wiki_doc` rows. Structured filters (`repo`, `state`, `labels`, `milestone`, `assignee`, `type`, `top_k`, `fusion`, `rerank`) apply in every mode. |
+
+The `type` filter accepts: `issue`, `pull_request`, `release`, `doc`, `wiki_doc`, `diff`, `issue_comment`, `pr_review`, `pr_review_comment`, or `all` (default).
 
-All tools are read-only.
+`search` is read-only. For the full parameter reference and examples, see the [main repository README](https://github.com/Liplus-Project/github-rag-mcp#search).
 
 ## Authentication flow