@rushstack/rush-mcp-docs-plugin 0.1.0

package/CHANGELOG.json

@@ -0,0 +1,22 @@
+{
+  "name": "@rushstack/rush-mcp-docs-plugin",
+  "entries": [
+    {
+      "version": "0.1.0",
+      "tag": "@rushstack/rush-mcp-docs-plugin_v0.1.0",
+      "date": "Sat, 14 Jun 2025 00:11:30 GMT",
+      "comments": {
+        "minor": [
+          {
+            "comment": "Add rush docs mcp plugin"
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/mcp-server\" to `0.2.2`"
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log - @rushstack/rush-mcp-docs-plugin
+
+This log was last generated on Sat, 14 Jun 2025 00:11:30 GMT and should not be manually modified.
+
+## 0.1.0
+Sat, 14 Jun 2025 00:11:30 GMT
+
+### Minor changes
+
+- Add rush docs mcp plugin
+

package/LICENSE

@@ -0,0 +1,24 @@
+@rushstack/rush-mcp-docs-plugin
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @rushstack/rush-mcp-docs-plugin
+
+The @rushstack/rush-mcp-docs-plugin package provides a documentation query tool for Rush.

package/lib/DocsPlugin.d.ts

@@ -0,0 +1,10 @@
+import type { IRushMcpPlugin, RushMcpPluginSession } from '@rushstack/mcp-server';
+export interface IDocsPluginConfigFile {
+}
+export declare class DocsPlugin implements IRushMcpPlugin {
+    session: RushMcpPluginSession;
+    configFile: IDocsPluginConfigFile | undefined;
+    constructor(session: RushMcpPluginSession, configFile: IDocsPluginConfigFile | undefined);
+    onInitializeAsync(): Promise<void>;
+}
+//# sourceMappingURL=DocsPlugin.d.ts.map

package/lib/DocsPlugin.d.ts.map

@@ -0,0 +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;AAGlF,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

@@ -0,0 +1,21 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocsPlugin = void 0;
+const DocsTool_1 = require("./DocsTool");
+class DocsPlugin {
+    constructor(session, configFile) {
+        this.configFile = undefined;
+        this.session = session;
+        this.configFile = configFile;
+    }
+    async onInitializeAsync() {
+        this.session.registerTool({
+            toolName: 'rush_docs',
+            description: 'Search and retrieve relevant sections from the official Rush documentation based on user queries.'
+        }, new DocsTool_1.DocsTool(this));
+    }
+}
+exports.DocsPlugin = DocsPlugin;
+//# sourceMappingURL=DocsPlugin.js.map

package/lib/DocsPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocsPlugin.js","sourceRoot":"","sources":["../src/DocsPlugin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,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';\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

@@ -0,0 +1,17 @@
+import type { IRushMcpTool, RushMcpPluginSession, CallToolResult, zodModule } from '@rushstack/mcp-server';
+import type { DocsPlugin } from './DocsPlugin';
+export declare class DocsTool implements IRushMcpTool<DocsTool['schema']> {
+    readonly plugin: DocsPlugin;
+    readonly session: RushMcpPluginSession;
+    constructor(plugin: DocsPlugin);
+    get schema(): zodModule.ZodObject<{
+        userQuery: zodModule.ZodString;
+    }, "strip", zodModule.ZodTypeAny, {
+        userQuery: string;
+    }, {
+        userQuery: string;
+    }>;
+    private _searchDocs;
+    executeAsync({ userQuery }: zodModule.infer<DocsTool['schema']>): Promise<CallToolResult>;
+}
+//# sourceMappingURL=DocsTool.d.ts.map

package/lib/DocsTool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocsTool.d.ts","sourceRoot":"","sources":["../src/DocsTool.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,oBAAoB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAI3G,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

@@ -0,0 +1,48 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocsTool = void 0;
+const node_core_library_1 = require("@rushstack/node-core-library");
+const path_1 = __importDefault(require("path"));
+class DocsTool {
+    constructor(plugin) {
+        this.plugin = plugin;
+        this.session = plugin.session;
+    }
+    // ZOD relies on type inference generate a messy expression in the .d.ts file
+    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+    get schema() {
+        const zod = this.session.zod;
+        return zod.object({
+            userQuery: zod.string().describe('The user query to search for relevant documentation sections.')
+        });
+    }
+    // TODO: replace with Microsoft's service
+    _searchDocs(query) {
+        const startTime = Date.now();
+        const results = node_core_library_1.JsonFile.load(path_1.default.join(__dirname, './rush-doc-fragment.mock.json'));
+        return {
+            query,
+            results,
+            count: results.length,
+            searchTimeMs: Date.now() - startTime
+        };
+    }
+    async executeAsync({ userQuery }) {
+        const docSearchResult = this._searchDocs(userQuery);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: docSearchResult.results.map((item) => item.text).join('\n\n')
+                }
+            ]
+        };
+    }
+}
+exports.DocsTool = DocsTool;
+//# sourceMappingURL=DocsTool.js.map

package/lib/DocsTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocsTool.js","sourceRoot":"","sources":["../src/DocsTool.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;AAG3D,oEAAwD;AACxD,gDAAwB;AAcxB,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,cAAI,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 type { IRushMcpTool, RushMcpPluginSession, CallToolResult, zodModule } from '@rushstack/mcp-server';\nimport { JsonFile } from '@rushstack/node-core-library';\nimport path from 'path';\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

@@ -0,0 +1,6 @@
+import type { RushMcpPluginSession } from '@rushstack/mcp-server';
+import { DocsPlugin, type IDocsPluginConfigFile } from './DocsPlugin';
+declare function createPlugin(session: RushMcpPluginSession, configFile: IDocsPluginConfigFile | undefined): DocsPlugin;
+declare const _default: typeof createPlugin;
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAwB,MAAM,uBAAuB,CAAC;AACxF,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

@@ -0,0 +1,10 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+const DocsPlugin_1 = require("./DocsPlugin");
+function createPlugin(session, configFile) {
+    return new DocsPlugin_1.DocsPlugin(session, configFile);
+}
+exports.default = createPlugin;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAG3D,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';\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/lib/rush-doc-fragment.mock.json

@@ -0,0 +1,18 @@
+[
+  {
+    "text": "---\ntitle: rush install-autoinstaller\n---\n\n```\nusage: rush install-autoinstaller [-h] --name AUTOINSTALLER_NAME\n\nUse this command to install dependencies for an autoinstaller folder.\n\nOptional arguments:\n  -h, --help            Show this help message and exit.\n  --name AUTOINSTALLER_NAME\n                        The name of the autoinstaller, which must be one of\n                        the folders under common/autoinstallers.\n```\n\n## See also\n\n- [rush update-autoinstaller](../commands/rush_update-autoinstaller.md)\n- [rush init-autoinstaller](../commands/rush_init-autoinstaller.md)",
+    "score": 0.7231232
+  },
+  {
+    "text": "---\ntitle: rush install-autoinstaller\n---\n\n```\n用法：rush install-autoinstaller [-h] --name AUTOINSTALLER_NAME\n\n使用该指令给一个项目安装依赖。\n\n可选参数：\n  -h, --help            展示帮助信息并退出\n  --name AUTOINSTALLER_NAME\n                        指定自动安装的包名，它必须是 common/autoinstallers\n                        下的一个文件夹。\n```\n\n## See also\n\n- [rush update-autoinstaller](../commands/rush_update-autoinstaller.md)\n- [rush init-autoinstaller](../commands/rush_init-autoinstaller.md)",
+    "score": 0.7132133
+  },
+  {
+    "text": "---\ntitle: rush update-autoinstaller\n---\n\n```\nusage: rush update-autoinstaller [-h] --name AUTOINSTALLER_NAME\n\nUse this command to regenerate the shrinkwrap file for an autoinstaller\nfolder.\n\nOptional arguments:\n  -h, --help            Show this help message and exit.\n  --name AUTOINSTALLER_NAME\n                        The name of the autoinstaller, which must be one of\n                        the folders under common/autoinstallers.\n```\n\n## See also\n\n- [rush install-autoinstaller](../commands/rush_install-autoinstaller.md)\n- [rush init-autoinstaller](../commands/rush_init-autoinstaller.md)",
+    "score": 0.6632131
+  },
+  {
+    "text": "---\ntitle: rush update-autoinstaller\n---\n\n```\nusage: rush update-autoinstaller [-h] --name AUTOINSTALLER_NAME\n\nUse this command to regenerate the shrinkwrap file for an autoinstaller\nfolder.\n\nOptional arguments:\n  -h, --help            Show this help message and exit.\n  --name AUTOINSTALLER_NAME\n                        The name of the autoinstaller, which must be one of\n                        the folders under common/autoinstallers.\n```\n\n## See also\n\n- [rush install-autoinstaller](../commands/rush_install-autoinstaller.md)\n- [rush init-autoinstaller](../commands/rush_init-autoinstaller.md)",
+    "score": 0.6528328
+  }
+]

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@rushstack/rush-mcp-docs-plugin",
+  "version": "0.1.0",
+  "description": "Docs plugin for @rushstack/mcp-server",
+  "repository": {
+    "url": "https://github.com/microsoft/rushstack.git",
+    "type": "git",
+    "directory": "rush-plugins/rush-mcp-docs-plugin"
+  },
+  "homepage": "https://rushjs.io",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "license": "MIT",
+  "dependencies": {
+    "@rushstack/mcp-server": "0.2.2",
+    "@rushstack/node-core-library": "5.13.1"
+  },
+  "devDependencies": {
+    "@rushstack/heft": "0.73.6",
+    "local-node-rig": "1.0.0",
+    "local-eslint-config": "1.0.0"
+  },
+  "scripts": {
+    "build": "heft build --clean",
+    "_phase:build": "heft run --only build -- --clean",
+    "_phase:test": "heft run --only test -- --clean"
+  }
+}

package/rush-mcp-plugin.json

@@ -0,0 +1,24 @@
+/**
+ * Every plugin package must contain a "rush-mcp-plugin.json" manifest in the top-level folder
+ * (next to package.json).
+ */
+{
+  /**
+   * A name that uniquely identifies your plugin.  Generally this should be the same name as
+   * the NPM package.  If two NPM packages have the same pluginName, they cannot be loaded together.
+   */
+  "pluginName": "rush-mcp-docs-plugin",
+
+  /**
+   * (OPTIONAL) Indicates that your plugin accepts a config file.  The MCP server will load this
+   * file and provide it to the plugin.
+   *
+   * The config file path will be `<rush-repo>/common/config/rush-mcp/<plugin-name>.json`.
+   */
+  // "configFileSchema": "./lib/rush-mcp-example-plugin.schema.json",
+
+  /**
+   * The entry point, whose default export should be a class that implements
+   */
+  "entryPoint": "./lib/index.js"
+}