Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions msteams-platform/toolkit/debug-your-agents-playground.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Debug bot using Agents Playground
author: surbhigupta
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
ms.date: 11/16/2023
Expand Down Expand Up @@ -338,7 +337,10 @@ The configuration file in the project's root folder allows you to customize Team

### Default configuration

<details><summary>Agents Playground contains a built-in configuration file in the project's root folder.</summary>
Agents Playground contains a built-in configuration file in the project's root folder.

> [!NOTE]
> By default, the Agents Playground uses built-in mock data. You don’t need to create or modify any configuration files unless you want to customize the mock data used during local debugging.

```yaml
# yaml-language-server: $schema=https://aka.ms/teams-app-test-tool-config/0.1.0/config.schema.json
Expand Down Expand Up @@ -410,15 +412,15 @@ team:
name: Announcements
```

</details>

### Update the configuration file
### Customize the configuration file

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, 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.
1. Create a file named `.m365agentsplayground.yml` in the project's root folder.

1. Copy the default mock data configuration and paste it into the `.m365agentsplayground.yml` file.

1. Go to the `users` section and update the `name`, `userPrincipleName`, and `email` of the required user.

Expand All @@ -436,7 +438,14 @@ To comprehensively test this bot in Agents Playground, ensure to update the conf
1. Save the file and select **F5** to debug in Agents Playground.

> [!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.
>
> * The Agents Playground uses two different configuration files:
> * `m365agents.playground.yml` is generated by Microsoft 365 Agents Toolkit and controls how the playground starts. This file doesn’t include mock user data.
> * `.m365agentsplayground.yml` is an optional file that you can create to customize built-in mock data, such as users.
>
> * The Agents Playground requires exactly five users in the `users` section. Configurations with fewer or more than five users aren’t supported.
>
> * 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 important to understand that updating the configuration file has three major impacts:

Expand Down