VS Code API

當身份驗證提供程式的身份驗證會話被新增、刪除或更改時觸發的 Event。

獲取使用者已登入指定提供程式的所有帳戶。將其與 getSession 配合使用，以獲取特定帳戶的身份驗證會話。

目前，只有兩個由內建擴充套件貢獻到編輯器並實現 GitHub 和 Microsoft 身份驗證的身份驗證提供程式：它們的 providerId 分別是 'github' 和 'microsoft'。

注意：獲取帳戶並不意味著您的擴充套件可以訪問該帳戶或其身份驗證會話。您可以透過呼叫 getSession 來驗證對帳戶的訪問許可權。

獲取與所需範圍匹配的身份驗證會話。如果未註冊具有 providerId 的提供程式，或者使用者不同意與擴充套件共享身份驗證資訊，則拒絕。如果存在多個具有相同範圍的會話，將向用戶顯示一個快速選擇器以選擇他們想要使用的帳戶。

目前，只有兩個由內建擴充套件貢獻到編輯器並實現 GitHub 和 Microsoft 身份驗證的身份驗證提供程式：它們的 providerId 分別是 'github' 和 'microsoft'。

獲取與所需範圍匹配的身份驗證會話。如果未註冊具有 providerId 的提供程式，或者使用者不同意與擴充套件共享身份驗證資訊，則拒絕。如果存在多個具有相同範圍的會話，將向用戶顯示一個快速選擇器以選擇他們想要使用的帳戶。

目前，只有兩個由內建擴充套件貢獻到編輯器並實現 GitHub 和 Microsoft 身份驗證的身份驗證提供程式：它們的 providerId 分別是 'github' 和 'microsoft'。

獲取與所需範圍匹配的身份驗證會話。如果未註冊具有 providerId 的提供程式，或者使用者不同意與擴充套件共享身份驗證資訊，則拒絕。如果存在多個具有相同範圍的會話，將向用戶顯示一個快速選擇器以選擇他們想要使用的帳戶。

目前，只有兩個由內建擴充套件貢獻到編輯器並實現 GitHub 和 Microsoft 身份驗證的身份驗證提供程式：它們的 providerId 分別是 'github' 和 'microsoft'。

註冊身份驗證提供程式。

每個 ID 只能有一個提供程式，如果 ID 已被另一個提供程式使用，則會丟擲錯誤。ID 區分大小寫。

建立一個新的 聊天參與者 例項。

執行由給定命令識別符號表示的命令。

• 注意 1： 執行編輯器命令時，並非所有型別都允許作為引數傳遞。允許的型別包括原始型別 string、boolean、number、undefined 和 null，以及 Position、Range、Uri 和 Location。
• 注意 2： 執行擴充套件貢獻的命令時沒有限制。

檢索所有可用命令的列表。以劃線開頭的命令被視為內部命令。

註冊一個可以透過鍵盤快捷鍵、選單項、操作或直接呼叫的命令。

使用已存在的命令識別符號兩次註冊命令將導致錯誤。

註冊一個文字編輯器命令，可以透過鍵盤快捷鍵、選單項、操作或直接呼叫。

文字編輯器命令與普通 命令 不同，它們只在呼叫命令時有活動編輯器時執行。此外，編輯器命令的命令處理程式可以訪問活動編輯器和 編輯 構建器。請注意，編輯構建器僅在回撥執行期間有效。

建立一個新的 評論控制器 例項。

當前活動的 除錯控制檯。如果沒有活動的除錯會話，傳送到除錯控制檯的輸出將不顯示。

當前活動的 除錯會話 或 undefined。活動的除錯會話是除錯操作浮動視窗所代表的會話，或者是除錯操作浮動視窗下拉選單中當前顯示的會話。如果沒有活動的除錯會話，則值為 undefined。

當前聚焦的執行緒或堆疊幀，如果沒有聚焦執行緒或堆疊，則為 undefined。只要有活動的除錯會話，執行緒就可以被聚焦，而堆疊幀只能在會話暫停並檢索到呼叫堆疊時被聚焦。

斷點列表。

當 活動除錯會話 更改時觸發的 Event。注意，當活動除錯會話更改為 undefined 時，該事件也會觸發。

當 debug.activeStackItem 更改時觸發的事件。

當斷點集被新增、刪除或更改時發出的 Event。

當從 除錯會話 收到自定義 DAP 事件時觸發的 Event。

當新的 除錯會話 啟動時觸發的 Event。

當 除錯會話 終止時觸發的 Event。

新增斷點。

將透過除錯介面卡協議接收的“Source”描述符物件轉換為可用於載入其內容的 Uri。如果源描述符基於路徑，則返回檔案 Uri。如果源描述符使用引用編號，則構造一個需要相應 ContentProvider 和正在執行的除錯會話的特定除錯 Uri（方案 'debug'）

如果“Source”描述符沒有足夠的資訊來建立 Uri，則會丟擲錯誤。

為特定除錯型別註冊 除錯介面卡描述符工廠。擴充套件只允許為其定義的除錯型別註冊 DebugAdapterDescriptorFactory。否則會丟擲錯誤。為一種除錯型別註冊多個 DebugAdapterDescriptorFactory 會導致錯誤。

為給定除錯型別註冊除錯介面卡跟蹤器工廠。

為特定除錯型別註冊 除錯配置提供程式。可選的 triggerKind 可用於指定何時觸發提供程式的 provideDebugConfigurations 方法。目前有兩種觸發方式：值為 Initial（或未給出觸發方式引數）時，provideDebugConfigurations 方法用於提供初始除錯配置以複製到新建立的 launch.json 中。使用觸發方式 Dynamic 時，provideDebugConfigurations 方法用於動態確定要呈現給使用者的除錯配置（除了 launch.json 中的靜態配置）。請注意，triggerKind 引數僅適用於 provideDebugConfigurations 方法：因此 resolveDebugConfiguration 方法完全不受影響。為不同觸發方式註冊具有解析方法的單個提供程式，會導致多次呼叫相同的解析方法。可以為相同型別註冊多個提供程式。

移除斷點。

透過使用命名的啟動或命名的複合配置，或透過直接傳遞 DebugConfiguration 來開始除錯。命名的配置將在給定資料夾中找到的 '.vscode/launch.json' 中查詢。在除錯開始之前，所有未儲存的檔案都將儲存，並且啟動配置將更新。配置中使用的資料夾特定變數（例如 '${workspaceFolder}'）將根據給定資料夾解析。

停止給定的除錯會話，如果省略會話，則停止所有除錯會話。

應用程式的託管位置。在桌面端是 'desktop'，在 Web 端是指定的嵌入器，例如 'github.dev'、'codespaces'，或者如果嵌入器未提供該資訊，則為 'web'。

編輯器的應用程式名稱，例如 'VS Code'。

編輯器執行的應用程式根資料夾。

注意，在沒有應用程式根資料夾表示的環境中執行時，該值為空字串。

系統剪貼簿。

指示這是應用程式的全新安裝。如果在安裝後的第一天內，則為 true，否則為 false。

指示使用者是否啟用了遙測。可以觀察到這一點以確定擴充套件是否應該傳送遙測。

表示首選使用者語言，例如 de-CH、fr 或 en-US。

編輯器的當前日誌級別。

計算機的唯一識別符號。

遠端的名稱。由擴充套件定義，流行的示例包括 Windows Subsystem for Linux 的 wsl 或使用安全 shell 的遠端的 ssh-remote。

注意，當沒有遠端擴充套件主機時，該值為 undefined，但在存在遠端擴充套件主機時，所有擴充套件主機（本地和遠端）中都定義了該值。使用 Extension.extensionKind 來了解特定擴充套件是否遠端執行。

當前會話的唯一識別符號。每次啟動編輯器時都會更改。

檢測到的擴充套件主機的預設 shell，這由擴充套件主機平臺的 terminal.integrated.defaultProfile 設定覆蓋。請注意，在不支援 shell 的環境中，該值為空字串。

UI 型別屬性指示從哪個 UI 訪問擴充套件。例如，可以從桌面應用程式或 Web 瀏覽器訪問擴充套件。

編輯器在作業系統中註冊的自定義 URI 方案。

當編輯器的日誌級別更改時觸發的 Event。

當預設 shell 更改時觸發的 Event。這將觸發新的 shell 路徑。

當用戶啟用或停用遙測時觸發的 Event。如果使用者啟用了遙測，則為 true，如果使用者停用了遙測，則為 false。

將 URI 解析為外部可訪問的形式。

http: 或 https: 方案

將從擴充套件執行位置的 外部 URI（例如 http: 或 https: 連結）解析為客戶端機器上相同資源的 URI。

如果擴充套件在客戶端機器上執行，則此操作是空操作。

如果擴充套件遠端執行，此函式會自動在本地機器和遠端上的 target 之間建立埠轉發隧道，並返回隧道的本地 URI。埠轉發隧道的生命週期由編輯器管理，並且隧道可以由使用者關閉。

注意，透過 openExternal 傳遞的 URI 會自動解析，您不應該對它們呼叫 asExternalUri。

vscode.env.uriScheme

建立一個 URI，如果它在瀏覽器中開啟（例如透過 openExternal），將觸發已註冊的 UriHandler。

擴充套件不應假定結果 URI 的任何內容，也不應以任何方式更改它。相反，擴充套件可以例如在身份驗證流程中使用此 URI，透過將該 URI 作為回撥查詢引數新增到伺服器以進行身份驗證。

注意，如果伺服器決定向 URI 新增額外的查詢引數（例如令牌或金鑰），它們將出現在傳遞給 UriHandler 的 URI 中。

身份驗證流程的示例

vscode.window.registerUriHandler({
  handleUri(uri: vscode.Uri): vscode.ProviderResult<void> {
    if (uri.path === '/did-authenticate') {
      console.log(uri.toString());
    }
  }
});

const callableUri = await vscode.env.asExternalUri(
  vscode.Uri.parse(vscode.env.uriScheme + '://my.extension/did-authenticate')
);
await vscode.env.openExternal(callableUri);

注意，擴充套件不應快取 asExternalUri 的結果，因為解析的 URI 可能會由於系統或使用者操作而失效——例如，在遠端情況下，使用者可能會關閉由 asExternalUri 開啟的埠轉發隧道。

任何其他方案

任何其他方案都將按照提供的 URI 是工作區 URI 的方式處理。在這種情況下，該方法將返回一個 URI，當處理該 URI 時，編輯器將開啟工作區。

建立一個新的 遙測記錄器。

使用預設應用程式外部開啟連結。根據使用的方案，這可以是

• 瀏覽器（http:，https:）
• 郵件客戶端（mailto:）
• VSCode 本身（來自 vscode.env.uriScheme 的 vscode:）

注意，showTextDocument 是在編輯器中開啟文字文件的正確方法，而不是此函式。

系統當前已知的所有擴充套件。

當 extensions.all 更改時觸發的事件。這可能發生在擴充套件安裝、解除安裝、啟用或停用時。

透過其完整識別符號（形式為：publisher.name）獲取擴充套件。

為擴充套件載入的本地化字串包。如果未載入任何包，則為 undefined。如果未找到包或我們正在使用預設語言執行時，則通常不載入包。

為擴充套件載入的本地化包的 URI。如果未載入任何包，則為 undefined。如果未找到包或我們正在使用預設語言執行時，則通常不載入包。

標記字串以進行本地化。如果 env.language 指定的語言有可用的本地化包，並且該包對該訊息有本地化值，則將返回該本地化值（併為任何模板值注入 args 值）。

示例

l10n.t('Hello {0}!', 'World');

標記字串以進行本地化。如果 env.language 指定的語言有可用的本地化包，並且該包對該訊息有本地化值，則將返回該本地化值（併為任何模板值注入 args 值）。

示例

l10n.t('Hello {name}', { name: 'Erich' });

標記字串以進行本地化。如果 env.language 指定的語言有可用的本地化包，並且該包對該訊息有本地化值，則將返回該本地化值（併為任何模板值注入 args 值）。

當全域性診斷集更改時觸發的 Event。這是新新增和移除的診斷。

建立一個診斷集合。

建立一個新的 語言狀態項。

獲取給定資源的所有診斷。

獲取所有診斷。

返回所有已知語言的識別符號。

計算文件 選擇器 和文件之間的匹配度。值大於零表示選擇器匹配文件。

匹配度根據以下規則計算

1. 當 DocumentSelector 是一個數組時，計算每個包含的 DocumentFilter 或語言識別符號的匹配度，並取最大值。
2. 字串將被解糖為 DocumentFilter 的 language 部分，因此 "fooLang" 就像 { language: "fooLang" }。
3. 一個 DocumentFilter 將透過將其部分與文件進行比較來與文件匹配。適用以下規則
   1. 當 DocumentFilter 為空 ({}) 時，結果為 0
   2. 當定義了 scheme、language、pattern 或 notebook 但其中一個不匹配時，結果為 0
   3. 匹配 * 的分數為 5，透過相等或 glob 模式匹配的分數為 10
   4. 結果是每個匹配的最大值

示例

// default document from disk (file-scheme)
doc.uri; //'file:///my/file.js'
doc.languageId; // 'javascript'
match('javascript', doc); // 10;
match({ language: 'javascript' }, doc); // 10;
match({ language: 'javascript', scheme: 'file' }, doc); // 10;
match('*', doc); // 5
match('fooLang', doc); // 0
match(['fooLang', '*'], doc); // 5

// virtual document, e.g. from git-index
doc.uri; // 'git:/my/file.js'
doc.languageId; // 'javascript'
match('javascript', doc); // 10;
match({ language: 'javascript', scheme: 'git' }, doc); // 10;
match('*', doc); // 5

// notebook cell document
doc.uri; // `vscode-notebook-cell:///my/notebook.ipynb#gl65s2pmha`;
doc.languageId; // 'python'
match({ notebookType: 'jupyter-notebook' }, doc); // 10
match({ notebookType: 'fooNotebook', language: 'python' }, doc); // 0
match({ language: 'python' }, doc); // 10
match({ notebookType: '*' }, doc); // 5

註冊一個呼叫層次結構提供程式。

註冊一個程式碼操作提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個程式碼鏡頭提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個顏色提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個補全提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將根據其 分數 進行排序，並按順序請求相同分數的組提供補全項。當一個或多個組的提供程式返回結果時，該過程停止。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

補全項提供程式可以與一組 triggerCharacters 相關聯。當鍵入觸發字元時，會請求補全，但只從註冊了鍵入字元的提供程式請求。因此，觸發字元應不同於 單詞字元，常見的觸發字元是 . 以觸發成員補全。

註冊一個宣告提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個定義提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個新的 DocumentDropEditProvider。

可以為一種語言註冊多個拖放提供程式。當內容拖放到編輯器中時，所有註冊的編輯器語言提供程式將根據其 DocumentDropEditProviderMetadata 指定的 mime 型別被呼叫。

每個提供程式可以返回一個或多個 DocumentDropEdit。編輯項根據 DocumentDropEdit.yieldTo 屬性排序。預設情況下，將應用第一個編輯項。如果有任何附加的編輯項，它們將作為可選擇的拖放選項顯示在拖放小部件中。

為文件註冊格式化提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將根據其 分數 進行排序，並使用最佳匹配的提供程式。所選提供程式的失敗將導致整個操作失敗。

註冊一個文件高亮提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將根據其 分數 進行排序，並按順序請求文件高亮。當提供程式返回一個 非假值 或 非失敗 結果時，該過程停止。

註冊一個文件連結提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個新的 DocumentPasteEditProvider。

可以為一種語言註冊多個提供程式。根據 DocumentPasteProviderMetadata 指定的處理的 MIME 型別，所有為該語言註冊的提供程式都將用於複製和貼上操作。

對於 複製操作，每個提供程式對 DataTransfer 所做的更改將合併到一個 DataTransfer 中，該 DataTransfer 用於填充剪貼簿。

對於 [DocumentPasteEditProvider.providerDocumentPasteEdits 貼上操作](#DocumentPasteEditProvider.providerDocumentPasteEdits 貼上操作)，每個提供程式都將被呼叫，並且可以返回一個或多個 DocumentPasteEdit。編輯項根據 DocumentPasteEdit.yieldTo 屬性進行排序。預設情況下，將應用第一個編輯項，其餘編輯項將作為可選擇的貼上選項顯示在貼上小部件中。

為文件範圍註冊格式化提供程式。

注意： 文件範圍提供程式也是一個 文件格式化程式，這意味著在註冊範圍提供程式時無需 註冊 文件格式化程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將根據其 分數 進行排序，並使用最佳匹配的提供程式。所選提供程式的失敗將導致整個操作失敗。

為文件範圍註冊語義令牌提供程式。

注意：如果文件同時具有 DocumentSemanticTokensProvider 和 DocumentRangeSemanticTokensProvider，則範圍提供程式將僅在初始階段呼叫，即在完整文件提供程式解析第一個請求時。一旦完整文件提供程式解析了第一個請求，透過範圍提供程式提供的語義令牌將被丟棄，並且從那時起，將僅使用文件提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將根據其 分數 進行排序，並使用最佳匹配的提供程式。所選提供程式的失敗將導致整個操作失敗。

為整個文件註冊語義令牌提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將根據其 分數 進行排序，並使用最佳匹配的提供程式。所選提供程式的失敗將導致整個操作失敗。

註冊一個文件符號提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個提供程式，用於在文字文件中查詢可評估的表示式。編輯器將在活動的除錯會話中評估表示式，並在除錯懸停中顯示結果。

如果為一種語言註冊了多個提供程式，將使用任意一個提供程式。

註冊一個摺疊範圍提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。如果多個摺疊範圍從相同位置開始，則僅使用第一個註冊提供程式的範圍。如果摺疊範圍與具有較小位置的另一個範圍重疊，則也會忽略它。

失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個懸停提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個實現提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個內聯提示提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個內聯完成提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個提供程式，用於返回偵錯程式“內聯值”功能的資料。每當通用偵錯程式在原始檔中停止時，都會呼叫為該檔案語言註冊的提供程式，以返回將在行尾編輯器中顯示的文字資料。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個連結編輯範圍提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式按其分數排序，並使用最佳匹配且有結果的提供程式。所選提供程式的失敗將導致整個操作的失敗。

註冊一個在鍵入時進行格式化的提供程式。當用戶啟用 `editor.formatOnType` 設定時，此提供程式將處於活動狀態。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將根據其 分數 進行排序，並使用最佳匹配的提供程式。所選提供程式的失敗將導致整個操作失敗。

註冊一個引用提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個重新命名提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式按其分數排序並按順序詢問。第一個產生結果的提供程式定義整個操作的結果。

註冊一個選擇範圍提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個簽名幫助提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式按其分數排序並按順序呼叫，直到某個提供程式返回有效結果。

另請參閱 languages.registerSignatureHelpProvider

註冊一個型別定義提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個型別層次結構提供程式。

註冊一個工作區符號提供程式。

可以註冊多個提供程式。在這種情況下，提供程式並行請求，結果合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

為一種語言設定語言配置。

設定（並更改）與給定文件關聯的語言。

請注意，呼叫此函式將觸發 onDidCloseTextDocument 事件，然後觸發 onDidOpenTextDocument 事件。

所有擴充套件透過lm.registerTool註冊的所有可用工具的列表。可以使用lm.invokeTool呼叫它們，輸入與它們宣告的`inputSchema`匹配。

當可用聊天模型的集合發生變化時觸發的事件。

根據給定的輸入，按名稱呼叫lm.tools中列出的工具。輸入將根據工具宣告的`inputSchema`進行驗證

工具可以由聊天參與者在處理聊天請求的上下文中呼叫，也可以由任何擴充套件在全球範圍內在任何自定義流程中呼叫。

在前一種情況下，呼叫者應傳遞來自聊天請求的toolInvocationToken。這確保聊天 UI 為正確的對話顯示工具呼叫。

工具結果是文字和prompt-tsx部分組成的陣列。如果工具呼叫者使用`vscode/prompt-tsx`，它可以使用`ToolResult`將其響應部分合併到其提示中。如果不是，可以透過帶有LanguageModelToolResultPart的使用者訊息將這些部分傳遞給LanguageModelChat。

如果聊天參與者希望在多次互動中保留請求的工具結果，它可以將工具結果儲存在處理程式返回的ChatResult.metadata中，並在下次互動時從ChatResponseTurn.result中檢索它們。

註冊一個LanguageModelChatProvider 注意：您還必須透過 package.json 中的 `languageModelChatProviders` 貢獻點定義語言模型聊天提供程式。

註冊一個提供程式，用於釋出模型上下文協議（Model Context Protocol）伺服器供編輯器使用。這允許 MCP 伺服器動態地提供給編輯器，除了使用者在其配置檔案中建立的那些之外。

在呼叫此方法之前，擴充套件必須使用相應的id註冊`contributes.mcpServerDefinitionProviders`擴充套件點，例如

    "contributes": {
        "mcpServerDefinitionProviders": [
            {
                "id": "cool-cloud-registry.mcp-servers",
                "label": "Cool Cloud Registry",
            }
        ]
    }

當新的 McpServerDefinitionProvider 可用時，編輯器將向用戶顯示“重新整理”操作以發現新伺服器。為了啟用此流程，擴充套件應在啟用期間呼叫 `registerMcpServerDefinitionProvider`。

註冊一個 LanguageModelTool。該工具還必須在 package.json 的 `languageModelTools` 貢獻點中註冊。註冊的工具可在 lm.tools 列表中供任何擴充套件檢視。但為了讓語言模型看到它，必須在 LanguageModelChatRequestOptions.tools 中將其作為可用工具列表傳遞。

透過選擇器選擇聊天模型。這可能產生多個或沒有聊天模型，擴充套件必須優雅地處理這些情況，特別是在沒有聊天模型存在時。

const models = await vscode.lm.selectChatModels({ family: 'gpt-3.5-turbo' });
if (models.length > 0) {
    const [first] = models;
    const response = await first.sendRequest(...)
    // ...
} else {
    // NO chat models available
}

選擇器可以廣泛匹配給定供應商或家族的所有模型，也可以透過 ID 精確選擇一個模型。請記住，可用模型的集合會隨時間變化，並且在不同模型中提示的效能可能會有所不同。

請注意，擴充套件可以保留此函式返回的結果並在以後使用它們。但是，當 onDidChangeChatModels 事件觸發時，聊天模型列表可能已更改，擴充套件應重新查詢。

建立一個新的 Notebook 控制器。

建立用於與特定渲染器通訊的新訊息傳遞例項。

• 注意 1: 擴充套件只能建立其在 `package.json` 檔案中定義的渲染器。
• 注意 2: 只有當 `requiresMessaging` 在其 `notebookRenderer` 貢獻中設定為 `always` 或 `optional` 時，渲染器才能訪問訊息傳遞。

為給定 Notebook 型別註冊一個單元格狀態列項提供程式。

擴充套件建立的最後一個原始碼控制的輸入框。

• 已棄用 - 請改用 SourceControl.inputBox

建立一個新的原始碼控制例項。

當前活動任務執行或空陣列。

任務結束時觸發。

當底層程序結束時觸發。對於不執行底層程序的任務，此事件不會觸發。

任務開始時觸發。

當底層程序啟動時觸發。對於不執行底層程序的任務，此事件不會觸發。

執行由編輯器管理的一個任務。返回的任務執行可用於終止該任務。

• 丟擲 - 在無法啟動新程序的環境中執行 ShellExecution 或 ProcessExecution 任務時。在這種環境中，只能執行 CustomExecution 任務。

獲取系統中所有可用的任務。這包括來自 `tasks.json` 檔案的任務以及透過擴充套件貢獻的任務提供程式提供的任務。

註冊一個任務提供程式。

建立一個新的測試控制器。

設定中配置的當前活動顏色主題。可以透過 `workbench.colorTheme` 設定更改活動主題。

當前活動的筆記本編輯器或 `undefined`。活動編輯器是指當前獲得焦點的編輯器，或者在沒有焦點時，最近更改輸入的編輯器。

當前活動的終端或`undefined`。活動終端是指當前具有焦點或最近具有焦點的終端。

當前活動的編輯器或 `undefined`。活動編輯器是指當前獲得焦點的編輯器，或者在沒有焦點時，最近更改輸入的編輯器。

表示當前視窗的狀態。

表示主編輯器區域內的網格小部件

當前開啟的終端或空陣列。

當前可見的筆記本編輯器或空陣列。

當前可見的編輯器或空陣列。

當活動顏色主題更改或有更改時觸發的事件。

當活動的 Notebook 編輯器發生變化時觸發的事件。注意，當活動編輯器變為`undefined`時，此事件也會觸發。

當活動的終端發生變化時觸發的事件。請注意，當活動的終端變為`undefined`時，此事件也會觸發。

當活動編輯器發生變化時觸發的事件。請注意，當活動編輯器變為`undefined`時，此事件也會觸發。

當筆記本編輯器選擇發生變化時觸發的事件。

當筆記本編輯器可見範圍發生變化時觸發的事件。

當 shell 整合在終端中啟用或其屬性之一發生變化時觸發。

當終端狀態發生變化時觸發的事件。

當編輯器選項發生更改時觸發的事件。

當編輯器中的選擇發生更改時觸發的事件。

當編輯器檢視列發生更改時觸發的事件。

當編輯器可見範圍發生更改時觸發的事件。

當可見筆記本編輯器發生變化時觸發的事件。

當可見編輯器陣列發生更改時觸發的事件。

噹噹前視窗的焦點或活動狀態發生變化時觸發的事件。事件的值表示視窗是否處於焦點。

當終端被釋放時觸發的事件。

當終端命令結束時，此事件將被觸發。此事件僅在終端的shell 整合被啟用時才會觸發。

當終端被建立時觸發的事件，無論是透過 createTerminal API 還是命令。

當終端命令啟動時，此事件將被觸發。此事件僅在終端的shell 整合被啟用時才會觸發。

建立一個InputBox以讓使用者輸入一些文字。

請注意，在許多情況下，更方便的 window.showInputBox 更易於使用。window.createInputBox 應在 window.showInputBox 無法提供所需靈活性時使用。

建立一個具有給定名稱和語言 ID 的新輸出通道。如果未提供語言 ID，則預設使用 Log 作為語言 ID。

您可以從可見編輯器或活動編輯器訪問可見或活動的輸出通道作為文字文件，並使用語言 ID 貢獻語言功能，如語法著色、程式碼透鏡等。

建立一個具有給定名稱的新日誌輸出通道。

建立一個QuickPick，讓使用者從 T 型別專案列表中選擇一個專案。

請注意，在許多情況下，更方便的 window.showQuickPick 更易於使用。window.createQuickPick 應在 window.showQuickPick 無法提供所需靈活性時使用。

建立一個狀態列項。

建立一個狀態列項。

另請參閱 createStatusBarItem，用於建立帶識別符號的狀態列項。

建立一個帶有後端 shell 程序的終端。如果工作區目錄存在，終端的當前工作目錄將是工作區目錄。

• 丟擲 - 在無法啟動新程序的環境中執行時。

建立一個帶有後端 shell 程序的終端。

• 丟擲 - 在無法啟動新程序的環境中執行時。

建立一個終端，其中擴充套件程式控制其輸入和輸出。

建立一個 TextEditorDecorationType，可用於向文字編輯器新增裝飾。

為使用擴充套件點`views`貢獻的檢視建立一個TreeView。

建立並顯示一個新的 webview 面板。

為 `customEditors` 擴充套件點貢獻的 `viewType` 註冊自定義編輯器提供程式。

當自定義編輯器開啟時，會觸發 `onCustomEditor:viewType` 啟用事件。您的擴充套件必須在啟用期間為 `viewType` 註冊一個 CustomTextEditorProvider、CustomReadonlyEditorProvider 或 CustomEditorProvider。

註冊一個檔案裝飾提供程式。

註冊一個提供程式，用於在終端內檢測和處理連結。

註冊一個貢獻終端配置檔案的提供程式。

為使用擴充套件點 `views` 貢獻的檢視註冊一個 TreeDataProvider。這將允許您向 TreeView 貢獻資料，並在資料更改時進行更新。

注意：要訪問TreeView並對其執行操作，請使用createTreeView。

註冊一個能夠處理系統範圍URI的URI 處理程式。如果有多個視窗開啟，則最頂層的視窗將處理該 URI。URI 處理程式的作用域限定為其貢獻的擴充套件；它只能處理指向該擴充套件本身的 URI。URI 必須遵守以下規則：

• uri-scheme 必須是 `vscode.env.uriScheme`；
• uri-authority 必須是擴充套件 ID（例如 `my.extension`）；
• uri-path、-query 和 -fragment 部分是任意的。

例如，如果 `my.extension` 擴充套件註冊了一個 uri 處理程式，它將只被允許處理帶有 `product-name://my.extension` 字首的 uri。

一個擴充套件在其整個啟用生命週期中只能註冊一個 URI 處理程式。

• 注意：當定向到當前擴充套件的 URI 即將處理時，會觸發 `onUri` 啟用事件。

註冊一個 webview 面板序列化程式。

支援恢復的擴充套件應具有 `“onWebviewPanel:viewType”` 啟用事件，並確保在啟用期間呼叫 `registerWebviewPanelSerializer`。

對於給定的 `viewType`，一次只能註冊一個序列化程式。

註冊一個新的 webview 檢視提供程式。

向狀態列設定一條訊息。這是功能更強大的狀態列專案的簡寫。

向狀態列設定一條訊息。這是功能更強大的狀態列專案的簡寫。

向狀態列設定一條訊息。這是功能更強大的狀態列專案的簡寫。

請注意，狀態列訊息是堆疊的，不再使用時必須釋放。

顯示錯誤訊息。

另請參閱 showInformationMessage

顯示錯誤訊息。

另請參閱 showInformationMessage

顯示錯誤訊息。

另請參閱 showInformationMessage

顯示錯誤訊息。

另請參閱 showInformationMessage

向用戶顯示一條資訊訊息。可選地提供一組專案，這些專案將作為可點選按鈕呈現。

向用戶顯示一條資訊訊息。可選地提供一組專案，這些專案將作為可點選按鈕呈現。

顯示一條資訊訊息。

另請參閱 showInformationMessage

顯示一條資訊訊息。

另請參閱 showInformationMessage

開啟一個輸入框，要求使用者輸入。

如果輸入框被取消（例如按下 ESC 鍵），則返回值為 `undefined`。否則，返回值為使用者輸入的字串，如果使用者未輸入任何內容但透過“確定”關閉輸入框，則返回空字串。

在筆記本編輯器中顯示給定的NotebookDocument。

向用戶顯示一個檔案開啟對話方塊，允許選擇要開啟的檔案。

顯示一個允許進行多項選擇的選擇列表。

顯示一個選擇列表。

顯示一個允許進行多項選擇的選擇列表。

顯示一個選擇列表。

向用戶顯示一個檔案儲存對話方塊，允許選擇要儲存的檔案。