Add get_spo_page Language Model Tool for SharePoint. Closes #588

Author: Saurabh7019

package.json

@@ -73,7 +73,7 @@
 				]
 			}
 		],
-		"languageModelTools": [			
+		"languageModelTools": [
 			{
 				"name": "install_spo_app",
 				"tags": [
@@ -445,6 +445,45 @@
 					}
 				}
 			},
+			{
+				"name": "get_spo_page",
+				"tags": [
+					"sharepoint",
+					"page",
+					"spfx-toolkit"
+				],
+				"toolReferenceName": "SharePointPageGet",
+				"displayName": "Get a SharePoint Page",
+				"modelDescription": "Retrieves detailed information about a specific modern SharePoint page. Returns page metadata including title, layout type, canvas content, and status. Use this tool to get details for a specific page by name, OR use the default parameter to get the site's home page. Do not provide both name and default. Do not use this tool to list multiple pages. Requires Microsoft 365 authentication and read permissions on the target site.",
+				"userDescription": "Gets information about a specific SharePoint page.",
+				"canBeReferencedInPrompt": true,
+				"icon": "$(info)",
+				"inputSchema": {
+					"type": "object",
+					"properties": {
+						"webUrl": {
+							"type": "string",
+							"description": "URL of the site where the page is located. This option is required.",
+							"default": ""
+						},
+						"name": {
+							"type": "string",
+							"description": "Name of the page to retrieve (e.g., 'home.aspx'). Do not use if 'default' is true.",
+							"default": ""
+						},
+						"default": {
+							"type": "boolean",
+							"description": "Set to true to retrieve the site's home page. Do not use if 'name' is specified.",
+							"default": false
+						},
+						"metadataOnly": {
+							"type": "boolean",
+							"description": "Set to only retrieve page metadata without canvas content. This option is optional.",
+							"default": false
+						}
+					}
+				}
+			},
 			{
 				"name": "list_spo_page",
 				"tags": [
@@ -560,7 +599,7 @@
 						}
 					}
 				}
-			},			
+			},
 			{
 				"name": "upgrade_spfx_project",
 				"tags": [
@@ -1409,4 +1448,4 @@
 		"use-debounce": "10.0.4",
 		"rehype-raw": "7.0.0"
 	}
-}
+}

src/chat/tools/ChatTools.ts

@@ -1,7 +1,22 @@
 import { lm } from 'vscode';
 import { Subscription } from '../../models';
 import { Extension } from '../../services/dataType/Extension';
-import { SharePointAppInstall, SharePointAppInstanceList, SharePointAppList, SharePointAppUninstall, SharePointAppUpgrade, SharePointListAdd, SharePointListGet, SharePointListRemove, SharePointPageAdd, SharePointPageList, SharePointSiteAdd, SharePointSiteGet, SharePointSiteRemove } from './spo/index';
+import {
+    SharePointAppInstall,
+    SharePointAppInstanceList,
+    SharePointAppList,
+    SharePointAppUninstall,
+    SharePointAppUpgrade,
+    SharePointListAdd,
+    SharePointListGet,
+    SharePointListRemove,
+    SharePointPageAdd,
+    SharePointPageGet,
+    SharePointPageList,
+    SharePointSiteAdd,
+    SharePointSiteGet,
+    SharePointSiteRemove
+} from './spo/index';
 import { SharePointFrameworkProjectUpgrade } from './spfx';
 
 
@@ -36,6 +51,9 @@ export class ChatTools {
         subscriptions.push(
             lm.registerTool('add_spo_page', new SharePointPageAdd())
         );
+        subscriptions.push(
+            lm.registerTool('get_spo_page', new SharePointPageGet())
+        );
         subscriptions.push(
             lm.registerTool('list_spo_page', new SharePointPageList())
         );

src/chat/tools/spo/index.ts

@@ -7,6 +7,7 @@ export * from './list/ListAdd';
 export * from './list/ListGet';
 export * from './list/ListRemove';
 export * from './page/PageAdd';
+export * from './page/PageGet';
 export * from './page/PageList';
 export * from './site/SiteAdd';
 export * from './site/SiteGet';

src/chat/tools/spo/page/PageGet.ts

@@ -0,0 +1,46 @@
+import { CancellationToken, LanguageModelTextPart, LanguageModelTool, LanguageModelToolInvocationOptions, LanguageModelToolInvocationPrepareOptions, LanguageModelToolResult, MarkdownString } from 'vscode';
+import { CliExecuter } from '../../../../services/executeWrappers/CliCommandExecuter';
+import { validateAuth } from '../utils/ToolAuthValidationUtil';
+
+
+interface ISharePointPageGetParameters {
+    webUrl: string;
+    name?: string;
+    default?: boolean;
+    metadataOnly?: boolean;
+}
+
+export class SharePointPageGet implements LanguageModelTool<ISharePointPageGetParameters> {
+    async invoke(
+        options: LanguageModelToolInvocationOptions<ISharePointPageGetParameters>,
+        _token: CancellationToken
+    ) {
+        const params = options.input;
+        const authValidationResult = await validateAuth();
+        if (authValidationResult !== true) {
+            return authValidationResult as LanguageModelToolResult;
+        }
+
+        const result = await CliExecuter.execute('spo page get', 'json', params);
+        if (result.stderr) {
+            return new LanguageModelToolResult([new LanguageModelTextPart(`Error: ${result.stderr}`)]);
+        }
+
+        return new LanguageModelToolResult([new LanguageModelTextPart(`Page retrieved successfully ${(result.stdout !== '' ? `\nResult: ${result.stdout}` : '')}`)]);
+    }
+
+    async prepareInvocation(
+        options: LanguageModelToolInvocationPrepareOptions<ISharePointPageGetParameters>,
+        _token: CancellationToken
+    ) {
+        const confirmationMessages = {
+            title: 'Get a SharePoint Online page',
+            message: new MarkdownString('Should I get a page with the following parameters?'),
+        };
+
+        return {
+            invocationMessage: 'Getting SharePoint Online page',
+            confirmationMessages,
+        };
+    }
+}