ukagaka-doc-mcp 0.7.0 → 0.8.1

package/NOTICE.md

@@ -17,6 +17,7 @@ documentation sources, including:
 - YAYA docs (YAYA-shiori/yaya-docs)
 - 里々 docs (ukatech/satori-docs)
 - 蒼空(aosora) Wiki
+- 湊 docs (mizuki-yura/minato docs/src)
 
 This generated data is not re-licensed under the MIT License by this
 repository. It remains subject to the terms, permissions, and restrictions of

package/README.md

@@ -2,7 +2,7 @@
 
 伺か（Ukagaka）の技術ドキュメントを検索する MCP サーバーです。
 
-UKADOC・SSP ヘルプ・YAYA docs・里々 docs・蒼空 Wiki のスナップショットを同梱しており、stdio モード（デフォルト）では**ランタイムで外部ネットワークにアクセスしません**。
+UKADOC・SSP ヘルプ・YAYA docs・里々 docs・蒼空 Wiki・湊 docs のスナップショットを同梱しており、stdio モード（デフォルト）では**ランタイムで外部ネットワークにアクセスしません**。
 
 ## 使い方
 
@@ -85,6 +85,7 @@ npx ukagaka-doc-mcp --http --host 0.0.0.0 --port 9000   # listen 先を変更
 | YAYA docs（[yaya-docs](https://github.com/YAYA-shiori/yaya-docs)） | YAYA スクリプトのリファレンス |
 | 里々 docs（[satori-docs](https://github.com/ukatech/satori-docs)） | 里々スクリプト・ssu のリファレンス |
 | 蒼空(aosora) Wiki | 蒼空 shiori/GHOST 開発ガイド |
+| 湊 docs（[minato](https://mizuki-yura.github.io/minato/)） | 湊（Minato）SHIORI のリファレンス・里々/YAYA からの移行ガイド |
 
 `data/index.json` として同梱済みです。週1回 CI が自動更新します。
 
@@ -143,4 +144,4 @@ npm tarball に含まれるファイル：
 
 実装コードは **MIT License**（`LICENSE` 参照）。
 
-同梱の `data/index.json` は UKADOC・SSP ヘルプ・YAYA docs・里々 docs・蒼空 Wiki を元に生成した外部由来データです。MIT License での再ライセンスは行っていません。利用・再配布時は上流の権利関係を別途確認してください（`NOTICE.md` 参照）。
+同梱の `data/index.json` は UKADOC・SSP ヘルプ・YAYA docs・里々 docs・蒼空 Wiki・湊 docs を元に生成した外部由来データです。MIT License での再ライセンスは行っていません。利用・再配布時は上流の権利関係を別途確認してください（`NOTICE.md` 参照）。

package/SPEC.md

@@ -18,13 +18,14 @@
 
 ### 3.1 対象ソース
 
-本サーバーは以下の5ソースのみを対象とする。
+本サーバーは以下の6ソースのみを対象とする。
 
 1. UKADOC (`docs/ukadoc/manual/`)
 2. SSP ヘルプ (`docs/ukadoc/ssphelp_src/`、`https://ssp.shillest.net/ukadoc/ssphelp/`)
 3. YAYA docs (`docs/yaya-docs/`、`https://github.com/YAYA-shiori/yaya-docs`)
 4. 里々 docs (`docs/satori-docs/`、`https://github.com/ukatech/satori-docs`)
 5. 蒼空 Wiki (`https://github.com/kanadelab/aosora-shiori/wiki`)
+6. 湊 docs (`docs/minato/docs/src/`、`https://github.com/mizuki-yura/minato`)
 
 ### 3.2 非スコープ
 
@@ -46,7 +47,8 @@
 3. YAYA docs をローカルMarkdownからパースする
 4. 里々 docs をローカルMarkdownからパースする
 5. 蒼空 Wiki をGitHub Wiki取得してパースする
-6. 5ソースを統合して `data/index.json` を生成する
+6. 湊 docs をローカルMarkdownからパースする
+7. 6ソースを統合して `data/index.json` を生成する
 
 ### 4.2 ランタイム
 
@@ -62,7 +64,7 @@
 ### 5.1 Source
 
 ```ts
-type Source = 'ukadoc' | 'ssp_help' | 'yaya_docs' | 'satori_docs' | 'aosora_wiki';
+type Source = 'ukadoc' | 'ssp_help' | 'yaya_docs' | 'satori_docs' | 'aosora_wiki' | 'minato_docs';
 ```
 
 ### 5.2 Category
@@ -95,7 +97,13 @@ type Category =
   | 'satori_system'
   | 'satori_function'
   | 'satori_ssu'
-  | 'satori_other';
+  | 'satori_other'
+  | 'minato_startup'
+  | 'minato_basic'
+  | 'minato_grammar'
+  | 'minato_talk'
+  | 'minato_other'
+  | 'minato_migration';
 ```
 
 ### 5.3 DocEntry
@@ -110,6 +118,7 @@ type DocEntry = {
   category: Category;
   content: string;
   url: string;
+  rawUrl?: string;
 };
 ```
 
@@ -120,6 +129,7 @@ type DocEntry = {
 - `content` は全文でなければならない
 - `content` は保存時に要約化してはならない
 - `url` はそのエントリの元ページまたは元セクションを指さなければならない
+- `rawUrl` は元のソースが Markdown のソース（YAYA docs・里々 docs・蒼空 Wiki・湊 docs）の全エントリに付与し、元の Markdown を指さなければならない。元のソースが HTML のソース（UKADOC・SSP ヘルプ）には付与してはならない
 
 ### 5.4 SearchEntry
 
@@ -133,6 +143,7 @@ type SearchEntry = {
   category: Category;
   summary: string;
   url: string;
+  rawUrl?: string;
 };
 ```
 
@@ -144,6 +155,7 @@ type SearchEntry = {
 - 省略時の `summary` は `content.slice(0, 500) + "..."` と等価でなければならない
 - `summary` 生成時に改行や空白の追加正規化を行ってはならない
 - `summary` はインデックスの正規データではなく派生値であること
+- `rawUrl` は `DocEntry` に `rawUrl` がある場合に限り含めること
 
 ### 5.5 IndexFile
 
@@ -199,6 +211,12 @@ type IndexFile = {
 - `dir` はリポジトリ直下のディレクトリ名、`file_stem` は拡張子 `.md` を除いたファイル名とする
 - 各ディレクトリの `index.md` も本文を持つため取り込む（例: `satori:functions/index`）
 
+#### 湊 docs
+
+- 1ページ1エントリとし、`minato:{path}` とする（例: `minato:func/builtin`）
+- `path` は mdBook のソースディレクトリ `docs/src/` からの相対パスから拡張子 `.md` を除いたもの（例: `minato:include`、`minato:README`）とする
+- 対象ページは上流サイトの目次 `docs/src/SUMMARY.md` から決め、カテゴリは `path` の先頭要素から決める
+
 ## 7. 収集・正規化仕様
 
 ### 7.1 リンク正規化
@@ -286,7 +304,7 @@ Wikiリンクは取得前に正規化しなければならない。
 
 `npm run build:index` は、以下をすべて満たしたときのみ成功してよい。
 
-- 必須5ソースの取得・パースが完了している
+- 必須6ソースの取得・パースが完了している
 - 重複 `id` が存在しない
 - 無効ページが含まれていない
 - 各ソースが空でない
@@ -310,7 +328,7 @@ Wikiリンクは取得前に正規化しなければならない。
 
 ### 9.4 部分成功の禁止
 
-- UKADOC だけ成功、SSP ヘルプ/YAYA/里々/蒼空失敗のような部分成功を正規成果物として出力してはならない
+- UKADOC だけ成功、SSP ヘルプ/YAYA/里々/蒼空/湊失敗のような部分成功を正規成果物として出力してはならない
 - ビルドは fail-open ではなく fail-closed でなければならない
 
 ## 10. ランタイム仕様