Skip to content

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

Description

@liplus-lin-lay

purpose

opt-in GraphRAG 層(#156 で追加、#158 で proxy 経由到達可能)の検索パラメータ graph_expand / graph_hops が、ユーザーが参照する README 群の search パラメータ表に未記載のドリフトを解消する。加えて英語 README の type 値表で wiki_doc(実在 type)が欠落しているのを補う。

premise

  • 要求仕様書(docs/0-requirements{,.ja}.md セクション8)には GraphRAG 層は反映済み。docs/0-requirements は触らない。
  • パラメータの literal は src/mcp.ts の zod 定義を正とする(確認済み: graph_expand boolean/optional/既定 false、graph_hops number/min 1/max 2/既定 1)。
  • wiki_doc type は src/mcp.ts に実在し、README.ja.md と npm README には既に記載済み。欠落しているのは英語 README.md のみ。

constraints

  • literal 以外を捏造しない。
  • 各表の既存の列構成・スタイルに正確に合わせる。
  • リリースはしない。docs のみ・observable 影響なし → patch 相当。

target files

  • 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〜2文追記

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsドキュメント変更(挙動への影響なし)ready本文が実装開始できる形まで収束している状態。ただし更新は継続可能

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions