ukagaka-doc-mcp 0.8.0 → 0.8.1
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/SPEC.md +4 -0
- package/dist/tools/get-doc.js +1 -1
- package/dist/tools/get-doc.js.map +1 -1
- package/package.json +1 -1
package/SPEC.md
CHANGED
|
@@ -118,6 +118,7 @@ type DocEntry = {
|
|
|
118
118
|
category: Category;
|
|
119
119
|
content: string;
|
|
120
120
|
url: string;
|
|
121
|
+
rawUrl?: string;
|
|
121
122
|
};
|
|
122
123
|
```
|
|
123
124
|
|
|
@@ -128,6 +129,7 @@ type DocEntry = {
|
|
|
128
129
|
- `content` は全文でなければならない
|
|
129
130
|
- `content` は保存時に要約化してはならない
|
|
130
131
|
- `url` はそのエントリの元ページまたは元セクションを指さなければならない
|
|
132
|
+
- `rawUrl` は元のソースが Markdown のソース（YAYA docs・里々 docs・蒼空 Wiki・湊 docs）の全エントリに付与し、元の Markdown を指さなければならない。元のソースが HTML のソース（UKADOC・SSP ヘルプ）には付与してはならない
|
|
131
133
|
|
|
132
134
|
### 5.4 SearchEntry
|
|
133
135
|
|
|
@@ -141,6 +143,7 @@ type SearchEntry = {
|
|
|
141
143
|
category: Category;
|
|
142
144
|
summary: string;
|
|
143
145
|
url: string;
|
|
146
|
+
rawUrl?: string;
|
|
144
147
|
};
|
|
145
148
|
```
|
|
146
149
|
|
|
@@ -152,6 +155,7 @@ type SearchEntry = {
|
|
|
152
155
|
- 省略時の `summary` は `content.slice(0, 500) + "..."` と等価でなければならない
|
|
153
156
|
- `summary` 生成時に改行や空白の追加正規化を行ってはならない
|
|
154
157
|
- `summary` はインデックスの正規データではなく派生値であること
|
|
158
|
+
- `rawUrl` は `DocEntry` に `rawUrl` がある場合に限り含めること
|
|
155
159
|
|
|
156
160
|
### 5.5 IndexFile
|
|
157
161
|
|
package/dist/tools/get-doc.js
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from 'zod';
|
|
|
2
2
|
export function registerGetDocTool(server, engine) {
|
|
3
3
|
server.registerTool('get_doc', {
|
|
4
4
|
description: 'search_docs の結果にある id を指定して、ドキュメント1件の全文（content）と title・source・category・url を返す。'
|
|
5
|
-
+ '
|
|
5
|
+
+ 'UKADOC・SSP ヘルプ以外（元のソースが Markdown）は、元の Markdown を取得できる rawUrl も返す。'
|
|
6
6
|
+ 'search_docs の summary は本文の冒頭で切れているので、続きや詳細を確かめるときに使う。'
|
|
7
7
|
+ 'id の形式はソースごとに異なり、search_docs の結果の id がそのまま使える。存在しない id には status: "not_found" を返す。',
|
|
8
8
|
inputSchema: z.object({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"get-doc.js","sourceRoot":"","sources":["../../src/tools/get-doc.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,MAAM,UAAU,kBAAkB,CAAC,MAAiB,EAAE,MAAoB;IACxE,MAAM,CAAC,YAAY,CACjB,SAAS,EACT;QACE,WAAW,EAAE,kFAAkF;cAC3F,
|
|
1
|
+
{"version":3,"file":"get-doc.js","sourceRoot":"","sources":["../../src/tools/get-doc.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,MAAM,UAAU,kBAAkB,CAAC,MAAiB,EAAE,MAAoB;IACxE,MAAM,CAAC,YAAY,CACjB,SAAS,EACT;QACE,WAAW,EAAE,kFAAkF;cAC3F,mEAAmE;cACnE,uDAAuD;cACvD,oFAAoF;QACxF,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;YACpB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CACrB,wKAAwK,CACzK;SACF,CAAC;KACH,EACD,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE;QACf,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEjC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO;gBACL,OAAO,EAAE,CAAC;wBACR,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;4BACnB,MAAM,EAAE,WAAW;4BACnB,OAAO,EAAE,OAAO,EAAE,qDAAqD;yBACxE,CAAC;qBACH,CAAC;aACH,CAAC;QACJ,CAAC;QAED,OAAO;YACL,OAAO,EAAE,CAAC;oBACR,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;wBACnB,MAAM,EAAE,IAAI;wBACZ,IAAI,EAAE,KAAK;qBACZ,EAAE,IAAI,EAAE,CAAC,CAAC;iBACZ,CAAC;SACH,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC"}
|
package/package.json
CHANGED