ukagaka-doc-mcp 0.4.1 → 0.5.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 -1
- package/README.md +3 -3
- package/SPEC.md +7 -7
- package/data/index.json +1389 -2661
- package/dist/build-index.d.ts +1 -1
- package/dist/build-index.js +7 -6
- package/dist/build-index.js.map +1 -1
- package/dist/constants.d.ts +5 -1
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +12 -8
- package/dist/constants.js.map +1 -1
- package/dist/index-builder.js +1 -1
- package/dist/parser/aosora-parser.d.ts +0 -5
- package/dist/parser/aosora-parser.d.ts.map +1 -1
- package/dist/parser/aosora-parser.js +1 -48
- package/dist/parser/aosora-parser.js.map +1 -1
- package/dist/parser/markdown.d.ts +9 -0
- package/dist/parser/markdown.d.ts.map +1 -0
- package/dist/parser/markdown.js +54 -0
- package/dist/parser/markdown.js.map +1 -0
- package/dist/parser/yaya-docs-parser.d.ts +18 -0
- package/dist/parser/yaya-docs-parser.d.ts.map +1 -0
- package/dist/parser/yaya-docs-parser.js +79 -0
- package/dist/parser/yaya-docs-parser.js.map +1 -0
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +8 -2
- 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/types.d.ts +1 -1
- package/package.json +3 -3
- package/dist/parser/yaya-scraper.d.ts +0 -46
- package/dist/parser/yaya-scraper.d.ts.map +0 -1
- package/dist/parser/yaya-scraper.js +0 -308
- package/dist/parser/yaya-scraper.js.map +0 -1
package/NOTICE.md
CHANGED
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
伺か(Ukagaka)の技術ドキュメントを検索する MCP サーバーです。
|
|
4
4
|
|
|
5
|
-
UKADOC・YAYA
|
|
5
|
+
UKADOC・YAYA docs・里々Wiki・蒼空 Wiki のスナップショットを同梱しており、stdio モード(デフォルト)では**ランタイムで外部ネットワークにアクセスしません**。
|
|
6
6
|
|
|
7
7
|
## 使い方
|
|
8
8
|
|
|
@@ -81,7 +81,7 @@ npx ukagaka-doc-mcp --http --host 0.0.0.0 --port 9000 # listen 先を変更
|
|
|
81
81
|
| ソース | 内容 |
|
|
82
82
|
|--------|------|
|
|
83
83
|
| UKADOC | 伺か全般の仕様・リファレンス |
|
|
84
|
-
| YAYA
|
|
84
|
+
| YAYA docs([yaya-docs](https://github.com/YAYA-shiori/yaya-docs)) | YAYA スクリプトのリファレンス |
|
|
85
85
|
| 里々Wiki | 里々スクリプトのリファレンス |
|
|
86
86
|
| 蒼空(aosora) Wiki | 蒼空 shiori/GHOST 開発ガイド |
|
|
87
87
|
|
|
@@ -142,4 +142,4 @@ npm tarball に含まれるファイル:
|
|
|
142
142
|
|
|
143
143
|
実装コードは **MIT License**(`LICENSE` 参照)。
|
|
144
144
|
|
|
145
|
-
同梱の `data/index.json` は UKADOC・YAYA
|
|
145
|
+
同梱の `data/index.json` は UKADOC・YAYA docs・里々Wiki・蒼空 Wiki を元に生成した外部由来データです。MIT License での再ライセンスは行っていません。利用・再配布時は上流の権利関係を別途確認してください(`NOTICE.md` 参照)。
|
package/SPEC.md
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
本サーバーは以下の4ソースのみを対象とする。
|
|
22
22
|
|
|
23
23
|
1. UKADOC (`docs/ukadoc/manual/`)
|
|
24
|
-
2. YAYA
|
|
24
|
+
2. YAYA docs (`docs/yaya-docs/`、`https://github.com/YAYA-shiori/yaya-docs`)
|
|
25
25
|
3. 里々Wiki (`https://soliton.sub.jp/satori/`)
|
|
26
26
|
4. 蒼空 Wiki (`https://github.com/kanadelab/aosora-shiori/wiki`)
|
|
27
27
|
|
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
`npm run build:index` は以下を行う。
|
|
42
42
|
|
|
43
43
|
1. UKADOC をローカルHTMLからパースする
|
|
44
|
-
2. YAYA
|
|
44
|
+
2. YAYA docs をローカルMarkdownからパースする
|
|
45
45
|
3. 里々Wiki をHTTP取得してパースする
|
|
46
46
|
4. 蒼空 Wiki をGitHub Wiki取得してパースする
|
|
47
47
|
5. 4ソースを統合して `data/index.json` を生成する
|
|
@@ -60,7 +60,7 @@
|
|
|
60
60
|
### 5.1 Source
|
|
61
61
|
|
|
62
62
|
```ts
|
|
63
|
-
type Source = 'ukadoc' | '
|
|
63
|
+
type Source = 'ukadoc' | 'yaya_docs' | 'satori_wiki' | 'aosora_wiki';
|
|
64
64
|
```
|
|
65
65
|
|
|
66
66
|
### 5.2 Category
|
|
@@ -81,6 +81,7 @@ type Category =
|
|
|
81
81
|
| 'yaya_system'
|
|
82
82
|
| 'yaya_tips'
|
|
83
83
|
| 'yaya_startup'
|
|
84
|
+
| 'yaya_other'
|
|
84
85
|
| 'satori_reference'
|
|
85
86
|
| 'satori_event'
|
|
86
87
|
| 'satori_tips'
|
|
@@ -171,11 +172,10 @@ type IndexFile = {
|
|
|
171
172
|
- `normalized_raw_title` は安定した正規化文字列でなければならない
|
|
172
173
|
- フォールバックは、記号除去や小文字化だけに依存してはならない
|
|
173
174
|
|
|
174
|
-
#### YAYA
|
|
175
|
+
#### YAYA docs
|
|
175
176
|
|
|
176
|
-
-
|
|
177
|
-
-
|
|
178
|
-
- `page_path` はURLデコード済みの論理ページパスとする
|
|
177
|
+
- 1ページ1エントリとし、`yaya:{dir}/{file_stem}` とする(例: `yaya:functions/REPLACE`)
|
|
178
|
+
- `dir` はリポジトリ直下のディレクトリ名、`file_stem` は拡張子 `.md` を除いたファイル名とする
|
|
179
179
|
|
|
180
180
|
#### 里々Wiki
|
|
181
181
|
|