Skip to content

docs(readme): document opt-in graph_expand / graph_hops and English wiki_doc type#162

Merged
liplus-lin-lay merged 1 commit into
mainfrom
161-readme-graph-params-wiki-doc
Jun 16, 2026
Merged

docs(readme): document opt-in graph_expand / graph_hops and English wiki_doc type#162
liplus-lin-lay merged 1 commit into
mainfrom
161-readme-graph-params-wiki-doc

Conversation

@liplus-lin-lay

Copy link
Copy Markdown
Member

概要

opt-in GraphRAG 層(#156 で追加、#158 で proxy 経由到達可能)の検索パラメータ graph_expand / graph_hops を、ユーザーが参照する README 群の search パラメータ表に追記する。あわせて英語 README の type 値表に欠落していた wiki_doc 行を補い、日本語版 / npm README との記載差を解消する。

変更内容

  • README.md(英語): #### Parameters 表に graph_expand / graph_hops の 2 行、#### type values 表に wiki_doc 行を追加。
  • README.ja.md(日本語): #### パラメータ 表に graph_expand / graph_hops の 2 行を追加(type 表には既に wiki_doc が有るため非対象)。
  • mcp-server/README.md(npm、英語): ## Tools exposedsearch 説明に opt-in の graph_expand / graph_hops(既定オフ)を 1 文追記。

根拠

パラメータの文言は src/mcp.ts の zod 定義(graph_expand boolean/optional/既定 false、graph_hops number/min 1/max 2/既定 1)を正とした。wiki_docsrc/mcp.ts に実在する type。

スコープ外

  • 要求仕様書 docs/0-requirements{,.ja}.md(セクション8)には GraphRAG 層が反映済みのため非対象。
  • docs のみで user/system observable な挙動変化なし → patch 相当。リリースは行わない。

Closes #161

…iki_doc type

opt-in GraphRAG 層(#156 / #158)の search パラメータ graph_expand /
graph_hops を、ユーザーが参照する README 群のパラメータ表に追記する。
英語 README の type 値表に欠落していた wiki_doc 行も補い、日本語版 /
npm README との記載差を解消する。文言は src/mcp.ts の zod 定義を正とした。

- README.md: Parameters 表に graph_expand / graph_hops、type 値表に wiki_doc
- README.ja.md: パラメータ表に graph_expand / graph_hops
- mcp-server/README.md: Tools exposed の search 説明に opt-in graph 拡張を1文追記

docs のみで observable 影響なし(patch 相当)。docs/0-requirements は反映済みのため非対象。

Closes #161
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
github-rag-mcp ad28da5 Jun 16 2026, 07:19 AM

@liplus-lin-lay liplus-lin-lay marked this pull request as ready for review June 16, 2026 07:20

@liplus-lin-lay liplus-lin-lay left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI self-review(auto モード)

検証した点

  • literal の正確性: graph_expand / graph_hops の文言は src/mcp.ts の zod .describe()(graph_expand: line 245-248、graph_hops: line 257)と意味的に一致。graph_expand boolean/optional/既定 false、graph_hops number/min 1/max 2/既定 1 を確認。捏造なし。
  • wiki_doc の実在: src/mcp.ts に type "wiki_doc" が実在(type enum line 164、行生成 line 466 ほか)。英語 README.md にのみ欠落していたのを補った。日本語版・npm README には既存のため非対象とした。
  • 表スタイルの整合: 各 README の既存列構成(英語 Name/Type/Description、日本語 名前/型/説明、type 値表)に正確に合わせ、include_content 行直後・"doc" 行直後の指定位置に挿入。
  • スコープ遵守: docs/0-requirements{,.ja}.md は反映済みのため未変更。実装コード(src/)も未変更。docs のみ。

影響範囲 / version 判断

docs のみ・user/system observable な挙動変化なし → release-version-rule.md に照らし patch 相当。リリースは行わない。

CI

test / CI / Workers Builds の 3 check すべて SUCCESS。

判定

APPROVE 相当。マージは親エージェントの判断に委ねる(本サブエージェントはマージしない)。

@liplus-lin-lay liplus-lin-lay merged commit 624cc87 into main Jun 16, 2026
3 checks passed
@liplus-lin-lay liplus-lin-lay deleted the 161-readme-graph-params-wiki-doc branch June 16, 2026 07:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(readme): document opt-in graph_expand / graph_hops and English wiki_doc type

1 participant