ukagaka-doc-mcp 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/NOTICE.md +1 -0
- package/README.md +3 -2
- package/SPEC.md +20 -6
- package/data/index.json +460 -1
- package/dist/build-index.d.ts +1 -1
- package/dist/build-index.js +8 -1
- package/dist/build-index.js.map +1 -1
- package/dist/constants.d.ts +25 -1
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +26 -1
- package/dist/constants.js.map +1 -1
- package/dist/index-builder.js +1 -1
- package/dist/index-builder.js.map +1 -1
- package/dist/parser/markdown.d.ts +1 -1
- package/dist/parser/markdown.js +1 -1
- package/dist/parser/minato-docs-parser.d.ts +34 -0
- package/dist/parser/minato-docs-parser.d.ts.map +1 -0
- package/dist/parser/minato-docs-parser.js +112 -0
- package/dist/parser/minato-docs-parser.js.map +1 -0
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +2 -1
- package/dist/server.js.map +1 -1
- package/dist/tools/get-doc.js +1 -1
- package/dist/tools/get-doc.js.map +1 -1
- package/dist/tools/search-docs.js +1 -1
- package/dist/tools/search-docs.js.map +1 -1
- package/dist/types.d.ts +2 -1
- package/dist/types.d.ts.map +1 -1
- package/package.json +4 -3
package/NOTICE.md
CHANGED
|
@@ -17,6 +17,7 @@ documentation sources, including:
|
|
|
17
17
|
- YAYA docs (YAYA-shiori/yaya-docs)
|
|
18
18
|
- 里々 docs (ukatech/satori-docs)
|
|
19
19
|
- 蒼空(aosora) Wiki
|
|
20
|
+
- 湊 docs (mizuki-yura/minato docs/src)
|
|
20
21
|
|
|
21
22
|
This generated data is not re-licensed under the MIT License by this
|
|
22
23
|
repository. It remains subject to the terms, permissions, and restrictions of
|
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
伺か(Ukagaka)の技術ドキュメントを検索する MCP サーバーです。
|
|
4
4
|
|
|
5
|
-
UKADOC・SSP ヘルプ・YAYA docs・里々 docs・蒼空 Wiki のスナップショットを同梱しており、stdio モード(デフォルト)では**ランタイムで外部ネットワークにアクセスしません**。
|
|
5
|
+
UKADOC・SSP ヘルプ・YAYA docs・里々 docs・蒼空 Wiki・湊 docs のスナップショットを同梱しており、stdio モード(デフォルト)では**ランタイムで外部ネットワークにアクセスしません**。
|
|
6
6
|
|
|
7
7
|
## 使い方
|
|
8
8
|
|
|
@@ -85,6 +85,7 @@ npx ukagaka-doc-mcp --http --host 0.0.0.0 --port 9000 # listen 先を変更
|
|
|
85
85
|
| YAYA docs([yaya-docs](https://github.com/YAYA-shiori/yaya-docs)) | YAYA スクリプトのリファレンス |
|
|
86
86
|
| 里々 docs([satori-docs](https://github.com/ukatech/satori-docs)) | 里々スクリプト・ssu のリファレンス |
|
|
87
87
|
| 蒼空(aosora) Wiki | 蒼空 shiori/GHOST 開発ガイド |
|
|
88
|
+
| 湊 docs([minato](https://mizuki-yura.github.io/minato/)) | 湊(Minato)SHIORI のリファレンス・里々/YAYA からの移行ガイド |
|
|
88
89
|
|
|
89
90
|
`data/index.json` として同梱済みです。週1回 CI が自動更新します。
|
|
90
91
|
|
|
@@ -143,4 +144,4 @@ npm tarball に含まれるファイル:
|
|
|
143
144
|
|
|
144
145
|
実装コードは **MIT License**(`LICENSE` 参照)。
|
|
145
146
|
|
|
146
|
-
同梱の `data/index.json` は UKADOC・SSP ヘルプ・YAYA docs・里々 docs・蒼空 Wiki を元に生成した外部由来データです。MIT License での再ライセンスは行っていません。利用・再配布時は上流の権利関係を別途確認してください(`NOTICE.md` 参照)。
|
|
147
|
+
同梱の `data/index.json` は UKADOC・SSP ヘルプ・YAYA docs・里々 docs・蒼空 Wiki・湊 docs を元に生成した外部由来データです。MIT License での再ライセンスは行っていません。利用・再配布時は上流の権利関係を別途確認してください(`NOTICE.md` 参照)。
|
package/SPEC.md
CHANGED
|
@@ -18,13 +18,14 @@
|
|
|
18
18
|
|
|
19
19
|
### 3.1 対象ソース
|
|
20
20
|
|
|
21
|
-
本サーバーは以下の
|
|
21
|
+
本サーバーは以下の6ソースのみを対象とする。
|
|
22
22
|
|
|
23
23
|
1. UKADOC (`docs/ukadoc/manual/`)
|
|
24
24
|
2. SSP ヘルプ (`docs/ukadoc/ssphelp_src/`、`https://ssp.shillest.net/ukadoc/ssphelp/`)
|
|
25
25
|
3. YAYA docs (`docs/yaya-docs/`、`https://github.com/YAYA-shiori/yaya-docs`)
|
|
26
26
|
4. 里々 docs (`docs/satori-docs/`、`https://github.com/ukatech/satori-docs`)
|
|
27
27
|
5. 蒼空 Wiki (`https://github.com/kanadelab/aosora-shiori/wiki`)
|
|
28
|
+
6. 湊 docs (`docs/minato/docs/src/`、`https://github.com/mizuki-yura/minato`)
|
|
28
29
|
|
|
29
30
|
### 3.2 非スコープ
|
|
30
31
|
|
|
@@ -46,7 +47,8 @@
|
|
|
46
47
|
3. YAYA docs をローカルMarkdownからパースする
|
|
47
48
|
4. 里々 docs をローカルMarkdownからパースする
|
|
48
49
|
5. 蒼空 Wiki をGitHub Wiki取得してパースする
|
|
49
|
-
6.
|
|
50
|
+
6. 湊 docs をローカルMarkdownからパースする
|
|
51
|
+
7. 6ソースを統合して `data/index.json` を生成する
|
|
50
52
|
|
|
51
53
|
### 4.2 ランタイム
|
|
52
54
|
|
|
@@ -62,7 +64,7 @@
|
|
|
62
64
|
### 5.1 Source
|
|
63
65
|
|
|
64
66
|
```ts
|
|
65
|
-
type Source = 'ukadoc' | 'ssp_help' | 'yaya_docs' | 'satori_docs' | 'aosora_wiki';
|
|
67
|
+
type Source = 'ukadoc' | 'ssp_help' | 'yaya_docs' | 'satori_docs' | 'aosora_wiki' | 'minato_docs';
|
|
66
68
|
```
|
|
67
69
|
|
|
68
70
|
### 5.2 Category
|
|
@@ -95,7 +97,13 @@ type Category =
|
|
|
95
97
|
| 'satori_system'
|
|
96
98
|
| 'satori_function'
|
|
97
99
|
| 'satori_ssu'
|
|
98
|
-
| 'satori_other'
|
|
100
|
+
| 'satori_other'
|
|
101
|
+
| 'minato_startup'
|
|
102
|
+
| 'minato_basic'
|
|
103
|
+
| 'minato_grammar'
|
|
104
|
+
| 'minato_talk'
|
|
105
|
+
| 'minato_other'
|
|
106
|
+
| 'minato_migration';
|
|
99
107
|
```
|
|
100
108
|
|
|
101
109
|
### 5.3 DocEntry
|
|
@@ -199,6 +207,12 @@ type IndexFile = {
|
|
|
199
207
|
- `dir` はリポジトリ直下のディレクトリ名、`file_stem` は拡張子 `.md` を除いたファイル名とする
|
|
200
208
|
- 各ディレクトリの `index.md` も本文を持つため取り込む(例: `satori:functions/index`)
|
|
201
209
|
|
|
210
|
+
#### 湊 docs
|
|
211
|
+
|
|
212
|
+
- 1ページ1エントリとし、`minato:{path}` とする(例: `minato:func/builtin`)
|
|
213
|
+
- `path` は mdBook のソースディレクトリ `docs/src/` からの相対パスから拡張子 `.md` を除いたもの(例: `minato:include`、`minato:README`)とする
|
|
214
|
+
- 対象ページは上流サイトの目次 `docs/src/SUMMARY.md` から決め、カテゴリは `path` の先頭要素から決める
|
|
215
|
+
|
|
202
216
|
## 7. 収集・正規化仕様
|
|
203
217
|
|
|
204
218
|
### 7.1 リンク正規化
|
|
@@ -286,7 +300,7 @@ Wikiリンクは取得前に正規化しなければならない。
|
|
|
286
300
|
|
|
287
301
|
`npm run build:index` は、以下をすべて満たしたときのみ成功してよい。
|
|
288
302
|
|
|
289
|
-
- 必須
|
|
303
|
+
- 必須6ソースの取得・パースが完了している
|
|
290
304
|
- 重複 `id` が存在しない
|
|
291
305
|
- 無効ページが含まれていない
|
|
292
306
|
- 各ソースが空でない
|
|
@@ -310,7 +324,7 @@ Wikiリンクは取得前に正規化しなければならない。
|
|
|
310
324
|
|
|
311
325
|
### 9.4 部分成功の禁止
|
|
312
326
|
|
|
313
|
-
- UKADOC だけ成功、SSP ヘルプ/YAYA
|
|
327
|
+
- UKADOC だけ成功、SSP ヘルプ/YAYA/里々/蒼空/湊失敗のような部分成功を正規成果物として出力してはならない
|
|
314
328
|
- ビルドは fail-open ではなく fail-closed でなければならない
|
|
315
329
|
|
|
316
330
|
## 10. ランタイム仕様
|