Agent Instructions: Porting RPC Methods from Azure Data Studio to VS Code MSSQL

Overview

This guide enables an AI agent to port RPC-based functionality from Azure Data Studio (ADS) to the VS Code MSSQL extension following established patterns.

Prerequisites

• Access to both repositories:
  • Azure Data Studio:https://github.com/microsoft/azuredatastudio
  • VS Code MSSQL:https://github.com/microsoft/vscode-mssql

Input Required

The agent needs:

1. Functionality Name: The feature to port (e.g., "Profiler", "QueryPlan", "Backup", "Restore")
2. ADS Source Path: Path in ADS repo where the functionality exists (e.g.,src/sql/workbench/services/profiler/)

Step-by-Step Porting Process

Phase 1: Discovery and Analysis in Azure Data Studio Repo

Step 1.1: Locate the Service Interface

Search Pattern:I{FunctionalityName}Service interface
Typical Location:src/sql/workbench/services/{functionality}/common/{functionality}Service.ts

Agent Actions:

1. Find the interface definition (e.g.,IProfilerService)
2. Extract all method signatures
3. Note the return types (Promise types are important)
4. Document any event emitters or notifications

Example Interface to Extract:

exportinterfaceIProfilerService{createSession(ownerUri:string,sessionName:string,template:ProfilerSessionTemplate):Promise<boolean>;startSession(ownerUri:string,sessionName:string):Promise<boolean>;stopSession(ownerUri:string,sessionName:string):Promise<boolean>;// ... more methods}

Step 1.2: Locate Request/Response Contracts

Search Pattern: Request and Response type definitions
Typical Location:src/sql/workbench/services/{functionality}/common/{functionality}Contracts.ts or similar

Agent Actions:

1. Find all*Request and*Response types
2. Find all*Params types
3. Extract enums used by the functionality
4. Note any notification types (e.g.,*NotificationParams)

Example Contracts to Extract:

exportinterfaceCreateSessionRequest{ownerUri:string;sessionName:string;template:ProfilerSessionTemplate;}exportinterfaceCreateSessionResponse{succeeded:boolean;errorMessage?:string;}

Step 1.3: Locate RPC Request Definitions

Search Pattern:RequestType andNotificationType definitions
Typical Location: Same file as contracts or in a separate*Contracts.ts file

Agent Actions:

1. Find allRequestType<TParams, TResult> definitions
2. Find allNotificationType<TParams> definitions
3. Extract the RPC method names (string constants)
4. Map each RequestType to its params and response types

Example RPC Definitions to Extract:

exportnamespaceCreateXEventSessionRequest{exportconsttype=newRequestType<CreateXEventSessionParams,CreateXEventSessionResponse,void,void>('profiler/createsession');}exportnamespaceProfilerEventsAvailableNotification{exportconsttype=newNotificationType<ProfilerEventsAvailableParams,void>('profiler/eventsavailable');}

Step 1.4: Locate Supporting Types

Agent Actions:

1. Find all interface definitions used by the contracts (e.g.,ProfilerSessionTemplate,ProfilerEvent)
2. Find all enums (e.g.,ProfilingSessionType)
3. Extract complete type definitions with all properties
4. Note any default values or constants

Phase 2: Generate VS Code MSSQL Extension Files

Step 2.1: Generatevscode-mssql.d.ts Types

File Location:mssql/typings/vscode-mssql.d.ts

Agent Instructions:

1. Open the existingvscode-mssql.d.ts file
2. Locate thedeclare module "vscode-mssql" section
3. Add the service interface after existing service interfaces (e.g., afterIDacFxService)
4. Add all supporting types in the following order:
   • Enums first
   • Simple interfaces
   • Complex interfaces that depend on simple ones
   • The service interface last

Template for Service Interface:

exportinterfaceI{FunctionalityName}Service{// Method signatures from ADS IService interface{methodName}({params}):Promise<{ReturnType}>;// Notification registration methodsregisterOn{NotificationName}(handler:(params:{NotificationParams})=>void):void;}

Template for Types:

// Enumsexportenum{EnumName}{{Value1}={Number},{Value2}={Number}}// Parameter interfacesexportinterface{FunctionalityName}{Operation}Params{{property}:{type};// ... more properties}// Response interfacesexportinterface{FunctionalityName}{Operation}Response{succeeded:boolean;    errorMessage?:string;// ... more properties}// Event/Notification interfacesexportinterface{FunctionalityName}{Event}Params{// ... event properties}

Important Notes:

• Remove ADS-specific imports (likeimport * as azdata)
• Convert azdata types to plain TypeScript types
• Use `v...