Skip to content

[Doc Improvement][Teams Toolkit renaming6][4449238] #12730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
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
14 changes: 7 additions & 7 deletions msteams-platform/toolkit/configure-bot-capability.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ To configure bot as an additional capability, ensure the following prerequisites

The following steps help you to add bot to a tab app:

* [Create bot app using Microsoft Teams Toolkit](#create-bot-app-using-microsoft-teams-toolkit)
* [Create bot app using Microsoft 365 Agents Toolkit](#create-bot-app-using-microsoft-teams-toolkit)
* [Configure bot capability in app manifest](#configure-bot-capability-in-app-manifest)
* [Add bot code to your project](#add-bot-code-to-your-project)
* [Setup local debug environment](#setup-local-debug-environment)
* [Provision the app to Azure](#provision-the-app-to-azure)

## Create bot app using Microsoft Teams Toolkit
## Create bot app using Microsoft 365 Agents Toolkit

To create a bot app using Teams Toolkit, see [create a bot app with Teams Toolkit](create-new-project.md).
To create a bot app using Microsoft 365 Agents Toolkit, see [create a bot app with Microsoft 365 Agents Toolkit](create-new-project.md).

## Configure bot capability in app manifest

Expand Down Expand Up @@ -460,13 +460,13 @@ You can add the bot capability to a message extension app easily as message exte

The following steps help you to add the bot capability to a message extension app:

* [Create bot app using Teams Toolkit](#create-bot-app-using-teams-toolkit)
* [Create bot app using Microsoft 365 Agents Toolkit](#create-bot-app-using-teams-toolkit)
* [Update manifest file](#update-manifest-file)
* [Add bot code to project](#add-bot-code-to-project)

## Create bot app using Teams Toolkit
## Create bot app using Microsoft 365 Agents Toolkit

To create a bot app with Teams Toolkit, see [create a new Teams bot app](create-new-project.md).
To create a bot app with Microsoft 365 Agents Toolkit, see [create a new Teams bot app](create-new-project.md).

## Update manifest file

Expand Down Expand Up @@ -510,7 +510,7 @@ The following code snippet is an example:

## Add bot code to project

1. Your message extension app contains a class that extends `TeamsActivityHandler`. Copy your configured bot code from the bot app into this class in Visual Studio Code. The following code is an example of a message extension that contains functions from a bot app created in Teams Toolkit:
1. Your message extension app contains a class that extends `TeamsActivityHandler`. Copy your configured bot code from the bot app into this class in Visual Studio Code. The following code is an example of a message extension that contains functions from a bot app created in Microsoft 365 Agents Toolkit:

```javascript
public class YourHandler extends TeamsActivityHandler{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ To configure the message extension capability in your app, ensure the following

To add a message extension to a tab app, follow these steps:

1. [Create message extension app using Microsoft Teams Toolkit](#create-message-extension-app-using-microsoft-teams-toolkit)
1. [Create message extension app using Microsoft 365 Agents Toolkit](#create-message-extension-app-using-microsoft-teams-toolkit)
1. [Configure message extension in app manifest](#configure-message-extension-in-app-manifest)
1. [Add message extension code to your project](#add-message-extension-code-to-your-project)
1. [Setup local debug environment](#setup-local-debug-environment)
1. [Provision your app to Azure](#provision-your-app-to-azure)

### Create message extension app using Microsoft Teams Toolkit
### Create message extension app using Microsoft 365 Agents Toolkit

To create a message extension app with Teams Toolkit, see [create a message extension app with Teams Toolkit](create-new-project.md).
To create a message extension app with Microsoft 365 Agents Toolkit, see [create a message extension app with Microsoft 365 Agents Toolkit](create-new-project.md).

### Configure message extension in app manifest

Expand Down Expand Up @@ -507,13 +507,13 @@ You can add the message extension capability to a bot app easily as message exte

To add a message extension to a bot app, follow these steps:

1. [Create a message extension app using Teams Toolkit](#create-a-message-extension-using-teams-toolkit)
1. [Create a message extension app using Microsoft 365 Agents Toolkit](#create-a-message-extension-using-teams-toolkit)
1. [Configure message extension in app manifest](#configure-message-extension-in-app-manifest)
1. [Add message extension code to project](#add-message-extension-code-to-project)

### Create a message extension using Teams Toolkit
### Create a message extension using Microsoft 365 Agents Toolkit

To create a message extension app, see [create a message extension app with Teams Toolkit](create-new-project.md).
To create a message extension app, see [create a message extension app with Microsoft 365 Agents Toolkit](create-new-project.md).

### Configure message extension in app manifest

Expand Down Expand Up @@ -607,7 +607,7 @@ The following code snippet is an example:

### Add message extension code to project

1. Your bot app contains a class that extends `TeamsActivityHandler`. Copy your message extension functions from the message extension app into this class in Visual Studio Code. The following code is an example of a bot that contains functions from a message extension app created in Teams Toolkit:
1. Your bot app contains a class that extends `TeamsActivityHandler`. Copy your message extension functions from the message extension app into this class in Visual Studio Code. The following code is an example of a bot that contains functions from a message extension app created in Microsoft 365 Agents Toolkit:

```javascript
class YourHandler extends TeamsActivityHandler {
Expand Down
10 changes: 5 additions & 5 deletions msteams-platform/toolkit/configure-tab-capability.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ms.date: 12/17/2024

Tabs are webpages embedded in Microsoft Teams. Tabs function as simple HTML `iframe` tags that point to domains declared in app manifest (previously called Teams app manifest). You can add tab as a capability to a Teams app in a channel within a team, group chat, or personal app for an individual user. You can include custom tabs with your app to embed your own web content in Teams or add Teams-specific functionality to your web content. For more information, see [build tabs for Teams](../tabs/what-are-tabs.md).

Before you start, we recommend that you create and go through a tab app. For more information, see [create tab app with Teams Toolkit](create-new-project.md).
Before you start, we recommend that you create and go through a tab app. For more information, see [create tab app with Microsoft 365 Agents Toolkit](create-new-project.md).

## Prerequisites

Expand All @@ -31,7 +31,7 @@ The following steps help you to configure the tab capability in a Teams app:
1. [Provision app to Azure](#provision-app-to-azure)

> [!TIP]
> If you develop a server-side tab app, you don't need to update the folder structure, debug profile, or bicep infrastructure. Add new routes to the tab in your bot service and update the app manifest in Teams Toolkit.
> If you develop a server-side tab app, you don't need to update the folder structure, debug profile, or bicep infrastructure. Add new routes to the tab in your bot service and update the app manifest in Microsoft 365 Agents Toolkit.
For more information, see [sample app](https://github.com/OfficeDev/TeamsFx-Samples/tree/main/hello-world-bot-with-tab).

### Update app manifest
Expand Down Expand Up @@ -63,11 +63,11 @@ For more information, see [sample app](https://github.com/OfficeDev/TeamsFx-Samp
```

> [!NOTE]
> `TAB_ENDPOINT` and `TAB_DOMAIN` are built-in variables of Teams Toolkit. They're replaced with the true endpoint during runtime based on your current environment.
> `TAB_ENDPOINT` and `TAB_DOMAIN` are built-in variables of Microsoft 365 Agents Toolkit. They're replaced with the true endpoint during runtime based on your current environment.

### Setup local debug environment

1. Bring your tab app code into your project in Visual Studio Code. If you don't have one, you can [create a new tab app with Teams Toolkit](create-new-project.md) and copy the source code into your current project. By default, your tab app's folder structure looks as follows:
1. Bring your tab app code into your project in Visual Studio Code. If you don't have one, you can [create a new tab app with Microsoft 365 Agents Toolkit](create-new-project.md) and copy the source code into your current project. By default, your tab app's folder structure looks as follows:

```
|-- appPackage/
Expand Down Expand Up @@ -167,7 +167,7 @@ For more information, see [sample app](https://github.com/OfficeDev/TeamsFx-Samp

For more information on how to configure the debug profile, see [sample app](https://github.com/OfficeDev/teams-toolkit-samples/tree/dev/hello-world-bot-with-tab/.vscode).

1. To enable your tab project to work with Teams Toolkit, add the following actions to the `teamsapp.local.yml` file:
1. To enable your tab project to work with Microsoft 365 Agents Toolkit, add the following actions to the `teamsapp.local.yml` file:

```yaml
provision:
Expand Down
18 changes: 9 additions & 9 deletions msteams-platform/toolkit/create-new-project.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Create New Teams App in Teams Toolkit
title: Create New Teams App in Microsoft 365 Agents Toolkit
author: zyxiaoyuer
description: Learn how to create basic and scenario-based Teams app in Visual Studio Code, its directory structure, and Teams app template available in Teams Toolkit.
description: Learn how to create basic and scenario-based Teams app in Visual Studio Code, its directory structure, and Teams app template available in Microsoft 365 Agents Toolkit.
ms.author: surbhigupta
ms.localizationpriority: high
ms.topic: overview
Expand All @@ -14,7 +14,7 @@ In this section, you can learn how to create a new Microsoft Teams project using

## Create a new Teams project using Visual Studio Code

You can build a new Teams project by selecting **Create a New App** in Microsoft Teams Toolkit. You can start from built-in Teams app templates or start from official Teams app samples in Teams Toolkit. What's more, Teams Toolkit supports to start with Outlook Add-in templates to build your own Outlook Add-ins.
You can build a new Teams project by selecting **Create a New App** in Microsoft 365 Agents Toolkit. You can start from built-in Teams app templates or start from official Teams app samples in Microsoft 365 Agents Toolkit. What's more, Microsoft 365 Agents Toolkit supports to start with Outlook Add-in templates to build your own Outlook Add-ins.

:::image type="content" source="../assets/images/teams-toolkit-v2/first-tab/select-capabilities-tabapp_1.png" alt-text="Screenshot shows the App Capability options.":::

Expand All @@ -34,9 +34,9 @@ To create a basic Teams app:

1. Open **Visual Studio Code**.

1. Select the **Teams Toolkit** > **Create a New App**.
1. Select the **Microsoft 365 Agents Toolkit** > **Create a New App**.

:::image type="content" source="../assets/images/teams-toolkit-v2/first-tab/create-project.png" alt-text="Screenshot shows the Create New Project button in the Teams Toolkit sidebar.":::
:::image type="content" source="../assets/images/teams-toolkit-v2/first-tab/create-project.png" alt-text="Screenshot shows the Create New Project button in the Microsoft 365 Agents Toolkit sidebar.":::

1. In this example, select **Tab** as app capability.

Expand Down Expand Up @@ -81,7 +81,7 @@ To create a basic Teams app:

### Directory structure for different app types

Teams Toolkit provides all components for building an app. After creating the project, you can view the project folders and files under **EXPLORER** section.
Microsoft 365 Agents Toolkit provides all components for building an app. After creating the project, you can view the project folders and files under **EXPLORER** section.

<br>
<details>
Expand All @@ -99,7 +99,7 @@ The following example shows a basic Teams tab app directory structure:
| `src/app.js` | Application entry point and `express` handlers for website. |
| `src/views/hello.html`| An HTML template that is bind to the tab endpoint. |
| `src/static` | The web server can serve static assets such as CSS and JavaScript files. |
| `teamsapp.yml` | This configuration file defines the Teams Toolkit behavior for provision, deploy, and publish lifecycle. You can customize this file to change the behavior of Teams Toolkit in each lifecycle. |
| `teamsapp.yml` | This configuration file defines the Microsoft 365 Agents Toolkit behavior for provision, deploy, and publish lifecycle. You can customize this file to change the behavior of Microsoft 365 Agents Toolkit in each lifecycle. |
| `teamsapp.local.yml` | This overrides teamsapp.yml with actions that enable local execution and debugging. |

> [!NOTE]
Expand Down Expand Up @@ -128,7 +128,7 @@ The new project folder contains the following content:
| `appPackage` | The app manifest file and icon files that Teams used to recognize your Teams app. |
| `env` | Stores different environment parameters. |
| `infra` | Azure `bicep` template files. Used for deploy your Teams app to Azure. |
| `teamsapp.yml` | This configuration file defines the Teams Toolkit behavior for provision, deploy, and publish lifecycle. You can customize this file to change the behavior of Teams Toolkit in each lifecycle. |
| `teamsapp.yml` | This configuration file defines the Microsoft 365 Agents Toolkit behavior for provision, deploy, and publish lifecycle. You can customize this file to change the behavior of Microsoft 365 Agents Toolkit in each lifecycle. |
| `teamsapp.local.yml` | This overrides teamsapp.yml with actions that enable local execution and debugging. |

The core notification implementation is stored in the **src** folder and it contains:
Expand Down Expand Up @@ -158,7 +158,7 @@ To learn more about the directory structure of different types of scenario-based

## See also

* [Teams Toolkit Overview](teams-toolkit-fundamentals.md)
* [Microsoft 365 Agents Toolkit Overview](teams-toolkit-fundamentals.md)
* [Build a Teams app with Blazor](../sbs-gs-blazorupdate.yml)
* [Build a Teams app with C# or .NET](../sbs-gs-csharp.yml)
* [Prerequisites for all types of environment and create your Teams app](tools-prerequisites.md)
Expand Down
22 changes: 11 additions & 11 deletions msteams-platform/toolkit/debug-apps-in-Teams-desktop-client.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Debug your apps in Teams Desktop Client
author: surbhigupta
description: Learn how to debug your bot, agent, custom engine agent, message extension apps in Teams desktop client using Teams Toolkit.
description: Learn how to debug your bot, agent, custom engine agent, message extension apps in Teams desktop client using Microsoft 365 Agents Toolkit.
ms.author: surbhigupta
ms.localizationpriority: high
ms.topic: overview
Expand All @@ -10,7 +10,7 @@ ms.date: 10/22/2024

# Debug in Teams desktop client

Microsoft Teams Toolkit helps you to debug and preview your Microsoft Teams app in desktop client. During the debug process, Teams Toolkit automatically starts app services, opens debuggers, and uploads Teams app. You can preview your Teams app in Teams desktop client after debugging.
Microsoft 365 Agents Toolkit helps you to debug and preview your Microsoft Teams app in desktop client. During the debug process, Microsoft 365 Agents Toolkit automatically starts app services, opens debuggers, and uploads Teams app. You can preview your Teams app in Teams desktop client after debugging.

The following are the advantages of Teams desktop client:

Expand All @@ -20,7 +20,7 @@ The following are the advantages of Teams desktop client:

## Capabilities of Teams desktop client

Teams desktop client incorporates debugging capabilities in the following app templates scaffolded by the Teams Toolkit:
Teams desktop client incorporates debugging capabilities in the following app templates scaffolded by the Microsoft 365 Agents Toolkit:

* Bot.
* Agent.
Expand All @@ -33,7 +33,7 @@ Ensure you install the following tools for building and deploying your app in Te

| &nbsp; | Install | For using... |
| --- | --- | --- |
| &nbsp; | [Teams Toolkit](install-Teams-Toolkit.md) | A Microsoft Visual Studio Code extension that creates a project scaffolding for your app. Use the latest prerelease version. |
| &nbsp; | [Microsoft 365 Agents Toolkit](install-Teams-Toolkit.md) | A Microsoft Visual Studio Code extension that creates a project scaffolding for your app. Use the latest prerelease version. |
| &nbsp; | [Node.js](https://nodejs.org/en/download) | Back-end JavaScript runtime environment. For more information, see [node.js version compatibility table for project type](~/toolkit/build-environments.md#nodejs-version-compatibility-table-for-project-type). |
| &nbsp; | [Visual Studio Code](https://code.visualstudio.com/download) | JavaScript, TypeScript, or SharePoint Framework (SPFx) build environments. Use the latest version. |
| &nbsp; | [Microsoft 365 developer account](../concepts/build-and-test/prepare-your-o365-tenant.md)| Access to Teams account with the appropriate permissions to install an app. |
Expand All @@ -42,15 +42,15 @@ Ensure you install the following tools for building and deploying your app in Te

**To debug your custom engine agent app in Teams desktop client**

1. Open Visual Studio Code (VS Code) and log into your Microsoft 365 account through Teams Toolkit.
1. Open Visual Studio Code (VS Code) and log into your Microsoft 365 account through Microsoft 365 Agents Toolkit.

1. Select the Teams Toolkit :::image type="icon" source="../assets/images/teams-toolkit-v2/teams-toolkit-sidebar-icon.PNG" border="false"::: icon in the VS Code **Activity Bar** and then select **Create a New App**.
1. Select the Microsoft 365 Agents Toolkit :::image type="icon" source="../assets/images/teams-toolkit-v2/teams-toolkit-sidebar-icon.PNG" border="false"::: icon in the VS Code **Activity Bar** and then select **Create a New App**.

:::image type="content" source="../assets/images/teams-toolkit-v2/debug-apps-in-teams-desktop-client/create-project.png" alt-text="Screenshot shows the location of the Create New Project link in the Teams Toolkit sidebar.":::
:::image type="content" source="../assets/images/teams-toolkit-v2/debug-apps-in-teams-desktop-client/create-project.png" alt-text="Screenshot shows the location of the Create New Project link in the Microsoft 365 Agents Toolkit sidebar.":::

1. Select **Custom Engine Agent**.

:::image type="content" source="../assets/images/teams-toolkit-v2/debug-apps-in-teams-desktop-client/custom-engine-copilot.png" alt-text="Screenshot shows the Teams Toolkit app templates.":::
:::image type="content" source="../assets/images/teams-toolkit-v2/debug-apps-in-teams-desktop-client/custom-engine-copilot.png" alt-text="Screenshot shows the Microsoft 365 Agents Toolkit app templates.":::

1. Select **Basic AI Chatbot**.

Expand Down Expand Up @@ -91,7 +91,7 @@ Ensure you install the following tools for building and deploying your app in Te

:::image type="content" source="../assets/images/teams-toolkit-v2/debug-apps-in-teams-desktop-client/debug-in-teams-desktop.png" alt-text="Screenshot shows the option to select debug in Teams (Desktop).":::

1. Ensure your Teams desktop login matches your Microsoft 365 account used in Teams Toolkit and then select **Continue**.
1. Ensure your Teams desktop login matches your Microsoft 365 account used in Microsoft 365 Agents Toolkit and then select **Continue**.

:::image type="content" source="../assets/images/teams-toolkit-v2/debug-apps-in-teams-desktop-client/desktop-login-matches.png" alt-text="Screenshot shows the desktop login.":::

Expand All @@ -109,7 +109,7 @@ Ensure you install the following tools for building and deploying your app in Te

> [!NOTE]
>
> The system level notification for account matching appears only once per project. In subsequent debug sessions, Teams Toolkit sends reminders about the account through VS Code notifications.
> The system level notification for account matching appears only once per project. In subsequent debug sessions, Microsoft 365 Agents Toolkit sends reminders about the account through VS Code notifications.
>
> :::image type="content" source="../assets/images/teams-toolkit-v2/debug-apps-in-teams-desktop-client/subsequent-desktop-login.png" alt-text="Screenshot shows the subsequent desktop login notification in vs code.":::

Expand All @@ -123,5 +123,5 @@ You can continue to debug your custom engine agent app in Teams desktop client.

## See also

* [Teams Toolkit Overview](teams-toolkit-fundamentals.md)
* [Microsoft 365 Agents Toolkit Overview](teams-toolkit-fundamentals.md)
* [Debug for mobile](debug-mobile.md)
Loading