diff --git a/msteams-platform/assets/images/toolkit-v2/debug/add-a-user-request.png b/msteams-platform/assets/images/toolkit-v2/debug/add-a-user-request.png index d847924b0f0..ca98d96c343 100644 Binary files a/msteams-platform/assets/images/toolkit-v2/debug/add-a-user-request.png and b/msteams-platform/assets/images/toolkit-v2/debug/add-a-user-request.png differ diff --git a/msteams-platform/assets/images/toolkit-v2/debug/add-a-user-response.png b/msteams-platform/assets/images/toolkit-v2/debug/add-a-user-response.png index 9372ba26af2..b50dffbda6d 100644 Binary files a/msteams-platform/assets/images/toolkit-v2/debug/add-a-user-response.png and b/msteams-platform/assets/images/toolkit-v2/debug/add-a-user-response.png differ diff --git a/msteams-platform/assets/images/toolkit-v2/debug/add-user.png b/msteams-platform/assets/images/toolkit-v2/debug/add-user.png index 1bc234d6fb1..193a175307d 100644 Binary files a/msteams-platform/assets/images/toolkit-v2/debug/add-user.png and b/msteams-platform/assets/images/toolkit-v2/debug/add-user.png differ diff --git a/msteams-platform/assets/images/toolkit-v2/debug/authentication-enabled.png b/msteams-platform/assets/images/toolkit-v2/debug/authentication-enabled.png new file mode 100644 index 00000000000..01719fba225 Binary files /dev/null and b/msteams-platform/assets/images/toolkit-v2/debug/authentication-enabled.png differ diff --git a/msteams-platform/assets/images/toolkit-v2/debug/authentication-form.png b/msteams-platform/assets/images/toolkit-v2/debug/authentication-form.png new file mode 100644 index 00000000000..feca08d8064 Binary files /dev/null and b/msteams-platform/assets/images/toolkit-v2/debug/authentication-form.png differ diff --git a/msteams-platform/assets/images/toolkit-v2/debug/configure-authentication.png b/msteams-platform/assets/images/toolkit-v2/debug/configure-authentication.png new file mode 100644 index 00000000000..e10e716a563 Binary files /dev/null and b/msteams-platform/assets/images/toolkit-v2/debug/configure-authentication.png differ diff --git a/msteams-platform/assets/images/toolkit-v2/debug/custom-activity-request.png b/msteams-platform/assets/images/toolkit-v2/debug/custom-activity-request.png index ddbd586d3bb..35c9d6cc757 100644 Binary files a/msteams-platform/assets/images/toolkit-v2/debug/custom-activity-request.png and b/msteams-platform/assets/images/toolkit-v2/debug/custom-activity-request.png differ diff --git a/msteams-platform/assets/images/toolkit-v2/debug/custom-activity-response.png b/msteams-platform/assets/images/toolkit-v2/debug/custom-activity-response.png index 67d0e51a0d5..162ea691339 100644 Binary files a/msteams-platform/assets/images/toolkit-v2/debug/custom-activity-response.png and b/msteams-platform/assets/images/toolkit-v2/debug/custom-activity-response.png differ diff --git a/msteams-platform/assets/images/toolkit-v2/debug/mock-activity.png b/msteams-platform/assets/images/toolkit-v2/debug/mock-activity.png index 5b3e6e4c7b0..721c9577933 100644 Binary files a/msteams-platform/assets/images/toolkit-v2/debug/mock-activity.png and b/msteams-platform/assets/images/toolkit-v2/debug/mock-activity.png differ diff --git a/msteams-platform/assets/images/toolkit-v2/debug/sample-app-output.png b/msteams-platform/assets/images/toolkit-v2/debug/sample-app-output.png index f24e9be5293..b1a7c027531 100644 Binary files a/msteams-platform/assets/images/toolkit-v2/debug/sample-app-output.png and b/msteams-platform/assets/images/toolkit-v2/debug/sample-app-output.png differ diff --git a/msteams-platform/assets/images/toolkit-v2/debug/select-debug-in-test-tool.png b/msteams-platform/assets/images/toolkit-v2/debug/select-debug-in-test-tool.png index 9b1a8c82e53..67132557572 100644 Binary files a/msteams-platform/assets/images/toolkit-v2/debug/select-debug-in-test-tool.png and b/msteams-platform/assets/images/toolkit-v2/debug/select-debug-in-test-tool.png differ diff --git a/msteams-platform/assets/images/toolkit-v2/debug/test-tool.png b/msteams-platform/assets/images/toolkit-v2/debug/test-tool.png index 0820a7546b0..bb2aef60091 100644 Binary files a/msteams-platform/assets/images/toolkit-v2/debug/test-tool.png and b/msteams-platform/assets/images/toolkit-v2/debug/test-tool.png differ diff --git a/msteams-platform/assets/images/toolkit-v2/debug/webchat-ui.png b/msteams-platform/assets/images/toolkit-v2/debug/webchat-ui.png new file mode 100644 index 00000000000..58264659e02 Binary files /dev/null and b/msteams-platform/assets/images/toolkit-v2/debug/webchat-ui.png differ diff --git a/msteams-platform/assets/images/toolkit-v2/first-bot/azure-openai.png b/msteams-platform/assets/images/toolkit-v2/first-bot/azure-openai.png new file mode 100644 index 00000000000..34b680872e9 Binary files /dev/null and b/msteams-platform/assets/images/toolkit-v2/first-bot/azure-openai.png differ diff --git a/msteams-platform/assets/images/toolkit-v2/first-bot/create-new-app1.png b/msteams-platform/assets/images/toolkit-v2/first-bot/create-new-app1.png index 07a897fd386..5454d1c39ea 100644 Binary files a/msteams-platform/assets/images/toolkit-v2/first-bot/create-new-app1.png and b/msteams-platform/assets/images/toolkit-v2/first-bot/create-new-app1.png differ diff --git a/msteams-platform/toolkit/debug-your-agents-playground.md b/msteams-platform/toolkit/debug-your-agents-playground.md index ce8b2bffb52..bc219e1a38c 100644 --- a/msteams-platform/toolkit/debug-your-agents-playground.md +++ b/msteams-platform/toolkit/debug-your-agents-playground.md @@ -1,7 +1,7 @@ --- title: Debug bot using Agents Playground author: surbhigupta -description: Learn about Microsoft 365 Agents Playground in Teams Toolkit and debug existing app, advantages, activity triggers, and customize Teams context. +description: Learn about Microsoft 365 Agents Playground in Microsoft 365 Agents Toolkit and debug existing app, advantages, activity triggers, and customize Teams context. ms.author: surbhigupta ms.localizationpriority: high ms.topic: overview @@ -14,7 +14,7 @@ ms.date: 11/16/2023 > > Microsoft 365 Agents Playground (previously known as Teams App Test Tool) is available in the latest prerelease version of Microsoft 365 Agents Toolkit (previously known as Teams Toolkit). Ensure that you install the [latest prerelease version](install-Teams-Toolkit.md#install-a-prerelease-version) of Agents Toolkit. -Agents Playground makes debugging bot-based apps effortless. You can chat with your bot and see its messages and Adaptive Cards as they appear in Microsoft Teams. You don’t need a Microsoft 365 developer account, tunneling, or Teams app and bot registration to use Agents Playground. +Agents Playground makes debugging bot/agent-based apps effortless. You can chat with your bot and see its messages and Adaptive Cards as they appear in different channels. You don’t need a Microsoft 365 developer account, tunneling, or real client app and application registration to use Agents Playground. The following image shows a sample app displaying an Adaptive Card with a list of commands in Agents Playground. It also provides a description of the commands so that you can test your app without manually searching your code: @@ -22,25 +22,25 @@ The following image shows a sample app displaying an Adaptive Card with a list o The following are the advantages of Agents Playground: -* **Sandbox environment**: The sandbox environment of Agents Playground emulates the behavior, look, and user experience of Teams. +* **Sandbox environment**: The sandbox environment of Agents Playground emulates the behavior, look, and user experience of the real one. * **Tunneling**: An external tunnel service isn't necessary as Agents Playground runs on a local server that your bot can communicate with. -* **Reduce account dependencies**: Microsoft 365 Developer tenant and the app uploading permissions aren't necessary to debug the bot. +* **Reduce account dependencies**: Microsoft 365 Developer tenant and the app uploading permissions aren't necessary to debug the application. -* **Rapid inner-loop iterations**: Optimizes the process of making changes to the app design and bot logic without having to redeploy the bot to the cloud. +* **Rapid inner-loop iterations**: Optimizes the process of making changes to the app design and application logic without having to redeploy the application to the cloud. * **Mock data and activities**: Agents Playground makes it easy to test complex scenarios such as, sending a welcome message when a new member joins the channel, using mock data and activity triggers. -* **Reliable**: Agents Playground is reliable as the bot's Adaptive Card utilizes the same rendering technology as in Teams. +* **Reliable**: Agents Playground is reliable as the application's Adaptive Card utilizes the same rendering technology as in Teams/WebChat. -* **Integration with existing Teams bot applications**: Agents Playground integrates effortlessly with existing Teams bot applications built with Bot Framework SDK. +* **Integration with existing applications**: Agents Playground integrates effortlessly with existing applications built with Agent SDK/Teams AI library. * **Support for different scopes**: Agents Playground supports testing in personal, team, and group chat scopes. ## Prerequisites -Ensure you install the following tools for building and deploying your bots in Agents Playground: +Ensure you install the following tools for building and deploying your applications in Agents Playground: |   | Install | For using... | | --- | --- | --- | @@ -50,16 +50,16 @@ Ensure you install the following tools for building and deploying your bots in A ## Understand Agents Playground -Agents Playground is an npm package that has a CLI command called `teamsapptester`. When you run `teamsapptester start`, it opens a web app on your local machine that emulates the Teams web client and Bot Framework service. This web app doesn't need any cloud resources as it uses mock data to simulate the contextual information of Teams. +Agents Playground is an npm package that has a CLI command called `teamsapptester`. When you run `teamsapptester start`, it opens a web app on your local machine that emulates the Teams/WebChat client and Bot Framework service. This web app doesn't need any cloud resources as it uses mock data to simulate the contextual information. -To use a Teams bot on Agents Playground, you need to provide: +To use an application on Agents Playground, you need to provide: -* Message endpoint: A bot message endpoint is the URL that links Agents Playground and your bot. You can update the endpoint with the `BOT_ENDPOINT` environment variable or use the default value of `http://localhost:3978/api/messages`. +* Message endpoint: A message endpoint is the URL that links Agents Playground and your application. You can update the endpoint with the `BOT_ENDPOINT` environment variable, start Agents Playground with option `--app-endpoint`, or just use the default value of `http://localhost:3978/api/messages`. * Configuration file (Optional): A configuration file informs Agents Playground about your customized contextual information in Teams. The file is named **.m365agentsplayground.yml** in the project's root folder. If Teams can't find this file, it uses the default configuration. For more information, see [customize Teams context](#customize-teams-context). ## Agents Playground experience in Agents Toolkit -Agents Playground offers a faster debug experience for bot applications when compared to the Teams client. +Agents Playground offers a faster debug experience for applications when compared to the real environment. # [Visual Studio Code](#tab/vscode) @@ -73,12 +73,16 @@ Agents Playground offers a faster debug experience for bot applications when com 1. Select **Agent for Teams**. - :::image type="content" source="../assets/images/toolkit-v2/first-bot/create-new-app1.png" alt-text="Screenshot shows the Teams Toolkit app templates."::: + :::image type="content" source="../assets/images/toolkit-v2/first-bot/create-new-app1.png" alt-text="Screenshot shows the agents toolkit app templates."::: -1. Select **Basic Agent for Teams**. If you need a different functionality for your bot, pick a different option. +1. Select **Basic Agent for Teams**. If you need a different functionality for your agent, pick a different option. :::image type="content" source="../assets/images/toolkit-v2/debug/ai-chat-bot.png" alt-text="Screenshot shows the app feature to add to your new app."::: +1. Select **Azure OpenAI** and enter service key. If you are using OpenAI, pick a different option. + + :::image type="content" source="../assets/images/toolkit-v2/first-bot/azure-openai.png" alt-text="Screenshot shows the options to configure LLM service."::: + 1. Select **JavaScript**. :::image type="content" source="../assets/images/toolkit-v2/first-bot/select-language-tab.png" alt-text="Screenshot shows the option to select the programming language."::: @@ -110,9 +114,9 @@ Agents Playground offers a faster debug experience for bot applications when com :::image type="content" source="../assets/images/toolkit-v2/debug/select-debug-in-test-tool.png" alt-text="Screenshot shows the option to select debug in Agents Playground."::: -1. Agents Playground opens the bot in a webpage. +1. Agents Playground opens the application in a webpage. - :::image type="content" source="../assets/images/toolkit-v2/debug/test-tool.png" lightbox="../assets/images/toolkit-v2/debug/test-tool.png" alt-text="Screenshot shows the bot open in Agents Playground."::: + :::image type="content" source="../assets/images/toolkit-v2/debug/test-tool.png" lightbox="../assets/images/toolkit-v2/debug/test-tool.png" alt-text="Screenshot shows the app open in agents playground."::: > [!div class="nextstepaction"] > [I ran into an issue](https://github.com/MicrosoftDocs/msteams-docs/issues/new?template=Doc-Feedback.yaml&title=%5BI%20ran%20into%20an%20issue%5D%20Test%20Tool%20experience%20in%20Agents%20Toolkit%20in%20Visual%20Studio%20Code&pageUrl=https%3A%2F%2Flearn.microsoft.com%2Fen-us%2Fmicrosoftteams%2Fplatform%2Ftoolkit%2Fdebug-your-teams-app-test-tool%3Ftabs%3Dvscode%252Cclijs%23test-tool-experience-in-agents-toolkit&contentSourceUrl=https%3A%2F%2Fgithub.com%2FMicrosoftDocs%2Fmsteams-docs%2Fblob%2Fmain%2Fmsteams-platform%2Ftoolkit%2Fdebug-your-Teams-app-test-tool.md&documentVersionIndependentId=6fa9130b-1aa5-b068-4211-a5a4cc32effa&author=surbhigupta&metadata=*%2BID%253A%2Be473e1f3-69f5-bcfa-bcab-54b098b59c80%2B%250A*%2BService%253A%2B**msteams**) @@ -149,7 +153,7 @@ Agents Playground offers a faster debug experience for bot applications when com :::image type="content" source="../assets/images/toolkit-v2/debug/teamsapp-deploy-env-testtool.png" alt-text="Screenshot shows the process of installing the required dependencies and npm packages."::: - 1. Run the following command to start your bot app: + 1. Run the following command to start your app: ```cmd npm run dev:atk:playground @@ -163,7 +167,7 @@ Agents Playground offers a faster debug experience for bot applications when com # [C#](#tab/clicsharp) - 1. [Create a new Teams app](toolkit-v4/create-new-project-vs.md). + 1. [Create a new app](toolkit-v4/create-new-project-vs.md). 1. Download Agents Playground CLI from the [GitHub](https://github.com/OfficeDev/TeamsFx/releases?q=teams-app-test-tool&expanded=true) release. @@ -176,7 +180,7 @@ Agents Playground offers a faster debug experience for bot applications when com 1. Run the following command to launch profile: ```cmd - dotnet run --launch-profile "Agents Playground (browser)" + dotnet run --launch-profile "Microsoft 365 Agents Playground (browser)" ``` 1. Run the following command in a separate terminal to define your bot message endpoint: @@ -209,7 +213,7 @@ Agents Playground offers a faster debug experience for bot applications when com If the Agents Playground for C# doesn't initiate because of a port conflict, alter the Agents Playground's port number in the `TEAMSAPPTESTER_PORT` environment variable where you run `teamsapptester.exe start`. --- - 1. Agents Playground opens the bot in a webpage. + 1. Agents Playground opens the app in a webpage. :::image type="content" source="../assets/images/toolkit-v2/debug/test-tool.png" lightbox="../assets/images/toolkit-v2/debug/test-tool.png" alt-text="Screenshot shows the bot open in Agents Playground." @@ -227,13 +231,13 @@ You can mock an activity in Agents Playground using activity triggers. There are ### Predefined activity triggers -Agents Playground provides predefined activity triggers to test the functionalities of your bot. +Agents Playground provides predefined activity triggers to test the functionalities of your app. | Category | Activity | Handler | | --- | --- | --- | -| Trigger Installation Update Activity | Install bot


Uninstall bot | `onInstallationUpdate`
`onInstallationUpdateAdded`

`onInstallationUpdate`
`onInstallationUpdateRemove`| -| Trigger Conversation Update Activity | Add user

Add bot

Add channel | `onMembersAdded`

`onTeamsMembersAddedEvent`

`onTeamsChannelRenamedEvent` | -| | Remove user


Remove bot


Remove channel

Remove team | `onMembersRemoved`
`onTeamsMembersRemovedEvent`

`onMembersRemoved`
`onTeamsMembersRemovedEvent`

`onTeamsChannelDeletedEvent`

`onTeamsTeamDeletedEvent` | +| Trigger Installation Update Activity | Install application


Uninstall application | `onInstallationUpdate`
`onInstallationUpdateAdded`

`onInstallationUpdate`
`onInstallationUpdateRemove`| +| Trigger Conversation Update Activity | Add user

Add application

Add channel | `onMembersAdded`

`onTeamsMembersAddedEvent`

`onTeamsChannelRenamedEvent` | +| | Remove user


Remove application


Remove channel

Remove team | `onMembersRemoved`
`onTeamsMembersRemovedEvent`

`onMembersRemoved`
`onTeamsMembersRemovedEvent`

`onTeamsChannelDeletedEvent`

`onTeamsTeamDeletedEvent` | | | Rename channel

Rename team | `onTeamsChannelRenamedEvent`

`onTeamsTeamRenamedEvent` | > [!NOTE] @@ -253,7 +257,7 @@ To mock an **Add user** activity, follow these steps: :::image type="content" source="../assets/images/toolkit-v2/debug/add-a-user-request.png" alt-text="Screenshot shows the option to send activity for predefined mock activity add user."::: - Bot sends a response. + App sends a response. :::image type="content" source="../assets/images/toolkit-v2/debug/add-a-user-response.png" alt-text="Screenshot shows the response of predefined mock activity add user."::: @@ -287,9 +291,48 @@ You can use **Custom activity** to customize activity triggers such as, `reactio :::image type="content" source="../assets/images/toolkit-v2/debug/custom-activity-response.png" alt-text="Screenshot shows the response of custom mock activity."::: +## Configure Agents Playground for authentication + +When debugging an application that requires authentication, you can configure the Microsoft Entra client ID and client secret, with an optional tenant ID. If you created your bot using the Azure AI Bot Service, the credentials are available in the bot's App Service under **Settings** > **Configuration**. +If you're unsure of the values, you can remove them from the configuration file of the locally running application and then run the application in the Agents Playground. If the application doesn't require these settings to run, you don't need to configure them. + +### Environment variable / Command line + +Before starting Agents Playground, you can set the following environment variables: `AUTH_CLIENT_ID`, `AUTH_CLIENT_SECRET`, and `AUTH_TENANT_ID`. These values will be used for the default authentication configuration. + +When running Agents Playground from the command line, you can also use the options: `--client-id`, `--client-secret`, and `--tenant-id`.These options override the default environment variable settings. + +### Client side interface + +After Agents Playground has started, you can still configure authentication through the client interface as follows: + +1. Select **Configure Authentication**. + + :::image type="content" source="../assets/images/toolkit-v2/debug/configure-authentication.png" alt-text="Screenshot shows the option to configure authentication on agents playground menu bar."::: + +1. Fill in fields in the form and select **Save**. + + :::image type="content" source="../assets/images/toolkit-v2/debug/authentication-form.png" alt-text="Screenshot shows the form of authentication parameters and the save button."::: + +The log panel will show message if the configuration is successfully set. + +:::image type="content" source="../assets/images/toolkit-v2/debug/authentication-enabled.png" alt-text="Screenshot shows the log panel message of successfully configure authentication settings."::: + +### Authentication logic + +Agents Playground will acquire a JWT token using the provided authentication settings and include it in the **Authorization** header when communicating with the application. The JWT token in the application's response header will also be validated by Agents Playground. For more details about the authentication process, see [Authentication with the Bot Connector API](/azure/bot-service/rest-api/bot-framework-rest-connector-authentication). + +## Multiple channel support + +Teams is the default channel used for debugging your application, but other channels are also supported. You can change the channel by setting the `DEFAULT_CHANNEL_ID` environment variable or by using the `--channel-id` option when starting Agents Playground from the command line. + +Currently, the accepted channel IDs are: `msteams`, `directline`, `webchat`, and `emulator`. When you set a channel ID, the properties of the messages sent to the application will change accordingly to simulate a real environment. For the `directline` and `webchat` channels, a corresponding client will be displayed, and card rendering will differ from that of the Teams channel. + +:::image type="content" source="../assets/images/toolkit-v2/debug/webchat-ui.png" alt-text="Screenshot shows the card rendering result when using different channel."::: + ## Customize Teams context -The configuration file in the project's root folder allows you to customize Teams context information such as chats, teams, and users. The file provides mock data for testing Bot Framework APIs or Bot Builder SDK methods such as `TeamsInfo.getTeamMembers`. +The configuration file in the project's root folder allows you to customize Teams context information such as chats, teams, and users. It provides mock data for testing Bot Framework APIs or methods from the Agent SDK or Teams AI Library, such as `TeamsInfo.getTeamMembers`. ### Default configuration @@ -369,9 +412,9 @@ team: ### Update the configuration file -If your bot code uses Bot Framework APIs, you can modify the configuration file to alter the API response. Let us consider an Azure DevOps notification bot installed in a team that fetches inactive bugs from Azure DevOps. It identifies the owners of the inactive bug, fetches their email addresses, and sends notifications to their personal chats on a daily basis. +If your bot code uses Bot Framework APIs, you can modify the configuration file to customize the API responses. For example, consider an Azure DevOps notification bot installed in a team that fetches inactive bugs from Azure DevOps. It identifies the owners of the inactive bugs, retrieves their email addresses, and sends daily notifications to their personal chats. -To comprehensively test this bot in Agents Playground, it's crucial to update the configuration file to use the correct email addresses of the owners of the inactive bugs. +To comprehensively test this bot in Agents Playground, ensure to update the configuration file with the correct email addresses of the inactive bug owners. 1. Go to the `.m365agentsplayground.yml` file in the project's root folder. @@ -393,15 +436,15 @@ To comprehensively test this bot in Agents Playground, it's crucial to update th > [!NOTE] > When you edit the configuration file in Visual Studio Code, Intellisense automatically updates the property names and warns you if you enter invalid values. -It's vital to recognize that updating the configuration file has three major impacts: +It's important to understand that updating the configuration file has three major impacts: -* It influences the responses obtained from Bot Framework Connector APIs, for example, `TeamsInfo.getPagedMembers()`. -* It shapes the details in the activity payload, for example, `activity.recipient`. -* It impacts the user interface in Agents Playground, for example, group chat names. +* It affects the responses returned by Bot Framework Connector APIs. For example, `TeamsInfo.getPagedMembers()`. +* It modifies the details in the activity payload. For example, `activity.recipient`. +* It influences the user interface in Agents Playground. For example, group chat names. ## Limitations -* Bot features enabled through the Teams app manifest aren't available as Agents Playground doesn't process it. +* Bot/agent features enabled through the Teams app manifest aren't available as Agents Playground doesn't process it. * Agents Playground doesn't support all types of cards except Adaptive Cards. @@ -419,7 +462,7 @@ It's vital to recognize that updating the configuration file has three major imp * Agents Playground can emulate the following experiences: - | Features | Debug in Agents Playground | [Debug your Teams app locally](debug-local.md) | + | Features | Debug in Agents Playground | [Debug your app locally](debug-local.md) | | --- | --- | --- | | Basic sending / receiving messages | Available | Available | | Bot Framework APIs (TeamsInfo.getPagedMembers()...) |Available (respond with mocked data) | Available | @@ -429,7 +472,7 @@ It's vital to recognize that updating the configuration file has three major imp ## Debug an existing app with Agents Playground -Ensure you have an existing bot created using Agents Toolkit. To debug your bot with Agents Playground, follow these steps: +Ensure you have an existing app created using Agents Toolkit. To debug your app with Agents Playground, follow these steps: 1. Open the existing bot's project folder in Agents Toolkit. @@ -444,11 +487,11 @@ Ensure you have an existing bot created using Agents Toolkit. To debug your bot "compounds": [ ... { - "name": "Debug in Test Tool", + "name": "Debug in Microsoft 365 Agents Playground", "configurations": [ "Attach to Local Service" ], - "preLaunchTask": "Start Teams App (Test Tool)", + "preLaunchTask": "Start App in Microsoft 365 Agents Playground", "presentation": { "group": "1-local", "order": 1 @@ -463,7 +506,7 @@ Ensure you have an existing bot created using Agents Toolkit. To debug your bot ```json { - "label": "Start Test Tool", + "label": "Start Microsoft 365 Agents Playground", "type": "shell", "command": "npm run dev:teamsfx:launch-playground", "isBackground": true, @@ -548,24 +591,28 @@ Ensure you have an existing bot created using Agents Toolkit. To debug your bot 1. From the left pane, select **Run and Debug** (`Ctrl+Shift+D`) and select **Debug in Microsoft 365 Agents Playground** in dropdown list. - :::image type="content" source="../assets/images/toolkit-v2/debug/select-debug-in-test-tool.png" alt-text="Screenshot shows the option to select debug in Agents Playground."::: + :::image type="content" source="../assets/images/toolkit-v2/debug/select-debug-in-test-tool.png" alt-text="Screenshot shows the option to select debug in Microsoft 365 Agents Playground."::: Agents Playground successfully debugs your existing bot. > [!div class="nextstepaction"] > [I ran into an issue](https://github.com/MicrosoftDocs/msteams-docs/issues/new?template=Doc-Feedback.yaml&title=%5BI%20ran%20into%20an%20issue%5D%20Debug%20an%20existing%20app%20with%20Test%20Tool&pageUrl=https%3A%2F%2Flearn.microsoft.com%2Fen-us%2Fmicrosoftteams%2Fplatform%2Ftoolkit%2Fdebug-your-teams-app-test-tool%3Ftabs%3Dvscode%252Cclijs%23debug-an-existing-app-with-test-tool&contentSourceUrl=https%3A%2F%2Fgithub.com%2FMicrosoftDocs%2Fmsteams-docs%2Fblob%2Fmain%2Fmsteams-platform%2Ftoolkit%2Fdebug-your-agents-playground.md&documentVersionIndependentId=6fa9130b-1aa5-b068-4211-a5a4cc32effa&author=surbhigupta&metadata=*%2BID%253A%2Be473e1f3-69f5-bcfa-bcab-54b098b59c80%2B%250A*%2BService%253A%2B**msteams**) +## Disabling data collection + +If you decide that you do not want to allow Agents Playground to collect usage data, you can easily disable data collection by adding option `--disable-telemetry` when start Agents Playground via command line. + ## FAQ
-How can I test my bot if Agents Playground doesn't support its features? +How can I test my app if Agents Playground doesn't support its features? You can always use the Teams client to test the features that Agents Playground doesn't support. Select the option **Debug in Teams (Edge)** or **Debug in Teams (Chrome)** to test your application in the Teams client.
 
-How would I know if Agents Playground doesn't support features in my bot? +How would I know if Agents Playground doesn't support features in my app? Agents Playground shows a warning message in conversation and log panel when it detects unsupported features. @@ -574,9 +621,9 @@ Agents Playground shows a warning message in conversation and log panel when it  
-Does Microsoft recommend using only Agents Playground for testing bot applications? +Does Microsoft recommend using only Agents Playground for testing applications? -No. We always recommend users to test their bot application in the Teams client before moving the application to the production environment. +No. We always recommend users to test their applications in the Teams client before moving the application to the production environment.
 
@@ -585,7 +632,7 @@ No. We always recommend users to test their bot application in the Teams client |Sample name | Description | Node.js | |----------------|-----------------|--------------| -| Agents Playground Sample App | A sample bot app to explore Agents Playground. | [View](https://github.com/OfficeDev/TeamsFx-Samples/tree/v3/test-tool-sample-app) | +| Agents Playground Sample App | A sample app to explore Agents Playground. | [View](https://github.com/OfficeDev/TeamsFx-Samples/tree/v3/test-tool-sample-app) | ## Step-by-step guide @@ -596,5 +643,6 @@ Follow the [step-by-step guide](../sbs-teams-app-test-tool.yml) to debug an AI c * [Microsoft 365 Agents Toolkit Overview](agents-toolkit-fundamentals.md) * [Install Microsoft 365 Agents Toolkit](install-Teams-Toolkit.md) * [Build bots for Teams](../bots/what-are-bots.md) +* [Teams AI library](../bots/how-to/teams-conversational-ai/teams-conversation-ai-overview.md) * [Adaptive Card](../task-modules-and-cards/cards/cards-reference.md#adaptive-card) -* [Bot Framework SDK](https://dev.botframework.com/) +* [Agents SDK](https://microsoft.github.io/Agents/)