@rushstack/mcp-server 0.1.6 → 0.1.8

package/CHANGELOG.json

@@ -1,6 +1,30 @@
 {
   "name": "@rushstack/mcp-server",
   "entries": [
+    {
+      "version": "0.1.8",
+      "tag": "@rushstack/mcp-server_v0.1.8",
+      "date": "Thu, 29 May 2025 15:10:58 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Update the rush mcp server README.md document"
+          }
+        ]
+      }
+    },
+    {
+      "version": "0.1.7",
+      "tag": "@rushstack/mcp-server_v0.1.7",
+      "date": "Tue, 13 May 2025 02:09:20 GMT",
+      "comments": {
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/heft\" to `0.73.6`"
+          }
+        ]
+      }
+    },
     {
       "version": "0.1.6",
       "tag": "@rushstack/mcp-server_v0.1.6",

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Change Log - @rushstack/mcp-server
 
-This log was last generated on Wed, 07 May 2025 15:11:17 GMT and should not be manually modified.
+This log was last generated on Thu, 29 May 2025 15:10:58 GMT and should not be manually modified.
+
+## 0.1.8
+Thu, 29 May 2025 15:10:58 GMT
+
+### Patches
+
+- Update the rush mcp server README.md document
+
+## 0.1.7
+Tue, 13 May 2025 02:09:20 GMT
+
+_Version update only_
 
 ## 0.1.6
 Wed, 07 May 2025 15:11:17 GMT

package/README.md

@@ -1,5 +1,37 @@
 # @rushstack/mcp-server
 
+With the rapid advancement of LLMs, AI applications like Trae, Cursor, Cline, Windsurf, and others have been thriving. However, due to the large scale of monorepos and the context limitations of LLMs, it’s difficult for these models to fully understand your monorepo. This is where @rushstack/mcp-server comes in — by providing a suite of MCP tools, it enables LLMs to better comprehend your monorepo and assist you more effectively with daily development tasks in a Rush-based monorepo environment.
+
 ## Usage
 
+1. To get the best results, copy the [.cursor](https://github.com/microsoft/rushstack/tree/main/.cursor) directory into the root of your project.
+
+2. Configure `@rushstack/mcp-server` in your AI application
+
+```
+{
+  "mcpServers": {
+    "rush": {
+      "command": "npx",
+      "args": ["-y", "@rushstack/mcp-server", "your-project-path"]
+    }
+  }
+}
+```
+
+3. Congratulations 🎉 You’ve completed the setup — Rush MCP is now ready to use!
+
+## Available Tools
+
+- `rush_docs`: Retrieves relevant documentation sections based on your queries
+- `rush_workspace_details`: Retrieve detailed workspace information
+- `rush_project_details`: Get detailed information about a specific project
+- `rush_command_validator`: Validate whether commands are compliant and follow best practices
+- `rush_migrate_project`: Migrate a project from one directory to another or into a different subspace
+- `rush_pnpm_lock_file_conflict_resolver`: Resolve pnpm-lock.yaml conflicts
+
 ## Links
+
+- [CHANGELOG.md](
+  https://github.com/microsoft/rushstack/blob/main/apps/rush-mcp-server/CHANGELOG.md) - Find
+  out what's new in the latest version

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/lib/start.js

@@ -16,7 +16,7 @@ const main = async () => {
     (0, log_1.log)('Rush MCP Server running on stdio');
 };
 main().catch((error) => {
-    (0, log_1.log)('Fatal error running server:', error);
+    (0, log_1.log)('Fatal error running server:', error instanceof Error ? error.message : error);
     process.exit(1);
 });
 //# sourceMappingURL=start.js.map

package/lib/start.js.map

@@ -1 +1 @@
-{"version":3,"file":"start.js","sourceRoot":"","sources":["../src/start.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAE3D,wEAAiF;AAEjF,yCAAsC;AACtC,qCAAyC;AAEzC,MAAM,IAAI,GAAG,KAAK,IAAmB,EAAE;IACrC,MAAM,iBAAiB,GAAuB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9D,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;IAC9E,CAAC;IAED,MAAM,MAAM,GAAkB,IAAI,sBAAa,CAAC,iBAAiB,CAAC,CAAC;IACnE,MAAM,SAAS,GAAyB,IAAI,+BAAoB,EAAE,CAAC;IACnE,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAEhC,IAAA,SAAG,EAAC,kCAAkC,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,IAAA,SAAG,EAAC,6BAA6B,EAAE,KAAK,CAAC,CAAC;IAC1C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,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 { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';\n\nimport { log } from './utilities/log';\nimport { RushMCPServer } from './server';\n\nconst main = async (): Promise<void> => {\n  const rushWorkspacePath: string | undefined = process.argv[2];\n  if (!rushWorkspacePath) {\n    throw new Error('Please provide workspace root path as the first argument');\n  }\n\n  const server: RushMCPServer = new RushMCPServer(rushWorkspacePath);\n  const transport: StdioServerTransport = new StdioServerTransport();\n  await server.connect(transport);\n\n  log('Rush MCP Server running on stdio');\n};\n\nmain().catch((error) => {\n  log('Fatal error running server:', error);\n  process.exit(1);\n});\n"]}
+{"version":3,"file":"start.js","sourceRoot":"","sources":["../src/start.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAE3D,wEAAiF;AAEjF,yCAAsC;AACtC,qCAAyC;AAEzC,MAAM,IAAI,GAAG,KAAK,IAAmB,EAAE;IACrC,MAAM,iBAAiB,GAAuB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9D,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;IAC9E,CAAC;IAED,MAAM,MAAM,GAAkB,IAAI,sBAAa,CAAC,iBAAiB,CAAC,CAAC;IACnE,MAAM,SAAS,GAAyB,IAAI,+BAAoB,EAAE,CAAC;IACnE,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAEhC,IAAA,SAAG,EAAC,kCAAkC,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,IAAA,SAAG,EAAC,6BAA6B,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACnF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,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 { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';\n\nimport { log } from './utilities/log';\nimport { RushMCPServer } from './server';\n\nconst main = async (): Promise<void> => {\n  const rushWorkspacePath: string | undefined = process.argv[2];\n  if (!rushWorkspacePath) {\n    throw new Error('Please provide workspace root path as the first argument');\n  }\n\n  const server: RushMCPServer = new RushMCPServer(rushWorkspacePath);\n  const transport: StdioServerTransport = new StdioServerTransport();\n  await server.connect(transport);\n\n  log('Rush MCP Server running on stdio');\n};\n\nmain().catch((error) => {\n  log('Fatal error running server:', error instanceof Error ? error.message : error);\n  process.exit(1);\n});\n"]}

package/lib/utilities/log.d.ts

@@ -1,4 +1,4 @@
-import { Terminal } from '@rushstack/terminal';
+import { Terminal, type TerminalWriteParameters } from '@rushstack/terminal';
 export declare const terminal: Terminal;
-export declare function log(message?: any, ...optionalParams: any[]): void;
+export declare function log(...messageParts: TerminalWriteParameters): void;
 //# sourceMappingURL=log.d.ts.map

package/lib/utilities/log.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../src/utilities/log.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAA2B,MAAM,qBAAqB,CAAC;AAExE,eAAO,MAAM,QAAQ,EAAE,QAA8E,CAAC;AAGtG,wBAAgB,GAAG,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE,GAAG,IAAI,CAEjE"}
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../src/utilities/log.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAA2B,KAAK,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAEtG,eAAO,MAAM,QAAQ,EAAE,QAA8E,CAAC;AAEtG,wBAAgB,GAAG,CAAC,GAAG,YAAY,EAAE,uBAAuB,GAAG,IAAI,CAElE"}

package/lib/utilities/log.js

@@ -6,8 +6,7 @@ exports.terminal = void 0;
 exports.log = log;
 const terminal_1 = require("@rushstack/terminal");
 exports.terminal = new terminal_1.Terminal(new terminal_1.ConsoleTerminalProvider({ verboseEnabled: true }));
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function log(message, ...optionalParams) {
-    exports.terminal.writeErrorLine(message, ...optionalParams);
+function log(...messageParts) {
+    exports.terminal.writeErrorLine(...messageParts);
 }
 //# sourceMappingURL=log.js.map

package/lib/utilities/log.js.map

@@ -1 +1 @@
-{"version":3,"file":"log.js","sourceRoot":"","sources":["../../src/utilities/log.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAO3D,kBAEC;AAPD,kDAAwE;AAE3D,QAAA,QAAQ,GAAa,IAAI,mBAAQ,CAAC,IAAI,kCAAuB,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAEtG,8DAA8D;AAC9D,SAAgB,GAAG,CAAC,OAAa,EAAE,GAAG,cAAqB;IACzD,gBAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAC;AACtD,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 { Terminal, ConsoleTerminalProvider } from '@rushstack/terminal';\n\nexport const terminal: Terminal = new Terminal(new ConsoleTerminalProvider({ verboseEnabled: true }));\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport function log(message?: any, ...optionalParams: any[]): void {\n  terminal.writeErrorLine(message, ...optionalParams);\n}\n"]}
+{"version":3,"file":"log.js","sourceRoot":"","sources":["../../src/utilities/log.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAM3D,kBAEC;AAND,kDAAsG;AAEzF,QAAA,QAAQ,GAAa,IAAI,mBAAQ,CAAC,IAAI,kCAAuB,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAEtG,SAAgB,GAAG,CAAC,GAAG,YAAqC;IAC1D,gBAAQ,CAAC,cAAc,CAAC,GAAG,YAAY,CAAC,CAAC;AAC3C,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 { Terminal, ConsoleTerminalProvider, type TerminalWriteParameters } from '@rushstack/terminal';\n\nexport const terminal: Terminal = new Terminal(new ConsoleTerminalProvider({ verboseEnabled: true }));\n\nexport function log(...messageParts: TerminalWriteParameters): void {\n  terminal.writeErrorLine(...messageParts);\n}\n"]}

package/package.json

@@ -1,7 +1,14 @@
 {
   "name": "@rushstack/mcp-server",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "A Model Context Protocol server implementation for Rush",
+  "keywords": [
+    "rush",
+    "modelcontextprotocol",
+    "mcp",
+    "monorepo",
+    "server"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/microsoft/rushstack.git",
@@ -21,14 +28,14 @@
     "zod": "~3.24.3",
     "@rushstack/node-core-library": "5.13.1",
     "@rushstack/terminal": "0.15.3",
-    "@rushstack/rush-sdk": "5.153.1",
+    "@rushstack/rush-sdk": "5.153.2",
     "@rushstack/ts-command-line": "5.0.1"
   },
   "devDependencies": {
     "typescript": "~5.8.2",
     "@types/node": "20.17.19",
     "local-node-rig": "1.0.0",
-    "@rushstack/heft": "0.73.5"
+    "@rushstack/heft": "0.73.6"
   },
   "scripts": {
     "build": "heft build --clean",