rag-nextjs 1.0.0__tar.gz

rag_nextjs-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

rag_nextjs-1.0.0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: rag-nextjs
+Version: 1.0.0
+Summary: Next.js 公式ドキュメント RAG CLI (next-devtools-mcp)
+Author-email: econanringo <151092188+econanringo@users.noreply.github.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: openai>=1.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: mcp>=1.27.0
+Dynamic: license-file
+
+# Next.js 公式ドキュメント RAG（next-devtools-mcp）
+
+[公式の `next-devtools-mcp`](https://www.npmjs.com/package/next-devtools-mcp) を経由して Next.js の公式ドキュメントを取得し、その内容だけを根拠に質問に答える Python の CLI です。MCP の `nextjs_docs` と `nextjs-docs://llms-index` を使うため、検索対象は常に公式が配布するインデックス／本文に沿います。
+
+## 前提条件
+
+- **Python 3.10+**（プロジェクトでは 3.14 付近で動作確認）
+- **Node.js と `npx`**（MCP サーバーを `npx -y next-devtools-mcp` で起動するため）
+- **OpenAI 互換の Chat API** に渡せる API キー（例: [NVIDIA Integrate API](https://build.nvidia.com/)）
+
+## セットアップ
+
+```bash
+cd /path/to/rag
+python3 -m venv venv
+source venv/bin/activate   # Windows: venv\Scripts\activate
+pip install -r requirements.txt
+
+# （推奨）パスを通さなくても `rag-nextjs` で起動できるようにする
+pip install -e .
+```
+
+環境変数用に `.env` を用意します。
+
+```bash
+cp .env.example .env
+# .env を編集して API キーなどを設定
+```
+
+## 環境変数
+
+| 変数 | 必須 | 説明 |
+|------|------|------|
+| `NVIDIA_API_KEY` または `OPENAI_API_KEY` | はい | Chat API 用のキー |
+| `NVIDIA_OPENAI_BASE_URL` または `OPENAI_BASE_URL` | 推奨 | 互換 API のベース URL（NVIDIA 利用時は `.env.example` の URL を参照） |
+| `CHAT_MODEL` | いいえ | 既定: `nvidia/nemotron-3-nano-30b-a3b` |
+| `CHAT_TEMPERATURE` | いいえ | 既定: `0.2` |
+| `CHAT_EXTRA_BODY` | いいえ | `extra_body` に渡す JSON（例: Nemotron の推論オプション）。1 行の JSON 文字列 |
+| `CHAT_STREAM` | いいえ | `1` / `true` / `yes` / `on` でストリーミング（既定）。`0` など falsy で常に **非ストリーミング** のみ送信 |
+| `CHAT_STREAM_FALLBACK` | いいえ | 既定オン。ストリームを最後まで読んでも表示用テキストが一度も出ないとき、同じ入力で **非ストリーミングを 1 回** 試す |
+| `CHAT_SHOW_REASONING` | いいえ | 既定オフ。オンにすると `reasoning_content` 等の **推論テキストも標準出力**に流す。推論付きモデルの通常利用ではオフのままがよい |
+| `CHAT_MAX_TOKENS` | いいえ | 設定時のみ、`max_tokens` としてリクエストに付与 |
+| `CHAT_STREAM_INCLUDE_USAGE` | いいえ | オン時、ストリーミング要求に `stream_options: {"include_usage": true}` を付与（使用量を最終チャンクで受け取る用途） |
+| `CHAT_HTTP_TIMEOUT_SECONDS` | いいえ | 読み取り込みを含む HTTP タイムアウト（秒）。既定: `600` |
+| `OPENAI_TIMEOUT` または `HTTP_TIMEOUT` | いいえ | 上記と同目的。評価は **`OPENAI_TIMEOUT` → `HTTP_TIMEOUT` → `CHAT_HTTP_TIMEOUT_SECONDS`** の先勝ち |
+| `CHAT_HTTP_CONNECT_SECONDS` | いいえ | 接続確立までのタイムアウト（秒）。既定: `30`（遅い TLS でも切れにくくするため） |
+| `NEXTJS_MCP_COMMAND` | いいえ | MCP 起動コマンド（シェルと同様に空白区切り）。既定: `npx -y next-devtools-mcp` |
+| `RAG_TOP_K` | いいえ | `--top-k` の既定値（ページ取得数）。既定: `4` |
+| `RAG_SPINNER` | いいえ | 進捗行のブラケット／スピナーアニメーション。既定オン（`1`）。`0` でアニメーションを無効にし、必要なときのみプレーンな `[nextjs-rag]` 行になる |
+| `RAG_SPINNER_FORCE` | いいえ | `1` のとき **TTY でなくても** スピナーを描画（パイプ先が端末など特殊なとき向け）。既定オフ |
+| `RAG_QUIET` | いいえ | `1` のとき **進捗表示をすべて出さない**（`-q` と同様の効果）。コマンドラインの `-q` と併用すると、どちらかが真なら抑止されます |
+
+### Chat API（モデル差の吸収）
+
+OpenAI の Chat Completions 互換エンドポイントを前提にしています。プロバイダやモデルによって次のような差があります。
+
+- **ストリーム本文の欠落** … ゲートウェイ側でストリーミングの `delta` に本文が載らない場合がある → 既定では `CHAT_STREAM_FALLBACK` により **非ストリームで再試行**。
+- **推論フィールドの名称** … `reasoning_content` 以外に `reasoning` / `thinking` / `thought` などで返す API がある → **既定ではユーザー向け回答の `content`（と `refusal`）だけ**を標準出力へ出し、推論は出しません。デバッグで推論も見たいときは `CHAT_SHOW_REASONING=1` を指定してください。
+- **`content` の形** … 文字列だけでなく、`type: "text"` のブロックの配列で返す実装に対応します。
+
+大規模モデル（例: `nvidia/nemotron-3-super-120b-a12b`）は **最初のトークンまで数十秒〜数分かかる**ことがあります。ログに path が出たあと無言に見える場合は、しばらく待つか、`CHAT_HTTP_TIMEOUT_SECONDS` をさらに延ばしてください。ストリームが不安定なら `CHAT_STREAM=0` で非ストリーム固定にすると確実です。
+
+## 使い方
+
+開発用にリポジトリへ **editable install** した場合（`pip install -e .`）、どこからでも次のように起動できます。
+
+```bash
+rag-nextjs "App Router で Server Actions を使うには？"
+```
+
+リポジトリ直下では従来どおり次も同じです（`main.py` に shebang があるため `./main.py` も可）。
+
+```bash
+python main.py "App Router で Server Actions を使うには？"
+python -m rag_nextjs "App Router で Server Actions を使うには？"
+./main.py --help
+```
+
+取得するドキュメントページ数を増やす:
+
+```bash
+python main.py --top-k 5 "キャッシュの revalidate について"
+rag-nextjs --top-k 5 "キャッシュの revalidate について"
+```
+
+ヘルプ:
+
+```bash
+rag-nextjs --help
+python -m rag_nextjs --help
+python main.py --help
+```
+
+進捗は **標準エラー出力** に表示されます（処理中は `⠋ …` のようなアニメーションと、フェーズごとの説明。**ドキュメント取得中は何件目・どの path か**もここで更新されます。**モデル応答の初回トークン待ち**でも同様にスピナーを出します）。
+
+**標準出力**には、`取得したドキュメント path: …` と空行のあと、続けて **回答本文**がストリーミングされます。回答だけファイルに残したいときは `2>/dev/null` で stderr を捨てるか、path 行を除去する必要があります。
+
+```bash
+rag-nextjs "質問…" 2>/dev/null > answer.txt
+```
+
+ログを抑えたいときは `-q` / `--quiet` または環境変数 `RAG_QUIET=1` を指定してください。回答は **できる限りストリーミング** され、非対応時は `CHAT_STREAM_FALLBACK` で非ストリーム再試行があります（オフにすると `CHAT_STREAM_FALLBACK=0`）。
+
+## 動作の流れ（概要）
+
+1. 子プロセスで `next-devtools-mcp` を起動し、MCP セッションを確立する。
+2. リソース `nextjs-docs://llms-index` で公式インデックス（`llms.txt` 相当）を読む。
+3. 質問文とインデックス行の単語重なりで、関連しそうなドキュメント path を最大 `top_k` 件選ぶ。
+4. 各 path に対してツール `nextjs_docs` で本文を取得する。
+5. 取得本文をコンテキストとして、設定した Chat モデルに送り、回答を生成する。
+
+LLM は可能なら **ストリーミング** で逐次標準出力に表示し、(5) が本文ゼロで終わった場合のみ **同一プロンプトを非ストリーミングで再実行**します（`CHAT_STREAM_FALLBACK` がオンで、`CHAT_STREAM` がオンのとき）。進捗の見た目は stderr のスピナーが担います。
+
+インデックス説明が英語中心のため、日本語のみの短い質問だと取得 path が外れやすい場合があります。そのときは **`--top-k` を大きくする**か、ドキュメントで使われている用語（Server Actions、Route Handler など）を混ぜてみてください。
+
+この README の対象は **公式サイトのドキュメントを読む**経路です。
+
+- **`nextjs_docs` / `llms-index`** … nextjs.org の公式ドキュメントに基づいて答える（本プロジェクトが利用）。
+- **`nextjs_index` / `nextjs_call`** … ローカルで動いている **Next.js 16 以降の開発サーバー**の MCP（`/_next/mcp`）に接続し、コンパイルエラーやルート情報など**実行中アプリの状態**を調べる用途。
+
+アプリのランタイム診断まで Python から行いたい場合は、別途 dev サーバーを起動したうえで、そのツール群を呼び出す実装が必要になります。
+
+## トラブルシューティング
+
+- **`npx` が見つからない** … Node.js をインストールし、`NEXTJS_MCP_COMMAND` でフルパスの `npx` を指定するか、`PATH` を通してください。
+- **`next-devtools-mcp` の起動に失敗する** … ネットワークで npm レジストリに届くか、`npx -y next-devtools-mcp` を手動で実行できるか確認してください。
+- **関連ドキュメントが取得できない** … 質問を変える、`--top-k` を増やす、英語キーワードを足す。
+- **API エラー** … `.env` のベース URL・モデル名・キーが、そのプロバイダの OpenAI 互換仕様と一致しているか確認してください。
+- **回答がずっと出ない（path のあとで止まる）** … stderr に「モデル応答を待機中…」のスピナーが動いていれば、まだ初回トークン待ちです。大モデルは数十秒〜かかることがあります。標準エラーを見ていないターミナルでは `2>&1 | tee log.txt` などで確認してください。長すぎる場合は `CHAT_HTTP_TIMEOUT_SECONDS` を延ばす。ストリームが空のまま終わる API では `CHAT_STREAM_FALLBACK`（既定オン）で非ストリームに切り替わるはずなので、それでもダメなら `CHAT_STREAM=0` や `CHAT_MAX_TOKENS` / `CHAT_EXTRA_BODY` でプロバイダ必須パラメータを渡す。
+
+## ライセンス
+
+リポジトリ側のライセンスに従ってください。`next-devtools-mcp` 本体は npm パッケージのライセンス（MIT）が適用されます。

rag_nextjs-1.0.0/README.md

@@ -0,0 +1,133 @@
+# Next.js 公式ドキュメント RAG（next-devtools-mcp）
+
+[公式の `next-devtools-mcp`](https://www.npmjs.com/package/next-devtools-mcp) を経由して Next.js の公式ドキュメントを取得し、その内容だけを根拠に質問に答える Python の CLI です。MCP の `nextjs_docs` と `nextjs-docs://llms-index` を使うため、検索対象は常に公式が配布するインデックス／本文に沿います。
+
+## 前提条件
+
+- **Python 3.10+**（プロジェクトでは 3.14 付近で動作確認）
+- **Node.js と `npx`**（MCP サーバーを `npx -y next-devtools-mcp` で起動するため）
+- **OpenAI 互換の Chat API** に渡せる API キー（例: [NVIDIA Integrate API](https://build.nvidia.com/)）
+
+## セットアップ
+
+```bash
+cd /path/to/rag
+python3 -m venv venv
+source venv/bin/activate   # Windows: venv\Scripts\activate
+pip install -r requirements.txt
+
+# （推奨）パスを通さなくても `rag-nextjs` で起動できるようにする
+pip install -e .
+```
+
+環境変数用に `.env` を用意します。
+
+```bash
+cp .env.example .env
+# .env を編集して API キーなどを設定
+```
+
+## 環境変数
+
+| 変数 | 必須 | 説明 |
+|------|------|------|
+| `NVIDIA_API_KEY` または `OPENAI_API_KEY` | はい | Chat API 用のキー |
+| `NVIDIA_OPENAI_BASE_URL` または `OPENAI_BASE_URL` | 推奨 | 互換 API のベース URL（NVIDIA 利用時は `.env.example` の URL を参照） |
+| `CHAT_MODEL` | いいえ | 既定: `nvidia/nemotron-3-nano-30b-a3b` |
+| `CHAT_TEMPERATURE` | いいえ | 既定: `0.2` |
+| `CHAT_EXTRA_BODY` | いいえ | `extra_body` に渡す JSON（例: Nemotron の推論オプション）。1 行の JSON 文字列 |
+| `CHAT_STREAM` | いいえ | `1` / `true` / `yes` / `on` でストリーミング（既定）。`0` など falsy で常に **非ストリーミング** のみ送信 |
+| `CHAT_STREAM_FALLBACK` | いいえ | 既定オン。ストリームを最後まで読んでも表示用テキストが一度も出ないとき、同じ入力で **非ストリーミングを 1 回** 試す |
+| `CHAT_SHOW_REASONING` | いいえ | 既定オフ。オンにすると `reasoning_content` 等の **推論テキストも標準出力**に流す。推論付きモデルの通常利用ではオフのままがよい |
+| `CHAT_MAX_TOKENS` | いいえ | 設定時のみ、`max_tokens` としてリクエストに付与 |
+| `CHAT_STREAM_INCLUDE_USAGE` | いいえ | オン時、ストリーミング要求に `stream_options: {"include_usage": true}` を付与（使用量を最終チャンクで受け取る用途） |
+| `CHAT_HTTP_TIMEOUT_SECONDS` | いいえ | 読み取り込みを含む HTTP タイムアウト（秒）。既定: `600` |
+| `OPENAI_TIMEOUT` または `HTTP_TIMEOUT` | いいえ | 上記と同目的。評価は **`OPENAI_TIMEOUT` → `HTTP_TIMEOUT` → `CHAT_HTTP_TIMEOUT_SECONDS`** の先勝ち |
+| `CHAT_HTTP_CONNECT_SECONDS` | いいえ | 接続確立までのタイムアウト（秒）。既定: `30`（遅い TLS でも切れにくくするため） |
+| `NEXTJS_MCP_COMMAND` | いいえ | MCP 起動コマンド（シェルと同様に空白区切り）。既定: `npx -y next-devtools-mcp` |
+| `RAG_TOP_K` | いいえ | `--top-k` の既定値（ページ取得数）。既定: `4` |
+| `RAG_SPINNER` | いいえ | 進捗行のブラケット／スピナーアニメーション。既定オン（`1`）。`0` でアニメーションを無効にし、必要なときのみプレーンな `[nextjs-rag]` 行になる |
+| `RAG_SPINNER_FORCE` | いいえ | `1` のとき **TTY でなくても** スピナーを描画（パイプ先が端末など特殊なとき向け）。既定オフ |
+| `RAG_QUIET` | いいえ | `1` のとき **進捗表示をすべて出さない**（`-q` と同様の効果）。コマンドラインの `-q` と併用すると、どちらかが真なら抑止されます |
+
+### Chat API（モデル差の吸収）
+
+OpenAI の Chat Completions 互換エンドポイントを前提にしています。プロバイダやモデルによって次のような差があります。
+
+- **ストリーム本文の欠落** … ゲートウェイ側でストリーミングの `delta` に本文が載らない場合がある → 既定では `CHAT_STREAM_FALLBACK` により **非ストリームで再試行**。
+- **推論フィールドの名称** … `reasoning_content` 以外に `reasoning` / `thinking` / `thought` などで返す API がある → **既定ではユーザー向け回答の `content`（と `refusal`）だけ**を標準出力へ出し、推論は出しません。デバッグで推論も見たいときは `CHAT_SHOW_REASONING=1` を指定してください。
+- **`content` の形** … 文字列だけでなく、`type: "text"` のブロックの配列で返す実装に対応します。
+
+大規模モデル（例: `nvidia/nemotron-3-super-120b-a12b`）は **最初のトークンまで数十秒〜数分かかる**ことがあります。ログに path が出たあと無言に見える場合は、しばらく待つか、`CHAT_HTTP_TIMEOUT_SECONDS` をさらに延ばしてください。ストリームが不安定なら `CHAT_STREAM=0` で非ストリーム固定にすると確実です。
+
+## 使い方
+
+開発用にリポジトリへ **editable install** した場合（`pip install -e .`）、どこからでも次のように起動できます。
+
+```bash
+rag-nextjs "App Router で Server Actions を使うには？"
+```
+
+リポジトリ直下では従来どおり次も同じです（`main.py` に shebang があるため `./main.py` も可）。
+
+```bash
+python main.py "App Router で Server Actions を使うには？"
+python -m rag_nextjs "App Router で Server Actions を使うには？"
+./main.py --help
+```
+
+取得するドキュメントページ数を増やす:
+
+```bash
+python main.py --top-k 5 "キャッシュの revalidate について"
+rag-nextjs --top-k 5 "キャッシュの revalidate について"
+```
+
+ヘルプ:
+
+```bash
+rag-nextjs --help
+python -m rag_nextjs --help
+python main.py --help
+```
+
+進捗は **標準エラー出力** に表示されます（処理中は `⠋ …` のようなアニメーションと、フェーズごとの説明。**ドキュメント取得中は何件目・どの path か**もここで更新されます。**モデル応答の初回トークン待ち**でも同様にスピナーを出します）。
+
+**標準出力**には、`取得したドキュメント path: …` と空行のあと、続けて **回答本文**がストリーミングされます。回答だけファイルに残したいときは `2>/dev/null` で stderr を捨てるか、path 行を除去する必要があります。
+
+```bash
+rag-nextjs "質問…" 2>/dev/null > answer.txt
+```
+
+ログを抑えたいときは `-q` / `--quiet` または環境変数 `RAG_QUIET=1` を指定してください。回答は **できる限りストリーミング** され、非対応時は `CHAT_STREAM_FALLBACK` で非ストリーム再試行があります（オフにすると `CHAT_STREAM_FALLBACK=0`）。
+
+## 動作の流れ（概要）
+
+1. 子プロセスで `next-devtools-mcp` を起動し、MCP セッションを確立する。
+2. リソース `nextjs-docs://llms-index` で公式インデックス（`llms.txt` 相当）を読む。
+3. 質問文とインデックス行の単語重なりで、関連しそうなドキュメント path を最大 `top_k` 件選ぶ。
+4. 各 path に対してツール `nextjs_docs` で本文を取得する。
+5. 取得本文をコンテキストとして、設定した Chat モデルに送り、回答を生成する。
+
+LLM は可能なら **ストリーミング** で逐次標準出力に表示し、(5) が本文ゼロで終わった場合のみ **同一プロンプトを非ストリーミングで再実行**します（`CHAT_STREAM_FALLBACK` がオンで、`CHAT_STREAM` がオンのとき）。進捗の見た目は stderr のスピナーが担います。
+
+インデックス説明が英語中心のため、日本語のみの短い質問だと取得 path が外れやすい場合があります。そのときは **`--top-k` を大きくする**か、ドキュメントで使われている用語（Server Actions、Route Handler など）を混ぜてみてください。
+
+この README の対象は **公式サイトのドキュメントを読む**経路です。
+
+- **`nextjs_docs` / `llms-index`** … nextjs.org の公式ドキュメントに基づいて答える（本プロジェクトが利用）。
+- **`nextjs_index` / `nextjs_call`** … ローカルで動いている **Next.js 16 以降の開発サーバー**の MCP（`/_next/mcp`）に接続し、コンパイルエラーやルート情報など**実行中アプリの状態**を調べる用途。
+
+アプリのランタイム診断まで Python から行いたい場合は、別途 dev サーバーを起動したうえで、そのツール群を呼び出す実装が必要になります。
+
+## トラブルシューティング
+
+- **`npx` が見つからない** … Node.js をインストールし、`NEXTJS_MCP_COMMAND` でフルパスの `npx` を指定するか、`PATH` を通してください。
+- **`next-devtools-mcp` の起動に失敗する** … ネットワークで npm レジストリに届くか、`npx -y next-devtools-mcp` を手動で実行できるか確認してください。
+- **関連ドキュメントが取得できない** … 質問を変える、`--top-k` を増やす、英語キーワードを足す。
+- **API エラー** … `.env` のベース URL・モデル名・キーが、そのプロバイダの OpenAI 互換仕様と一致しているか確認してください。
+- **回答がずっと出ない（path のあとで止まる）** … stderr に「モデル応答を待機中…」のスピナーが動いていれば、まだ初回トークン待ちです。大モデルは数十秒〜かかることがあります。標準エラーを見ていないターミナルでは `2>&1 | tee log.txt` などで確認してください。長すぎる場合は `CHAT_HTTP_TIMEOUT_SECONDS` を延ばす。ストリームが空のまま終わる API では `CHAT_STREAM_FALLBACK`（既定オン）で非ストリームに切り替わるはずなので、それでもダメなら `CHAT_STREAM=0` や `CHAT_MAX_TOKENS` / `CHAT_EXTRA_BODY` でプロバイダ必須パラメータを渡す。
+
+## ライセンス
+
+リポジトリ側のライセンスに従ってください。`next-devtools-mcp` 本体は npm パッケージのライセンス（MIT）が適用されます。

rag_nextjs-1.0.0/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rag-nextjs"
+version = "1.0.0"
+description = "Next.js 公式ドキュメント RAG CLI (next-devtools-mcp)"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+  "openai>=1.0.0",
+  "python-dotenv>=1.0.0",
+  "mcp>=1.27.0",
+]
+authors = [{name = "econanringo", email = "151092188+econanringo@users.noreply.github.com"}]
+
+[project.scripts]
+rag-nextjs = "rag_nextjs.cli:main"
+
+[tool.setuptools.packages.find]
+include = ["rag_nextjs"]

rag_nextjs-1.0.0/rag_nextjs/__init__.py

@@ -0,0 +1 @@
+"""Next.js 公式ドキュメントを next-devtools-mcp 経由で取得する RAG 用パッケージ。"""

rag_nextjs-1.0.0/rag_nextjs/__main__.py

@@ -0,0 +1,4 @@
+from rag_nextjs.cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())