Open the sample file and the mcp.json in a split editor when creating self-hosted MCP projects (#4946)

* Open the sample file and the mcp.json in a split editor when creating self-hosted MCP projects

* Update src/commands/createNewProject/mcpServerSteps/MCPOpenFileStep.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Use deterministic known-path selection for sampleToolFilePath

Agent-Logs-Url: https://github.com/microsoft/vscode-azurefunctions/sessions/e0865c26-ca93-495e-8072-8412eb458e26

Co-authored-by: nturinski <5290572+nturinski@users.noreply.github.com>

* {} linter

---------

Co-authored-by: Nathan Turinski <naturins@microsoft.comm>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: nturinski <5290572+nturinski@users.noreply.github.com>

Author: 4 people

src/commands/createNewProject/IProjectWizardContext.ts

@@ -39,6 +39,7 @@ export interface MCPProjectWizardContext extends IProjectWizardContext {
     serverLanguage?: ProjectLanguage;
     includeSnippets?: boolean;
     sampleMcpRepoUrl?: string;
+    sampleToolFilePath?: string;
 }
 
 export type OpenBehavior = 'AddToWorkspace' | 'OpenInNewWindow' | 'OpenInCurrentWindow' | 'AlreadyOpen' | 'DontOpen';

src/commands/createNewProject/mcpServerSteps/MCPDownloadSnippetsExecuteStep.ts

@@ -35,19 +35,68 @@ export class MCPDownloadSnippetsExecuteStep extends AzureWizardExecuteStepWithAc
         progress.report({ message: localize('downloadingSampleCodeExecute', 'Downloading sample server code...') });
         const sampleMcpRepoUrl: string = nonNullProp(context, 'sampleMcpRepoUrl');
         const sampleFiles: GitHubFileMetadata[] = await feedUtils.getJsonFeed(context, sampleMcpRepoUrl);
-        await this.downloadFilesRecursively(context, sampleFiles, context.projectPath);
+        const downloadedFiles = await this.downloadFilesRecursively(context, sampleFiles, context.projectPath);
+        context.sampleToolFilePath = MCPDownloadSnippetsExecuteStep.selectSampleToolFile(context.serverLanguage, downloadedFiles);
     }
 
-    private async downloadFilesRecursively(context: MCPProjectWizardContext, items: GitHubFileMetadata[], basePath: string): Promise<void> {
+    // Known entrypoint paths relative to the root of each language's sample GitHub repository
+    private static readonly knownToolPaths: Partial<Record<ProjectLanguage, string>> = {
+        [ProjectLanguage.TypeScript]: 'src/index.ts',
+        [ProjectLanguage.Python]: 'hello.py',
+        [ProjectLanguage.CSharp]: 'Tools/HelloTool.cs',
+    };
+
+    private static readonly languageExtensions: Partial<Record<ProjectLanguage, string>> = {
+        [ProjectLanguage.TypeScript]: '.ts',
+        [ProjectLanguage.Python]: '.py',
+        [ProjectLanguage.CSharp]: '.cs',
+    };
+
+    private static selectSampleToolFile(
+        language: ProjectLanguage | undefined,
+        files: { itemPath: string; destPath: string }[]
+    ): string | undefined {
+        if (!language) {
+            return undefined;
+        }
+
+        // Prefer the known entrypoint path for the language
+        const knownPath = MCPDownloadSnippetsExecuteStep.knownToolPaths[language];
+        if (knownPath) {
+            const match = files.find(f => f.itemPath === knownPath);
+            if (match) {
+                return match.destPath;
+            }
+        }
+
+        // Fallback: any file with the right extension, sorted for determinism
+        const sourceExt = MCPDownloadSnippetsExecuteStep.languageExtensions[language];
+        if (sourceExt) {
+            const candidates = files
+                .filter(f => f.destPath.endsWith(sourceExt))
+                .sort((a, b) => a.itemPath.localeCompare(b.itemPath));
+            return candidates[0]?.destPath;
+        }
+
+        return undefined;
+    }
+
+    private async downloadFilesRecursively(
+        context: MCPProjectWizardContext,
+        items: GitHubFileMetadata[],
+        basePath: string
+    ): Promise<{ itemPath: string; destPath: string }[]> {
+        const downloadedFiles: { itemPath: string; destPath: string }[] = [];
         // Download all files and directories at this level in parallel
         await Promise.all(items.map(async (item) => {
             if (item.type === 'file') {
-                await MCPDownloadSnippetsExecuteStep.downloadSingleFile({
+                const destPath = await MCPDownloadSnippetsExecuteStep.downloadSingleFile({
                     context, item,
                     destDirPath: basePath,
                     serverLanguage: context.serverLanguage,
                     projectName: path.basename(context.projectPath)
                 });
+                downloadedFiles.push({ itemPath: item.path, destPath });
             } else if (item.type === 'dir') {
                 // Create directory
                 const dirPath: string = path.join(basePath, item.name);
@@ -58,9 +107,11 @@ export class MCPDownloadSnippetsExecuteStep extends AzureWizardExecuteStepWithAc
                 const dirContents: GitHubFileMetadata[] = parseJson<GitHubFileMetadata[]>(nonNullProp(response, 'bodyAsText'));
 
                 // Recursively download directory contents
-                await this.downloadFilesRecursively(context, dirContents, dirPath);
+                const subFiles = await this.downloadFilesRecursively(context, dirContents, dirPath);
+                downloadedFiles.push(...subFiles);
             }
         }));
+        return downloadedFiles;
     }
 
     public shouldExecute(context: MCPProjectWizardContext): boolean {
@@ -73,7 +124,7 @@ export class MCPDownloadSnippetsExecuteStep extends AzureWizardExecuteStepWithAc
         destDirPath: string,
         projectName: string
         serverLanguage?: ProjectLanguage,
-    }): Promise<void> {
+    }): Promise<string> {
         const { context, item, destDirPath, serverLanguage, projectName } = options;
         const fileUrl: string = item.download_url;
         let destinationPath: string = path.join(destDirPath, item.name);
@@ -92,5 +143,6 @@ export class MCPDownloadSnippetsExecuteStep extends AzureWizardExecuteStepWithAc
             }
         }
         await AzExtFsExtra.writeFile(destinationPath, fileContent ?? '');
+        return destinationPath;
     }
 }

src/commands/createNewProject/mcpServerSteps/MCPOpenFileStep.ts

@@ -5,19 +5,26 @@
 
 import { AzExtFsExtra, AzureWizardExecuteStep } from '@microsoft/vscode-azext-utils';
 import * as path from 'path';
-import { Uri, window, workspace } from 'vscode';
+import { Uri, ViewColumn, window, workspace } from 'vscode';
 import { type MCPProjectWizardContext } from '../IProjectWizardContext';
 
 export class MCPOpenFileStep extends AzureWizardExecuteStep<MCPProjectWizardContext> {
     public priority: number = 240; // Execute before OpenFolderStep (priority 250) but after other project setup
 
     public async execute(context: MCPProjectWizardContext): Promise<void> {
         const mcpJsonFilePath: string = path.join(context.projectPath, '.vscode', 'mcp.json');
-        
         if (await AzExtFsExtra.pathExists(mcpJsonFilePath)) {
             const mcpJsonFile = await workspace.openTextDocument(Uri.file(mcpJsonFilePath));
             await window.showTextDocument(mcpJsonFile, { preview: false });
         }
+
+        // Open sample tool file in a side-by-side editor
+        if (context.sampleToolFilePath) {
+            if (await AzExtFsExtra.pathExists(context.sampleToolFilePath)) {
+                const doc = await workspace.openTextDocument(Uri.file(context.sampleToolFilePath));
+                await window.showTextDocument(doc, { preview: false, viewColumn: ViewColumn.Beside });
+            }
+        }
     }
 
     public shouldExecute(context: MCPProjectWizardContext): boolean {