Skip to content

Commit d1ff357

Browse files
author
gitName
committed
[APIC] VSCode ext - language model tools
1 parent 453d5d8 commit d1ff357

File tree

4 files changed

+59
-8
lines changed

4 files changed

+59
-8
lines changed

articles/api-center/discover-apis-vscode-extension.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: API developers can use the Azure API Center extension for Visual St
44
author: dlepow
55
ms.service: azure-api-center
66
ms.topic: how-to
7-
ms.date: 10/16/2024
7+
ms.date: 05/27/2025
88
ms.author: danlep
99
ms.custom:
1010
# Customer intent: As an API developer, I want to use my Visual Studio Code environment to discover and consume APIs in my organizations API center.
@@ -53,7 +53,7 @@ You can view the documentation for an API definition in your API center and try
5353
> Depending on the API, you might need to provide authorization credentials or an API key to try the API.
5454
5555
> [!TIP]
56-
> Using the pre-release version of the extension, you can generate API documentation in Markdown, a format that's easy to maintain and share with end users. Right-click on the definition, and select **Generate Markdown**.
56+
> You can generate API documentation in Markdown, a format that's easy to maintain and share with end users. Right-click on the definition, and select **Generate Markdown**.
5757
5858
## Generate HTTP file
5959

@@ -103,6 +103,27 @@ You can also export a specification using the Command Palette:
103103
1. Select **Azure API Center: Export API Specification Document**.
104104
1. Make selections to navigate to an API definition. A new tab appears that renders an API specification document.
105105

106+
## Use language model tools
107+
108+
In the pre-release version of the Azure API Center extension, you can add language model tools from your API center to your Visual Studio Code environment to use in GitHub Copilot's agent mode. [earn more about tools in agent mode](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
109+
110+
These API Center tools can help you search for APIs and API versions, API definitions and specifications, authentication information and credentials, and deployments using natural language prompts.
111+
112+
To add language model tools to your Visual Studio Code environment:
113+
114+
1. Set the mode of your GitHub Copilot chat to **Agent**.
115+
1. Select the **Tools** icon in the chat window.
116+
117+
:::image type="content" source="media/discover-apis-vscode-extension/language-model-tools.png" alt-text="Screenshot of GitHub Copilot chat window in Visual Studio Code.":::
118+
119+
1. Select one or more API Center tools to be available in the chat.
120+
121+
:::image type="content" source="media/discover-apis-vscode-extension/api-center-tools.png" alt-text="Screenshot of selecting API Center tools in Visual Studio Code.":::
122+
123+
1.
124+
125+
126+
106127
## Related content
107128

108129
* [Azure API Center - key concepts](key-concepts.md)

articles/api-center/enable-api-center-portal-vs-code-extension.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Enable enterprise developers to view the enterprise's API Center po
44
author: dlepow
55
ms.service: azure-api-center
66
ms.topic: how-to
7-
ms.date: 03/20/2025
7+
ms.date: 05/27/2025
88
ms.author: danlep
99
ms.custom:
1010
# Customer intent: As an API program manager, I want to enable an API catalog so that app developers in my organization can discover and consume the APIs in my organization's API center without needing to manage the API inventory itself.
@@ -19,6 +19,8 @@ This article shows how to provide enterprise developers access to the Azure API
1919
2020
## Prerequisites
2121

22+
### For API center administrators
23+
2224
* An API center in your Azure subscription. If you haven't created one already, see [Quickstart: Create your API center](set-up-api-center.md).
2325

2426
* Permissions to create an app registration in a Microsoft Entra tenant associated with your Azure subscription, and permissions to grant access to data in your API center.
@@ -27,10 +29,13 @@ This article shows how to provide enterprise developers access to the Azure API
2729

2830
* [Azure API Center extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center)
2931

32+
> [!NOTE]
33+
> Where noted, certain features are available only in the Azure API Center extension's pre-release version. [!INCLUDE [vscode-extension-prerelease-features](vscode-extension-prerelease-features.md)]
3034
31-
The following Visual Studio Code extension is optional:
35+
The following Visual Studio Code extensions are optional:
3236

3337
* [Microsoft Kiota extension](https://marketplace.visualstudio.com/items?itemName=ms-graph.kiota) - to generate API clients
38+
* GitHub Copilot and GitHub Copilot Chat, provided with [access to GitHub Copilot](https://code.visualstudio.com/docs/copilot/setup) - to use language model tools in agent mode for discovering APIs
3439

3540
## Steps for API center administrators to enable access to API Center portal view
3641

@@ -48,12 +53,10 @@ Enterprise developers must sign in with a Microsoft account to see the API Cente
4853

4954
## Steps for enterprise developers to access the API Center portal view
5055

51-
Developers can follow these steps to connect and sign in to view an API Center portal view using the Visual Studio Code extension. Settings to connect to the API center need to be provided by the API center administrator.
56+
Developers can follow these steps to connect and sign in to an API Center portal view using the Visual Studio Code extension. Settings to connect to the API center need to be provided by the API center administrator. After connecting, developers can discover and consume the APIs in the API center.
5257

5358
### Connect to an API center
5459

55-
1. Install the pre-release version of the [Azure API Center extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center) for Visual Studio Code.
56-
5760
1. In Visual Studio Code, in the Activity Bar on the left, select API Center.
5861

5962
:::image type="content" source="media/enable-api-center-portal-vs-code-extension/api-center-activity-bar.png" alt-text="Screenshot of the API Center icon in the Activity Bar.":::
@@ -66,7 +69,7 @@ Developers can follow these steps to connect and sign in to view an API Center p
6669
1. The directory (tenant) ID from the app registration configured by the administrator in the previous section.
6770

6871
> [!TIP]
69-
> An API center administrator needs to provide these connection details to developers, or provide a direct link in the following format:
72+
> An API center administrator needs to provide the preceding connection details to developers, or provide a direct link in the following format:
7073
> `vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms`
7174
7275
After you connect to the API center, the name of the API center appears in the API Center portal view.
@@ -90,6 +93,33 @@ The API Center portal view helps enterprise developers discover API details and
9093
* **Generate Markdown** - Generate API documentation in Markdown format
9194
* **OpenAPI documentation** - View the documentation for an API definition and try operations in a Swagger UI (only available for OpenAPI definitions)
9295

96+
## Use language model tools
97+
98+
In the pre-release version of the Azure API Center extension, developers with access to the API Center portal view can add API Center language model tools to use in GitHub Copilot's agent mode. [Learn more about using tools in agent mode](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
99+
100+
The API Center tools can be used in agent mode to help search for APIs and API versions, API definitions and specifications, API authentication information and credentials, deployments, and more using natural language prompts.
101+
102+
To add and use API Center language mode tools in GitHub Copilot's agent mode:
103+
104+
1. [Connect to an API center](#create-microsoft-entra-app-registration) as described in a previous section.
105+
1. Open GitHub Copilot Chat in Visual Studio Code.
106+
1. Set the mode of GitHub Copilot Chat to **Agent**.
107+
1. Select the **Tools** icon in the chat window.
108+
109+
:::image type="content" source="media/enable-api-center-portal-vs-code-extension/language-model-tools.png" alt-text="Screenshot of GitHub Copilot chat window in Visual Studio Code.":::
110+
111+
1. Select one or more API Center tools to be available in the chat.
112+
113+
:::image type="content" source="media/enable-api-center-portal-vs-code-extension/api-center-tools.png" alt-text="Screenshot of selecting API Center tools in Visual Studio Code.":::
114+
115+
1. Enter a prompt in the chat window to use the available tools. For example:
116+
117+
```copilot-prompt
118+
Find potential MCP servers for a project I'm working on. I need the deployment URLs from my API center of any MCP servers that can run code snippets.
119+
```
120+
121+
1. Review the responses from GitHub Copilot Chat. Continue with the conversation to refine the results or ask follow-up questions.
122+
93123
94124
## Troubleshooting
95125
74.8 KB
Loading
14.1 KB
Loading

0 commit comments

Comments
 (0)