feat: extended protocol for conversation-based agents experience support

runtimes/README.md

@@ -31,6 +31,13 @@ The server runtime implementation acts as a proxy for LSP methods, which means i
 | onInlineCompletion | Yes     | Provide list of inline completion suggestions from the Server                                                                         |
 | onExecuteCommand   | Yes     | Executes a custom command provided by the Server. Servers are advised to document custom commands they support in the package README. |
 
+##### LSP Workspace
+
+| Description                          | Method                            | Params                         | Method type                                                                                                                     | Response Type   |
+| ------------------------------------ | --------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- | --------------- |
+| Request to select workspace item (folder, file) with the selected items returned | `aws/selectWorkspaceItem`         | `SelectWorkspaceItemParams`                   | [Request](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#requestMessage) Server to Client           | `SelectWorkspaceItemResult`    |
+| Sent notification to open file differences for the new file content. Supports new, updated or removed files. | `aws/openFileDiff`                | `OpenFileDiffParams`                | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) Server to Client          | n/a |
+
 ##### LSP Extensions
 
 | Method Name                         | Method                                            | Params                                    | Method Type                                                                                                                     | Response Type                        | Notes                                                                                                     |
@@ -159,21 +166,24 @@ The runtime supports chat by default
 
 | Description                          | Method                            | Params                         | Method type                                                                                                                     | Response Type   |
 | ------------------------------------ | --------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- | --------------- |
-| Send chat prompt                     | `aws/chat/sendChatPrompt`         | `ChatParams`                   | [Request](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#requestMessage)           | `ChatResult`    |
-| End conversation                     | `aws/chat/endChat`                | `EndChatParams`                | [Request](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#requestMessage)           | `EndChatResult` |
-| Send chat quick action               | `aws/chat/sendChatQuickAction`    | `QuickActionParams`            | [Request](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#requestMessage)           | `ChatResult`    |
-| Send chat UI ready event             | `aws/chat/ready`                  | n/a                            | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) | n/a             |
-| Send chat vote event                 | `aws/chat/vote`                   | `VoteParams`                   | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) | n/a             |
-| Send chat feedback event             | `aws/chat/feedback`               | `FeedbackParams`               | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) | n/a             |
-| Send tab add event                   | `aws/chat/tabAdd`                 | `TabAddParams`                 | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) | n/a             |
-| Send active tab change event         | `aws/chat/tabChange`              | `TabChangeParams`              | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) | n/a             |
-| Send tab remove event                | `aws/chat/tabRemove`              | `TabRemoveParams`              | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) | n/a             |
-| Send insert to cursor position event | `aws/chat/insertToCursorPosition` | `InsertToCursorPositionParams` | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) | n/a             |
-| Send copy code to clipboard event    | `aws/chat/copyCodeToClipboard`    | `CopyCodeToClipboardParams`    | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) | n/a             |
-| Send link click event                | `aws/chat/linkClick`              | `LinkClickParams`              | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) | n/a             |
-| Send info link click event           | `aws/chat/infoLinkClick`          | `InfoLinkClickParams`          | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) | n/a             |
-| Send source link click event         | `aws/chat/sourceLinkClick`        | `SourceLinkClickParams`        | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) | n/a             |
-| Send followup chat item click event  | `aws/chat/followUpClick`          | `FollowUpClickParams`          | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) | n/a             |
+| Send chat prompt. Supports streaming chat message content to client. Response is optional - this event can be used to only trigger chat prompt request and then `aws/chat/sendChatUpdate` can be used to send chat updates asyncronously. | `aws/chat/sendChatPrompt`         | `ChatParams`                   | [Request](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#requestMessage) Client to Server          | `ChatResult`    |
+| End conversation                     | `aws/chat/endChat`                | `EndChatParams`                | [Request](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#requestMessage) Client to Server          | `EndChatResult` |
+| Send chat quick action. Response is optional - this event can be used to only trigger chat quick action request and then `aws/chat/sendChatUpdate` can be used to send chat updates asyncronously. | `aws/chat/sendChatQuickAction`    | `QuickActionParams`            | [Request](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#requestMessage) Client to Server          | `ChatResult`    |
+| Send chat UI ready event             | `aws/chat/ready`                  | n/a                            | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) Client to Server | n/a             |
+| Send chat vote event                 | `aws/chat/vote`                   | `VoteParams`                   | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) Client to Server | n/a             |
+| Send chat feedback event             | `aws/chat/feedback`               | `FeedbackParams`               | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) Client to Server | n/a             |
+| Send tab add event                   | `aws/chat/tabAdd`                 | `TabAddParams`                 | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) Client to Server | n/a             |
+| Send active tab change event         | `aws/chat/tabChange`              | `TabChangeParams`              | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) Client to Server | n/a             |
+| Send tab remove event                | `aws/chat/tabRemove`              | `TabRemoveParams`              | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) Client to Server | n/a             |
+| Send insert to cursor position event | `aws/chat/insertToCursorPosition` | `InsertToCursorPositionParams` | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) Client to Server | n/a             |
+| Send copy code to clipboard event    | `aws/chat/copyCodeToClipboard`    | `CopyCodeToClipboardParams`    | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) Client to Server | n/a             |
+| Send link click event                | `aws/chat/linkClick`              | `LinkClickParams`              | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) Client to Server | n/a             |
+| Send info link click event           | `aws/chat/infoLinkClick`          | `InfoLinkClickParams`          | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) Client to Server | n/a             |
+| Send source link click event         | `aws/chat/sourceLinkClick`        | `SourceLinkClickParams`        | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) Client to Server | n/a             |
+| Send followup chat item click event  | `aws/chat/followUpClick`          | `FollowUpClickParams`          | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) Client to Server | n/a             |
+| Send request to open existing tab, if `tabId` is passed or create and open new tab, if `tabId` is not passed. For the new tab, it's also possible to set tab state and content.  | `aws/chat/openTab`          | `OpenTabParams`          | [Request](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#requestMessage) Server to Client | `OpenTabResult`             |
+| Send chat messages and tab state update to specific tab. Depending on new vs existing`messageId` within `ChatMessage` message, the massgage will be added or updated. | `aws/chat/sendChatUpdate`          | `ChatUpdateParams`          | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) Server to Client | n/a             |
+| Send file or file action click event. | `aws/chat/fileClick`          | `FileClickParams`          | [Notification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#notificationMessage) Client to Server | n/a             |
 
 ```ts
 export interface ChatPrompt {
@@ -182,25 +192,15 @@ export interface ChatPrompt {
     command?: string
 }
 
-export interface ChatParams {
-    tabId: string
-    prompt: ChatPrompt
-    partialResultToken?: ProgressToken
+interface PartialResultParams {
+    partialResultToken?: number | string
 }
 
-export interface ChatResult {
-    body?: string
-    messageId?: string
-    canBeVoted?: boolean // requires messageId to be filled to show vote thumbs
-    relatedContent?: {
-        title?: string
-        content: SourceLink[]
-    }
-    followUp?: {
-        text?: string
-        options?: ChatItemAction[]
-    }
-    codeReference?: ReferenceTrackerInformation[]
+export interface ChatParams extends PartialResultParams {
+    tabId: string
+    prompt: ChatPrompt
+    cursorState?: CursorState[]
+    textDocument?: TextDocumentIdentifier
 }
 ```
 

runtimes/protocol/chat.ts

@@ -35,6 +35,10 @@ import {
     OPEN_TAB_REQUEST_METHOD,
     OpenTabParams,
     OpenTabResult,
+    CHAT_UPDATE_NOTIFICATION_METHOD,
+    FILE_CLICK_NOTIFICATION_METHOD,
+    ChatUpdateParams,
+    FileClickParams,
 } from './lsp'
 
 export const chatRequestType = new AutoParameterStructuresProtocolRequestType<
@@ -81,3 +85,9 @@ export const followUpClickNotificationType = new ProtocolNotificationType<Follow
 export const openTabRequestType = new ProtocolRequestType<OpenTabParams, OpenTabResult, never, void, void>(
     OPEN_TAB_REQUEST_METHOD
 )
+export const chatUpdateNotificationType = new ProtocolNotificationType<ChatUpdateParams, void>(
+    CHAT_UPDATE_NOTIFICATION_METHOD
+)
+export const fileClickNotificationType = new ProtocolNotificationType<FileClickParams, void>(
+    FILE_CLICK_NOTIFICATION_METHOD
+)

runtimes/protocol/index.ts

@@ -12,3 +12,4 @@ export * from './lsp'
 export * from './notification'
 export * from './telemetry'
 export * from './configuration'
+export * from './workspace'

runtimes/protocol/workspace.ts

@@ -0,0 +1,21 @@
+import {
+    OPEN_FILE_DIFF_NOTIFICATION_METHOD,
+    OpenFileDiffParams,
+    ProtocolNotificationType,
+    ProtocolRequestType,
+    SELECT_WORKSPACE_ITEM_REQUEST_METHOD,
+    SelectWorkspaceItemParams,
+    SelectWorkspaceItemResult,
+} from './lsp'
+
+export const selectWorkspaceItemRequestType = new ProtocolRequestType<
+    SelectWorkspaceItemParams,
+    SelectWorkspaceItemResult,
+    never,
+    void,
+    void
+>(SELECT_WORKSPACE_ITEM_REQUEST_METHOD)
+
+export const openFileDiffNotificationType = new ProtocolNotificationType<OpenFileDiffParams, void>(
+    OPEN_FILE_DIFF_NOTIFICATION_METHOD
+)

runtimes/runtimes/base-runtime.ts

@@ -34,6 +34,10 @@ import {
     ShowMessageRequest,
     ShowDocumentRequest,
     openTabRequestType,
+    openFileDiffNotificationType,
+    selectWorkspaceItemRequestType,
+    chatUpdateNotificationType,
+    fileClickNotificationType,
 } from '../protocol'
 import { createConnection } from 'vscode-languageserver/browser'
 import {
@@ -135,6 +139,8 @@ export const baseRuntime = (connections: { reader: MessageReader; writer: Messag
         onSourceLinkClick: handler => lspConnection.onNotification(sourceLinkClickNotificationType.method, handler),
         onFollowUpClicked: handler => lspConnection.onNotification(followUpClickNotificationType.method, handler),
         openTab: params => lspConnection.sendRequest(openTabRequestType.method, params),
+        sendChatUpdate: params => lspConnection.sendNotification(chatUpdateNotificationType.method, params),
+        onFileClicked: handler => lspConnection.onNotification(fileClickNotificationType.method, handler),
     }
 
     const identityManagement: IdentityManagement = {
@@ -195,6 +201,8 @@ export const baseRuntime = (connections: { reader: MessageReader; writer: Messag
                 onDidDeleteFiles: params => lspConnection.workspace.onDidDeleteFiles(params),
                 onDidRenameFiles: params => lspConnection.workspace.onDidRenameFiles(params),
                 onUpdateConfiguration: lspServer.setUpdateConfigurationHandler,
+                selectWorkspaceItem: params => lspConnection.sendRequest(selectWorkspaceItemRequestType.method, params),
+                openFileDiff: params => lspConnection.sendNotification(openFileDiffNotificationType.method, params),
             },
             window: {
                 showMessage: params => lspConnection.sendNotification(ShowMessageNotification.method, params),

runtimes/runtimes/chat/baseChat.ts

@@ -32,6 +32,10 @@ import {
     OpenTabParams,
     OpenTabResult,
     openTabRequestType,
+    ChatUpdateParams,
+    chatUpdateNotificationType,
+    FileClickParams,
+    fileClickNotificationType,
 } from '../../protocol'
 import { Chat } from '../../server-interface'
 
@@ -93,4 +97,12 @@ export class BaseChat implements Chat {
     public openTab(params: OpenTabParams): Promise<OpenTabResult> {
         return this.connection.sendRequest(openTabRequestType.method, params)
     }
+
+    public sendChatUpdate(params: ChatUpdateParams) {
+        this.connection.sendNotification(chatUpdateNotificationType.method, params)
+    }
+
+    public onFileClicked(handler: NotificationHandler<FileClickParams>) {
+        this.connection.onNotification(fileClickNotificationType.method, handler)
+    }
 }

runtimes/runtimes/standalone.ts

@@ -21,6 +21,8 @@ import {
     CancellationToken,
     GetSsoTokenParams,
     didChangeDependencyPathsNotificationType,
+    openFileDiffNotificationType,
+    selectWorkspaceItemRequestType,
 } from '../protocol'
 import { ProposedFeatures, createConnection } from 'vscode-languageserver/node'
 import {
@@ -321,6 +323,9 @@ export const standalone = (props: RuntimeProps) => {
                     onDidDeleteFiles: params => lspConnection.workspace.onDidDeleteFiles(params),
                     onDidRenameFiles: params => lspConnection.workspace.onDidRenameFiles(params),
                     onUpdateConfiguration: lspServer.setUpdateConfigurationHandler,
+                    selectWorkspaceItem: params =>
+                        lspConnection.sendRequest(selectWorkspaceItemRequestType.method, params),
+                    openFileDiff: params => lspConnection.sendNotification(openFileDiffNotificationType.method, params),
                 },
                 window: {
                     showMessage: params => lspConnection.sendNotification(ShowMessageNotification.method, params),

runtimes/server-interface/chat.ts

@@ -18,6 +18,8 @@ import {
     TabRemoveParams,
     OpenTabParams,
     OpenTabResult,
+    ChatUpdateParams,
+    FileClickParams,
 } from '../protocol'
 
 /**
@@ -40,4 +42,6 @@ export type Chat = {
     onInfoLinkClick: (handler: NotificationHandler<InfoLinkClickParams>) => void
     onSourceLinkClick: (handler: NotificationHandler<SourceLinkClickParams>) => void
     onFollowUpClicked: (handler: NotificationHandler<FollowUpClickParams>) => void
+    sendChatUpdate: (params: ChatUpdateParams) => void
+    onFileClicked: (handler: NotificationHandler<FileClickParams>) => void
 }

runtimes/server-interface/lsp.ts

@@ -54,6 +54,9 @@ import {
     DidChangeDependencyPathsParams,
     UpdateConfigurationParams,
     InlineCompletionWithReferencesParams,
+    OpenFileDiffParams,
+    SelectWorkspaceItemParams,
+    SelectWorkspaceItemResult,
 } from '../protocol'
 
 // Re-export whole surface of LSP protocol used in Runtimes.
@@ -136,6 +139,10 @@ export type Lsp = {
         onDidDeleteFiles: (handler: NotificationHandler<DeleteFilesParams>) => void
         onDidRenameFiles: (handler: NotificationHandler<RenameFilesParams>) => void
         onUpdateConfiguration: (handler: RequestHandler<UpdateConfigurationParams, void, void>) => void
+        selectWorkspaceItem: (
+            handler: RequestHandler<SelectWorkspaceItemParams, SelectWorkspaceItemResult | undefined | null, void>
+        ) => void
+        openFileDiff: (params: OpenFileDiffParams) => void
     }
     window: {
         showMessage: (params: ShowMessageParams) => Promise<void>