Skip to content

Index repository documentation (docs/, README) for semantic search #41

Closed

Description

@liplus-lin-lay

purpose

リポジトリ内のドキュメント(docs/、README等)をVectorizeにインデックスし、セマンティック検索の対象に加える。
現状はissue/PR/releaseのみが検索対象で、要件仕様やREADMEの内容は検索できない。

premise

  • GitHub Git Trees API (/repos/{owner}/{repo}/git/trees/{ref}?recursive=1) でリポジトリ全体のファイルツリーとSHAを1リクエストで取得可能 — 検証済み
  • Trees APIはETag条件付きリクエストをサポート(304 Not Modified) — 検証済み
  • ファイルのblob SHAが変わらなければ内容も同一(Gitの仕組み上保証)
  • GitHub Contents API (/repos/{owner}/{repo}/contents/{path}) でファイル内容を取得可能(base64エンコード)
  • 既存のVectorizeインデックスにドキュメントも同居可能(type: "doc", ベクトルID: {repo}#doc-{path})

constraints

  • ツリーSHA比較で変更検出(1 API call/repo)、変更時のみ個別ファイル取得
  • 対象ファイル: docs/**/*.md + README.md(パターンマッチ)
  • watermark namespace: docs:{repo} + 各ファイルのblob SHA保存
  • search_issues のtypeフィルタに doc を追加
  • list_recent_activity にドキュメント更新を含める
  • docs/0-requirements.md を実装に合わせて更新すること

target files

  • src/types.ts — DocRecordインターフェース追加、VectorMetadataのtype拡張
  • src/store.ts — docsテーブル追加 + CRUD + watermark拡張
  • src/poller.ts — pollDocs()追加(Trees API + Contents API、ETag対応)
  • src/mcp.ts — 既存ツールにドキュメント対応を統合
  • docs/0-requirements.md — ドキュメント検索の要件追記

Activity

  1. added this to the v0.3.0 milestone on Apr 6, 2026
  2. added
    enhancement新機能・改善要望
    memoメモとして開始した状態。見出しは必要なものだけでよい
    ready本文が実装開始できる形まで収束している状態。ただし更新は継続可能
    and removed
    memoメモとして開始した状態。見出しは必要なものだけでよい
    on Apr 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

enhancement新機能・改善要望ready本文が実装開始できる形まで収束している状態。ただし更新は継続可能

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions