@rushstack/rush-mcp-docs-plugin 0.1.8 → 0.2.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/CHANGELOG.json +23 -0
- package/CHANGELOG.md +8 -1
- package/lib/DocsPlugin.d.ts.map +1 -1
- package/lib/DocsPlugin.js.map +1 -1
- package/lib/DocsTool.d.ts.map +1 -1
- package/lib/DocsTool.js +2 -2
- package/lib/DocsTool.js.map +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js.map +1 -1
- package/package.json +5 -5
package/CHANGELOG.json
CHANGED
|
@@ -1,6 +1,29 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rushstack/rush-mcp-docs-plugin",
|
|
3
3
|
"entries": [
|
|
4
|
+
{
|
|
5
|
+
"version": "0.2.0",
|
|
6
|
+
"tag": "@rushstack/rush-mcp-docs-plugin_v0.2.0",
|
|
7
|
+
"date": "Fri, 03 Oct 2025 20:09:59 GMT",
|
|
8
|
+
"comments": {
|
|
9
|
+
"minor": [
|
|
10
|
+
{
|
|
11
|
+
"comment": "Normalize import of builtin modules to use the `node:` protocol."
|
|
12
|
+
}
|
|
13
|
+
],
|
|
14
|
+
"dependency": [
|
|
15
|
+
{
|
|
16
|
+
"comment": "Updating dependency \"@rushstack/node-core-library\" to `5.16.0`"
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
"comment": "Updating dependency \"@rushstack/mcp-server\" to `0.3.0`"
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
"comment": "Updating dependency \"@rushstack/heft\" to `1.1.0`"
|
|
23
|
+
}
|
|
24
|
+
]
|
|
25
|
+
}
|
|
26
|
+
},
|
|
4
27
|
{
|
|
5
28
|
"version": "0.1.8",
|
|
6
29
|
"tag": "@rushstack/rush-mcp-docs-plugin_v0.1.8",
|
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,13 @@
|
|
|
1
1
|
# Change Log - @rushstack/rush-mcp-docs-plugin
|
|
2
2
|
|
|
3
|
-
This log was last generated on
|
|
3
|
+
This log was last generated on Fri, 03 Oct 2025 20:09:59 GMT and should not be manually modified.
|
|
4
|
+
|
|
5
|
+
## 0.2.0
|
|
6
|
+
Fri, 03 Oct 2025 20:09:59 GMT
|
|
7
|
+
|
|
8
|
+
### Minor changes
|
|
9
|
+
|
|
10
|
+
- Normalize import of builtin modules to use the `node:` protocol.
|
|
4
11
|
|
|
5
12
|
## 0.1.8
|
|
6
13
|
Tue, 30 Sep 2025 23:57:45 GMT
|
package/lib/DocsPlugin.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DocsPlugin.d.ts","sourceRoot":"","sources":["../src/DocsPlugin.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"DocsPlugin.d.ts","sourceRoot":"","sources":["../src/DocsPlugin.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAIlF,MAAM,WAAW,qBAAqB;CAAG;AAEzC,qBAAa,UAAW,YAAW,cAAc;IACxC,OAAO,EAAE,oBAAoB,CAAC;IAC9B,UAAU,EAAE,qBAAqB,GAAG,SAAS,CAAa;gBAE9C,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,qBAAqB,GAAG,SAAS;IAKlF,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;CAUhD"}
|
package/lib/DocsPlugin.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DocsPlugin.js","sourceRoot":"","sources":["../src/DocsPlugin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;
|
|
1
|
+
{"version":3,"file":"DocsPlugin.js","sourceRoot":"","sources":["../src/DocsPlugin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAI3D,yCAAsC;AAItC,MAAa,UAAU;IAIrB,YAAmB,OAA6B,EAAE,UAA6C;QAFxF,eAAU,GAAsC,SAAS,CAAC;QAG/D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,IAAI,CAAC,OAAO,CAAC,YAAY,CACvB;YACE,QAAQ,EAAE,WAAW;YACrB,WAAW,EACT,mGAAmG;SACtG,EACD,IAAI,mBAAQ,CAAC,IAAI,CAAC,CACnB,CAAC;IACJ,CAAC;CACF;AAnBD,gCAmBC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport type { IRushMcpPlugin, RushMcpPluginSession } from '@rushstack/mcp-server';\n\nimport { DocsTool } from './DocsTool';\n\nexport interface IDocsPluginConfigFile {}\n\nexport class DocsPlugin implements IRushMcpPlugin {\n public session: RushMcpPluginSession;\n public configFile: IDocsPluginConfigFile | undefined = undefined;\n\n public constructor(session: RushMcpPluginSession, configFile: IDocsPluginConfigFile | undefined) {\n this.session = session;\n this.configFile = configFile;\n }\n\n public async onInitializeAsync(): Promise<void> {\n this.session.registerTool(\n {\n toolName: 'rush_docs',\n description:\n 'Search and retrieve relevant sections from the official Rush documentation based on user queries.'\n },\n new DocsTool(this)\n );\n }\n}\n"]}
|
package/lib/DocsTool.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DocsTool.d.ts","sourceRoot":"","sources":["../src/DocsTool.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"DocsTool.d.ts","sourceRoot":"","sources":["../src/DocsTool.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,oBAAoB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAG3G,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAY/C,qBAAa,QAAS,YAAW,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC/D,SAAgB,MAAM,EAAE,UAAU,CAAC;IACnC,SAAgB,OAAO,EAAE,oBAAoB,CAAC;gBAE3B,MAAM,EAAE,UAAU;IAOrC,IAAW,MAAM;;;;;;OAMhB;IAGD,OAAO,CAAC,WAAW;IAeN,YAAY,CAAC,EAAE,SAAS,EAAE,EAAE,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;CAYvG"}
|
package/lib/DocsTool.js
CHANGED
|
@@ -6,8 +6,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
6
6
|
};
|
|
7
7
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
8
8
|
exports.DocsTool = void 0;
|
|
9
|
+
const node_path_1 = __importDefault(require("node:path"));
|
|
9
10
|
const node_core_library_1 = require("@rushstack/node-core-library");
|
|
10
|
-
const path_1 = __importDefault(require("path"));
|
|
11
11
|
class DocsTool {
|
|
12
12
|
constructor(plugin) {
|
|
13
13
|
this.plugin = plugin;
|
|
@@ -24,7 +24,7 @@ class DocsTool {
|
|
|
24
24
|
// TODO: replace with Microsoft's service
|
|
25
25
|
_searchDocs(query) {
|
|
26
26
|
const startTime = Date.now();
|
|
27
|
-
const results = node_core_library_1.JsonFile.load(
|
|
27
|
+
const results = node_core_library_1.JsonFile.load(node_path_1.default.join(__dirname, './rush-doc-fragment.mock.json'));
|
|
28
28
|
return {
|
|
29
29
|
query,
|
|
30
30
|
results,
|
package/lib/DocsTool.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DocsTool.js","sourceRoot":"","sources":["../src/DocsTool.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;
|
|
1
|
+
{"version":3,"file":"DocsTool.js","sourceRoot":"","sources":["../src/DocsTool.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;AAE3D,0DAA6B;AAG7B,oEAAwD;AAcxD,MAAa,QAAQ;IAInB,YAAmB,MAAkB;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAChC,CAAC;IAED,6EAA6E;IAC7E,4EAA4E;IAC5E,IAAW,MAAM;QACf,MAAM,GAAG,GAAqB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;QAE/C,OAAO,GAAG,CAAC,MAAM,CAAC;YAChB,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,+DAA+D,CAAC;SAClG,CAAC,CAAC;IACL,CAAC;IAED,yCAAyC;IACjC,WAAW,CAAC,KAAa;QAC/B,MAAM,SAAS,GAAW,IAAI,CAAC,GAAG,EAAE,CAAC;QAErC,MAAM,OAAO,GAA2B,4BAAQ,CAAC,IAAI,CACnD,mBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,+BAA+B,CAAC,CACtD,CAAC;QAEF,OAAO;YACL,KAAK;YACL,OAAO;YACP,KAAK,EAAE,OAAO,CAAC,MAAM;YACrB,YAAY,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS;SACrC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,EAAE,SAAS,EAAuC;QAC1E,MAAM,eAAe,GAAgB,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAEjE,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;iBACpE;aACF;SACF,CAAC;IACJ,CAAC;CACF;AA/CD,4BA+CC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport path from 'node:path';\n\nimport type { IRushMcpTool, RushMcpPluginSession, CallToolResult, zodModule } from '@rushstack/mcp-server';\nimport { JsonFile } from '@rushstack/node-core-library';\n\nimport type { DocsPlugin } from './DocsPlugin';\n\ninterface IDocsResult {\n query: string;\n results: {\n score: number;\n text: string;\n }[];\n count: number;\n searchTimeMs: number;\n}\n\nexport class DocsTool implements IRushMcpTool<DocsTool['schema']> {\n public readonly plugin: DocsPlugin;\n public readonly session: RushMcpPluginSession;\n\n public constructor(plugin: DocsPlugin) {\n this.plugin = plugin;\n this.session = plugin.session;\n }\n\n // ZOD relies on type inference generate a messy expression in the .d.ts file\n // eslint-disable-next-line @typescript-eslint/explicit-function-return-type\n public get schema() {\n const zod: typeof zodModule = this.session.zod;\n\n return zod.object({\n userQuery: zod.string().describe('The user query to search for relevant documentation sections.')\n });\n }\n\n // TODO: replace with Microsoft's service\n private _searchDocs(query: string): IDocsResult {\n const startTime: number = Date.now();\n\n const results: IDocsResult['results'] = JsonFile.load(\n path.join(__dirname, './rush-doc-fragment.mock.json')\n );\n\n return {\n query,\n results,\n count: results.length,\n searchTimeMs: Date.now() - startTime\n };\n }\n\n public async executeAsync({ userQuery }: zodModule.infer<DocsTool['schema']>): Promise<CallToolResult> {\n const docSearchResult: IDocsResult = this._searchDocs(userQuery);\n\n return {\n content: [\n {\n type: 'text',\n text: docSearchResult.results.map((item) => item.text).join('\\n\\n')\n }\n ]\n };\n }\n}\n"]}
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAwB,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAwB,MAAM,uBAAuB,CAAC;AAExF,OAAO,EAAE,UAAU,EAAE,KAAK,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAEtE,iBAAS,YAAY,CACnB,OAAO,EAAE,oBAAoB,EAC7B,UAAU,EAAE,qBAAqB,GAAG,SAAS,GAC5C,UAAU,CAEZ;;AAED,wBAAkF"}
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAI3D,6CAAsE;AAEtE,SAAS,YAAY,CACnB,OAA6B,EAC7B,UAA6C;IAE7C,OAAO,IAAI,uBAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AAC7C,CAAC;AAED,kBAAe,YAAkE,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport type { RushMcpPluginSession, RushMcpPluginFactory } from '@rushstack/mcp-server';\n\nimport { DocsPlugin, type IDocsPluginConfigFile } from './DocsPlugin';\n\nfunction createPlugin(\n session: RushMcpPluginSession,\n configFile: IDocsPluginConfigFile | undefined\n): DocsPlugin {\n return new DocsPlugin(session, configFile);\n}\n\nexport default createPlugin satisfies RushMcpPluginFactory<IDocsPluginConfigFile>;\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rushstack/rush-mcp-docs-plugin",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Docs plugin for @rushstack/mcp-server",
|
|
5
5
|
"repository": {
|
|
6
6
|
"url": "https://github.com/microsoft/rushstack.git",
|
|
@@ -12,14 +12,14 @@
|
|
|
12
12
|
"types": "lib/index.d.ts",
|
|
13
13
|
"license": "MIT",
|
|
14
14
|
"dependencies": {
|
|
15
|
-
"@rushstack/mcp-server": "0.
|
|
16
|
-
"@rushstack/node-core-library": "5.
|
|
15
|
+
"@rushstack/mcp-server": "0.3.0",
|
|
16
|
+
"@rushstack/node-core-library": "5.16.0"
|
|
17
17
|
},
|
|
18
18
|
"devDependencies": {
|
|
19
19
|
"eslint": "~9.25.1",
|
|
20
|
-
"
|
|
20
|
+
"local-eslint-config": "1.0.0",
|
|
21
21
|
"local-node-rig": "1.0.0",
|
|
22
|
-
"
|
|
22
|
+
"@rushstack/heft": "1.1.0"
|
|
23
23
|
},
|
|
24
24
|
"scripts": {
|
|
25
25
|
"build": "heft build --clean",
|