ukagaka-doc-mcp 0.6.1 → 0.7.0

package/NOTICE.md

@@ -13,8 +13,9 @@ License. See `LICENSE`.
 documentation sources, including:
 
 - UKADOC
+- SSP ヘルプ (ukatech/ukadoc ssphelp_src)
 - YAYA docs (YAYA-shiori/yaya-docs)
-- 里々Wiki
+- 里々 docs (ukatech/satori-docs)
 - 蒼空(aosora) Wiki
 
 This generated data is not re-licensed under the MIT License by this

package/README.md

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

package/SPEC.md

@@ -18,12 +18,13 @@
 
 ### 3.1 対象ソース
 
-本サーバーは以下の4ソースのみを対象とする。
+本サーバーは以下の5ソースのみを対象とする。
 
 1. UKADOC (`docs/ukadoc/manual/`)
-2. YAYA docs (`docs/yaya-docs/`、`https://github.com/YAYA-shiori/yaya-docs`)
-3. 里々Wiki (`https://soliton.sub.jp/satori/`)
-4. 蒼空 Wiki (`https://github.com/kanadelab/aosora-shiori/wiki`)
+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`)
 
 ### 3.2 非スコープ
 
@@ -41,10 +42,11 @@
 `npm run build:index` は以下を行う。
 
 1. UKADOC をローカルHTMLからパースする
-2. YAYA docs をローカルMarkdownからパースする
-3. 里々Wiki をHTTP取得してパースする
-4. 蒼空 Wiki をGitHub Wiki取得してパースする
-5. 4ソースを統合して `data/index.json` を生成する
+2. SSP ヘルプをローカルHTMLからパースする
+3. YAYA docs をローカルMarkdownからパースする
+4. 里々 docs をローカルMarkdownからパースする
+5. 蒼空 Wiki をGitHub Wiki取得してパースする
+6. 5ソースを統合して `data/index.json` を生成する
 
 ### 4.2 ランタイム
 
@@ -60,7 +62,7 @@
 ### 5.1 Source
 
 ```ts
-type Source = 'ukadoc' | 'yaya_docs' | 'satori_wiki' | 'aosora_wiki';
+type Source = 'ukadoc' | 'ssp_help' | 'yaya_docs' | 'satori_docs' | 'aosora_wiki';
 ```
 
 ### 5.2 Category
@@ -75,6 +77,11 @@ type Category =
   | 'protocol'
   | 'file_structure'
   | 'dev_guide'
+  | 'ssp_usage'
+  | 'ssp_feature'
+  | 'ssp_config'
+  | 'ssp_info'
+  | 'ssp_dev'
   | 'yaya_grammar'
   | 'yaya_basic'
   | 'yaya_function'
@@ -82,10 +89,13 @@ type Category =
   | 'yaya_tips'
   | 'yaya_startup'
   | 'yaya_other'
-  | 'satori_reference'
-  | 'satori_event'
-  | 'satori_tips'
-  | 'satori_saori';
+  | 'satori_startup'
+  | 'satori_grammar'
+  | 'satori_shiori'
+  | 'satori_system'
+  | 'satori_function'
+  | 'satori_ssu'
+  | 'satori_other';
 ```
 
 ### 5.3 DocEntry
@@ -172,16 +182,22 @@ type IndexFile = {
 - `normalized_raw_title` は安定した正規化文字列でなければならない
 - フォールバックは、記号除去や小文字化だけに依存してはならない
 
+#### SSP ヘルプ
+
+- 1ページ1エントリとし、`ssphelp:{place}` とする（例: `ssphelp:config-ghost`）
+- 対象ページとカテゴリは `ssphelp_builder/index.yaml` の目次から決める。`place` は目次の値（= 原稿ファイル名から `.html` を除いたもの）とする
+- 生成済みの `ssphelp/` ではなく、公開サイトの元になる原稿 `ssphelp_src/` を読む
+
 #### YAYA docs
 
 - 1ページ1エントリとし、`yaya:{dir}/{file_stem}` とする（例: `yaya:functions/REPLACE`）
 - `dir` はリポジトリ直下のディレクトリ名、`file_stem` は拡張子 `.md` を除いたファイル名とする
 
-#### 里々Wiki
+#### 里々 docs
 
-- ページ単位は `satori:{page_name}` とする
-- セクション分割ページは `satori:{page_name}#{anchor}` とする
-- `page_name` はURLデコード済みの論理ページ名とする
+- 1ページ1エントリとし、`satori:{dir}/{file_stem}` とする（例: `satori:functions/set`）
+- `dir` はリポジトリ直下のディレクトリ名、`file_stem` は拡張子 `.md` を除いたファイル名とする
+- 各ディレクトリの `index.md` も本文を持つため取り込む（例: `satori:functions/index`）
 
 ## 7. 収集・正規化仕様
 
@@ -270,7 +286,7 @@ Wikiリンクは取得前に正規化しなければならない。
 
 `npm run build:index` は、以下をすべて満たしたときのみ成功してよい。
 
-- 必須4ソースの取得・パースが完了している
+- 必須5ソースの取得・パースが完了している
 - 重複 `id` が存在しない
 - 無効ページが含まれていない
 - 各ソースが空でない
@@ -294,7 +310,7 @@ Wikiリンクは取得前に正規化しなければならない。
 
 ### 9.4 部分成功の禁止
 
-- UKADOC だけ成功、YAYA/里々/蒼空失敗のような部分成功を正規成果物として出力してはならない
+- UKADOC だけ成功、SSP ヘルプ/YAYA/里々/蒼空失敗のような部分成功を正規成果物として出力してはならない
 - ビルドは fail-open ではなく fail-closed でなければならない
 
 ## 10. ランタイム仕様