@microsoft/teamsfx-core 3.0.7-rc.0 → 3.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/common/samples.d.ts +1 -1
- package/build/common/samples.d.ts.map +1 -1
- package/build/common/samples.js +4 -2
- package/build/common/samples.js.map +1 -1
- package/build/common/templates-config.json +2 -2
- package/build/component/driver/oauth/create.d.ts.map +1 -1
- package/build/component/driver/oauth/create.js +5 -1
- package/build/component/driver/oauth/create.js.map +1 -1
- package/build/component/generator/officeAddin/metaOSHelper.d.ts.map +1 -1
- package/build/component/generator/officeAddin/metaOSHelper.js +2 -1
- package/build/component/generator/officeAddin/metaOSHelper.js.map +1 -1
- package/build/component/generator/openApiSpec/helper.js +1 -1
- package/build/core/FxCore.d.ts.map +1 -1
- package/build/core/FxCore.js +5 -2
- package/build/core/FxCore.js.map +1 -1
- package/build/question/other.d.ts +1 -0
- package/build/question/other.d.ts.map +1 -1
- package/build/question/other.js +38 -1
- package/build/question/other.js.map +1 -1
- package/build/question/scaffold/vsc/CapabilityOptions.d.ts.map +1 -1
- package/build/question/scaffold/vsc/CapabilityOptions.js +0 -1
- package/build/question/scaffold/vsc/CapabilityOptions.js.map +1 -1
- package/build/question/scaffold/vsc/createRootNode.d.ts.map +1 -1
- package/build/question/scaffold/vsc/createRootNode.js +6 -0
- package/build/question/scaffold/vsc/createRootNode.js.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +5 -5
- package/resource/package.nls.json +15 -9
- package/resource/template-info/vsc.json +95 -30
- package/templates/fallback/common.zip +0 -0
- package/templates/fallback/csharp.zip +0 -0
- package/templates/fallback/js.zip +0 -0
- package/templates/fallback/python.zip +0 -0
- package/templates/fallback/ts.zip +0 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@microsoft/teamsfx-core",
|
|
3
|
-
"version": "3.0.7
|
|
3
|
+
"version": "3.0.7",
|
|
4
4
|
"main": "build/index.js",
|
|
5
5
|
"types": "build/index.d.ts",
|
|
6
6
|
"license": "MIT",
|
|
@@ -108,9 +108,9 @@
|
|
|
108
108
|
"@feathersjs/hooks": "^0.6.5",
|
|
109
109
|
"@microsoft/dev-tunnels-contracts": "1.1.9",
|
|
110
110
|
"@microsoft/dev-tunnels-management": "1.1.9",
|
|
111
|
-
"@microsoft/kiota": "1.
|
|
112
|
-
"@microsoft/m365-spec-parser": "^0.2.10
|
|
113
|
-
"@microsoft/teamsfx-api": "0.23.11
|
|
111
|
+
"@microsoft/kiota": "1.29.0",
|
|
112
|
+
"@microsoft/m365-spec-parser": "^0.2.10",
|
|
113
|
+
"@microsoft/teamsfx-api": "0.23.11",
|
|
114
114
|
"adm-zip": "^0.5.10",
|
|
115
115
|
"ajv": "^8.5.0",
|
|
116
116
|
"axios": "^1.8.3",
|
|
@@ -233,7 +233,7 @@
|
|
|
233
233
|
"resource/**/*",
|
|
234
234
|
"templates/**/*"
|
|
235
235
|
],
|
|
236
|
-
"gitHead": "
|
|
236
|
+
"gitHead": "b434097642cd4e40896b772df437e33bda51d2d0",
|
|
237
237
|
"publishConfig": {
|
|
238
238
|
"access": "public"
|
|
239
239
|
},
|
|
@@ -323,8 +323,8 @@
|
|
|
323
323
|
"core.createProjectQuestion.option.description.worksInOutlookM365": "Works in Teams, Outlook, and the Microsoft 365 application",
|
|
324
324
|
"core.createProjectQuestion.projectType.bot.detail": "Create instant, engaging chat experiences that automate tasks seamlessly",
|
|
325
325
|
"core.createProjectQuestion.projectType.teamsAgentsAndApps.label": "Teams Agents and Apps",
|
|
326
|
-
"core.createProjectQuestion.projectType.teamsAgentsAndApps.detail": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Teams
|
|
327
|
-
"core.createProjectQuestion.projectType.teamsAgentsAndApps.title": "Teams Agent or App Using Teams
|
|
326
|
+
"core.createProjectQuestion.projectType.teamsAgentsAndApps.detail": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Microsoft Teams SDK.",
|
|
327
|
+
"core.createProjectQuestion.projectType.teamsAgentsAndApps.title": "Teams Agent or App Using Microsoft Teams SDK",
|
|
328
328
|
"core.createProjectQuestion.projectType.bot.label": "Bot",
|
|
329
329
|
"core.createProjectQuestion.projectType.bot.title": "App Features Using a Bot",
|
|
330
330
|
"core.createProjectQuestion.projectType.messageExtension.copilotEnabled.detail": "Search and take actions from the text input box in Teams and Outlook",
|
|
@@ -369,7 +369,7 @@
|
|
|
369
369
|
"core.createProjectQuestion.capability.weatherAgentOption.label": "Weather Agent",
|
|
370
370
|
"core.createProjectQuestion.capability.weatherAgentOption.detail": "A weather forecast agent that is built with Microsoft 365 Agents SDK and LangChain",
|
|
371
371
|
"core.createProjectQuestion.capability.customCopilotBasicOption.label": "General Teams Agent",
|
|
372
|
-
"core.createProjectQuestion.capability.customCopilotBasicOption.detail": "Agent that chats with users in Teams built with Teams
|
|
372
|
+
"core.createProjectQuestion.capability.customCopilotBasicOption.detail": "Agent that chats with users in Teams built with Microsoft Teams SDK and connects to LLMs",
|
|
373
373
|
"core.createProjectQuestion.capability.customCopilotRagOption.label": "Teams Agent with Data",
|
|
374
374
|
"core.createProjectQuestion.capability.customCopilotRagOption.detail": "Agent that uses your content and knowledge to accurately answer domain-specific questions",
|
|
375
375
|
"core.createProjectQuestion.capability.teamsAgent.collaborator.label": "Teams Collaborator Agent",
|
|
@@ -389,9 +389,9 @@
|
|
|
389
389
|
"core.createProjectQuestion.capability.customCopilotRag.title": "Chat With Your Data",
|
|
390
390
|
"core.createProjectQuestion.capability.customCopilotRag.placeholder": "Select an option to load your data",
|
|
391
391
|
"core.createProjectQuestion.capability.customCopilotAssistantNewOption.label": "Build from Scratch",
|
|
392
|
-
"core.createProjectQuestion.capability.customCopilotAssistantNewOption.detail": "Build your own AI Agent from scratch using Teams
|
|
392
|
+
"core.createProjectQuestion.capability.customCopilotAssistantNewOption.detail": "Build your own AI Agent from scratch using Microsoft Teams SDK",
|
|
393
393
|
"core.createProjectQuestion.capability.customCopilotAssistantAssistantsApiOption.label": "Build with Assistants API",
|
|
394
|
-
"core.createProjectQuestion.capability.customCopilotAssistantAssistantsApiOption.detail": "Build an AI agent with OpenAI Assistants API and Teams
|
|
394
|
+
"core.createProjectQuestion.capability.customCopilotAssistantAssistantsApiOption.detail": "Build an AI agent with OpenAI Assistants API and Microsoft Teams SDK",
|
|
395
395
|
"core.createProjectQuestion.capability.customCopilotAssistant.title": "AI Agent",
|
|
396
396
|
"core.createProjectQuestion.capability.customCopilotAssistant.placeholder": "Choose how you want to manage your AI tasks",
|
|
397
397
|
"core.createProjectQuestion.capability.customCopilotWeatherOption.label": "Weather Agent",
|
|
@@ -438,10 +438,16 @@
|
|
|
438
438
|
"core.createProjectQuestion.apiSpecInputUrl.label": "Enter OpenAPI Description Document Location",
|
|
439
439
|
"core.createProjectQuestion.ApiKey": "Enter API Key in OpenAPI Description Document",
|
|
440
440
|
"core.createProjectQuestion.ApiKeyConfirm": "Microsoft 365 Agents Toolkit will upload the API key to Developer Portal. The API key will be used by Teams client to securely access your API in runtime. Microsoft 365 Agents Toolkit will not store your API key.",
|
|
441
|
-
"core.createProjectQuestion.OauthClientId": "
|
|
442
|
-
"core.createProjectQuestion.
|
|
443
|
-
"core.createProjectQuestion.
|
|
444
|
-
"core.createProjectQuestion.
|
|
441
|
+
"core.createProjectQuestion.OauthClientId": "Oauth registration client ID",
|
|
442
|
+
"core.createProjectQuestion.OauthClientId.placeholder": "Input client ID for OAuth registration in OpenAPI Description Document",
|
|
443
|
+
"core.createProjectQuestion.OauthClientSecret": "OAuth registration client secret",
|
|
444
|
+
"core.createProjectQuestion.OauthClientSecret.placeholder": "Input client secret for OAuth registration in OpenAPI Description Document",
|
|
445
|
+
"core.createProjectQuestion.OauthScope": "Scope(s) for OAuth registration",
|
|
446
|
+
"core.createProjectQuestion.OauthScope.placeholder": "(optional) Input scopes for OAuth registration, separate by comma",
|
|
447
|
+
"core.createProjectQuestion.OauthScope.validation": "Invalid format. Use 'scope1, scope2:permission2'. Only letters, numbers, and ._/- are allowed.",
|
|
448
|
+
"core.createProjectQuestion.OauthClientSecretConfirm": "Microsoft 365 Agents Toolkit uploads the client ID/Secret for OAuth Registration to Developer Portal. It is used by Teams client to securely access your API at runtime. Microsoft 365 Agents Toolkit doesn't store your client ID/Secret.",
|
|
449
|
+
"core.createProjectQuestion.EntraSSOClientId": "Entra SSO client ID",
|
|
450
|
+
"core.createProjectQuestion.EntraSSOClientId.placeholder": "Input Microsoft SSO client ID generated in AAD for registration on Developer Portal",
|
|
445
451
|
"core.createProjectQuestion.apiMessageExtensionAuth.title": "Authentication Type",
|
|
446
452
|
"core.createProjectQuestion.apiMessageExtensionAuth.placeholder": "Select an authentication type",
|
|
447
453
|
"core.createProjectQuestion.invalidApiKey.message": "Invalid client secret. It should be 10 to 512 characters long.",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
],
|
|
15
15
|
"templateName": "copilot-gpt-basic",
|
|
16
16
|
"description": "Create your own agent by declaring instructions, actions, & knowledge to suit your needs. - Create declarative agent only",
|
|
17
|
-
"readme": "# Overview of the Declarative Agent template\n\nWith the declarative agent, you can build a custom version of Copilot that can be used for specific scenarios, such as for specialized knowledge, implementing specific processes, or simply to save time by reusing a set of AI prompts. For example, a grocery shopping Copilot declarative agent can be used to create a grocery list based on a meal plan that you send to Copilot.\n\n## Get started with the template\n\n> **Prerequisites**\n>\n> To run this app template in your local dev machine, you will need:\n>\n> - [Node.js](https://nodejs.org/), supported versions: 18, 20, 22\n> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts).\n> - [Microsoft 365 Agents Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\n> - [Microsoft 365 Copilot license](https://learn.microsoft.com/microsoft-365-copilot/extensibility/prerequisites#prerequisites)\n\n\n\n1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.\n2. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't already.\n3.
|
|
17
|
+
"readme": "# Overview of the Declarative Agent template\n\nWith the declarative agent, you can build a custom version of Copilot that can be used for specific scenarios, such as for specialized knowledge, implementing specific processes, or simply to save time by reusing a set of AI prompts. For example, a grocery shopping Copilot declarative agent can be used to create a grocery list based on a meal plan that you send to Copilot.\n\n## Get started with the template\n\n> **Prerequisites**\n>\n> To run this app template in your local dev machine, you will need:\n>\n> - [Node.js](https://nodejs.org/), supported versions: 18, 20, 22\n> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts).\n> - [Microsoft 365 Agents Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\n> - [Microsoft 365 Copilot license](https://learn.microsoft.com/microsoft-365-copilot/extensibility/prerequisites#prerequisites)\n\n\n\n1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.\n2. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't already.\n3. Select `Preview Local in Copilot (Edge)` or `Preview Local in Copilot (Chrome)` from the launch configuration dropdown.\n4. Select your declarative agent from the `Copilot` app.\n5. Ask a question to your declarative agent and it should respond based on the instructions provided.\n\n## What's included in the template\n\n| Folder | Contents |\n| ------------ | ---------------------------------------------------------------------------------------- |\n| `.vscode` | VSCode files for debugging |\n| `appPackage` | Templates for the application manifest, the GPT manifest and the API specification |\n| `env` | Environment files |\n\nThe following files can be customized and demonstrate an example implementation to get you started.\n\n| File | Contents |\n| ---------------------------------- | ---------------------------------------------------------------------------- |\n| `appPackage/declarativeAgent.json` | Define the behaviour and configurations of the declarative agent. |\n| `appPackage/manifest.json` | application manifest that defines metadata for your declarative agent. |\n\nThe following are Microsoft 365 Agents Toolkit specific project files. You can [visit a complete guide on Github](https://github.com/OfficeDev/TeamsFx/wiki/Teams-Toolkit-Visual-Studio-Code-v5-Guide#overview) to understand how Microsoft 365 Agents Toolkit works.\n\n| File | Contents |\n| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `m365agents.yml` | This is the main Microsoft 365 Agents Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions. |\n\n## Extend the template\n\n- [Add conversation starters](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=3): Conversation starters are hints that are displayed to the user to demonstrate how they can get started using the declarative agent.\n- [Add web content](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=4) for the ability to search web information.\n- [Add OneDrive and SharePoint content](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=5) as grounding knowledge for the agent.\n- [Add Microsoft Copilot connectors content](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=6) to ground agent with enterprise knowledge.\n- [Add API plugins](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=7) for agent to interact with REST APIs.\n\n## Addition information and references\n\n- [Declarative agents for Microsoft 365](https://aka.ms/teams-toolkit-declarative-agent)\n",
|
|
18
18
|
"supportedLanguages": [
|
|
19
19
|
"common"
|
|
20
20
|
],
|
|
@@ -182,7 +182,7 @@
|
|
|
182
182
|
],
|
|
183
183
|
"templateName": "api-plugin-from-existing-api",
|
|
184
184
|
"description": "Create your own agent by declaring instructions, actions, & knowledge to suit your needs. - Create a declarative agent with an action - Create an action from your existing API",
|
|
185
|
-
"readme": "# Overview of the basic declarative agent with API plugin template\r\n\r\n## Build a basic declarative agent with API plugin\r\n\r\nWith the declarative agent, you can build a custom version of Copilot that can be used for specific scenarios, such as for specialized knowledge, implementing specific processes, or simply to save time by reusing a set of AI prompts. For example, a grocery shopping Copilot declarative agent can be used to create a grocery list based on a meal plan that you send to Copilot.\r\n\r\nYou can extend declarative agents using plugins to retrieve data and execute tasks on external systems. A declarative agent can utilize multiple plugins at the same time.\r\n\r\n\r\n\r\n\r\n## Get started with the template\r\n\r\n> **Prerequisites**\r\n>\r\n> To run this app template in your local dev machine, you will need:\r\n>\r\n> - [Node.js](https://nodejs.org/), supported versions: 18, 20, 22\r\n> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts).\r\n> - [Microsoft 365 Agents Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\r\n> - [Microsoft 365 Copilot license](https://learn.microsoft.com/microsoft-365-copilot/extensibility/prerequisites#prerequisites)\r\n\r\n1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.\r\n2. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't already.\r\n3.
|
|
185
|
+
"readme": "# Overview of the basic declarative agent with API plugin template\r\n\r\n## Build a basic declarative agent with API plugin\r\n\r\nWith the declarative agent, you can build a custom version of Copilot that can be used for specific scenarios, such as for specialized knowledge, implementing specific processes, or simply to save time by reusing a set of AI prompts. For example, a grocery shopping Copilot declarative agent can be used to create a grocery list based on a meal plan that you send to Copilot.\r\n\r\nYou can extend declarative agents using plugins to retrieve data and execute tasks on external systems. A declarative agent can utilize multiple plugins at the same time.\r\n\r\n\r\n\r\n\r\n## Get started with the template\r\n\r\n> **Prerequisites**\r\n>\r\n> To run this app template in your local dev machine, you will need:\r\n>\r\n> - [Node.js](https://nodejs.org/), supported versions: 18, 20, 22\r\n> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts).\r\n> - [Microsoft 365 Agents Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\r\n> - [Microsoft 365 Copilot license](https://learn.microsoft.com/microsoft-365-copilot/extensibility/prerequisites#prerequisites)\r\n\r\n1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.\r\n2. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't already.\r\n3. Select `Preview Local in Copilot (Edge)` or `Preview Local in Copilot (Chrome)` from the launch configuration dropdown.\r\n4. Select your declarative agent from the `Copilot` app.\r\n5. Send a prompt.\r\n\r\n{{#ApiKey}}\r\n> [!NOTE]\r\n> Microsoft 365 Agents Toolkit will ask you for your API key during provision. The API key will be securely stored with [Developer Portal](https://dev.teams.microsoft.com/home) and used by Teams client to access your API in runtime. Microsoft 365 Agents Toolkit will not store your API key.\r\n{{/ApiKey}}\r\n\r\n{{#OAuth}}\r\n> [!NOTE]\r\n> If your identity server needs Proof of Key Code Exchange (PKCE) for token exchange, uncomment the `isPKCEEnabled` property in the` oauth/register` section of the `m365agents.yml` file shown as below:\r\n```yaml\r\n - uses: oauth/register\r\n with:\r\n name: {{ApiSpecAuthName}}\r\n flow: authorizationCode\r\n # app ID\r\n appId: ${{TEAMS_APP_ID}}\r\n # Path to OpenAPI description document\r\n apiSpecPath: {{{ApiSpecPath}}}\r\n # Uncomment below property to use proof key for code exchange (PKCE)\r\n isPKCEEnabled: true\r\n writeToEnvironmentFile:\r\n configurationId: {{ApiSpecAuthRegistrationIdEnvName}}\r\n```\r\n> Microsoft 365 Agents Toolkit will ask you for your Client ID and Client Secret for Oauth2 during provision. These information will be securely stored with [Developer Portal](https://dev.teams.microsoft.com/home) and used by Teams client to access your API in runtime. Microsoft 365 Agents Toolkit will not store your Client ID and Client Secret.\r\n{{/OAuth}}\r\n\r\n## What's included in the template\r\n\r\n| Folder | Contents |\r\n| ------------ | -------------------------------------------- |\r\n| `.vscode` | VSCode files for debugging |\r\n| `appPackage` | Templates for the application manifest, the plugin manifest and the API specification |\r\n| `env` | Environment files |\r\n\r\nThe following files can be customized and demonstrate an example implementation to get you started.\r\n\r\n| File | Contents |\r\n| ------------------------------------ | ------------------------------------------------------------------------------ |\r\n| `appPackage/declarativeCopilot.json` | Define the behaviour and configurations of the declarative agent. |\r\n| `appPackage/manifest.json` | application manifest that defines metadata for your declarative agent. |\r\n\r\nThe following are Microsoft 365 Agents Toolkit specific project files. You can [visit a complete guide on Github](https://github.com/OfficeDev/TeamsFx/wiki/Teams-Toolkit-Visual-Studio-Code-v5-Guide#overview) to understand how Microsoft 365 Agents Toolkit works.\r\n\r\n| File | Contents |\r\n| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\r\n| `m365agents.yml` | This is the main Microsoft 365 Agents Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions. |\r\n\r\n## Addition information and references\r\n\r\n- [Declarative agents for Microsoft 365](https://aka.ms/teams-toolkit-declarative-agent)\r\n- [Extend Microsoft 365 Copilot](https://aka.ms/teamsfx-copilot-plugin)\r\n- [Message extensions for Microsoft 365 Copilot](https://learn.microsoft.com/microsoft-365-copilot/extensibility/overview-message-extension-bot)\r\n- [Microsoft Copilot connectors for Microsoft 365 Copilot](https://learn.microsoft.com/microsoft-365-copilot/extensibility/overview-graph-connector)\r\n- [Microsoft 365 Copilot extensibility samples](https://learn.microsoft.com/microsoft-365-copilot/extensibility/samples)",
|
|
186
186
|
"supportedLanguages": [
|
|
187
187
|
"none"
|
|
188
188
|
],
|
|
@@ -190,6 +190,34 @@
|
|
|
190
190
|
"declarative-agent-with-action-from-existing-api"
|
|
191
191
|
]
|
|
192
192
|
},
|
|
193
|
+
{
|
|
194
|
+
"nodes": [
|
|
195
|
+
{
|
|
196
|
+
"nodeId": "project-type",
|
|
197
|
+
"optionId": "copilot-agent-type",
|
|
198
|
+
"optionLabel": "Declarative Agent"
|
|
199
|
+
},
|
|
200
|
+
{
|
|
201
|
+
"nodeId": "with-plugin",
|
|
202
|
+
"optionId": "yes",
|
|
203
|
+
"optionLabel": "Add an Action"
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
"nodeId": "api-plugin-type",
|
|
207
|
+
"optionId": "mcp",
|
|
208
|
+
"optionLabel": "Start with an MCP server"
|
|
209
|
+
}
|
|
210
|
+
],
|
|
211
|
+
"templateName": "declarative-agent-with-action-from-mcp",
|
|
212
|
+
"description": "Create your own agent by declaring instructions, actions, & knowledge to suit your needs. - Create a declarative agent with an action - Create actions from your existing MCP server",
|
|
213
|
+
"readme": "# Declarative Agent + MCP in VS Code \n\nThis template shows how to wrap your existing MCP Server into a Microsoft 365 Copilot Declarative Agent (DA) using the Agents Toolkit (ATK) in VS Code. Instead of hand‑authoring an OpenAPI spec, you point ATK at your MCP discovery URL and let the toolkit generate all manifests, wiring in authentication and function definitions automatically. \n\n## Get started with the template\n\n> **Prerequisites**\n>\n> To run this app template in your local dev machine, you will need:\n>\n> - [Node.js](https://nodejs.org/), supported versions: 18, 20, 22\n> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts).\n> - [Microsoft 365 Agents Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\n> - [Microsoft 365 Copilot license](https://learn.microsoft.com/microsoft-365-copilot/extensibility/prerequisites#prerequisites)\n\n1. Open ATK in VS Code\n\n Click the Microsoft 365 Agents Toolkit icon in the Activity Bar. \n\n2. Sign in\n\n Open the Agents Toolkit by click on the toolkit icon in the VS Code sidebar. Under Account, authenticate with your dev M365 account.\n\n3. Scaffold a new DA\n\n In the Agents Toolkit menu, click 'Create new Agent/app', select 'Declarative Agent', choose a folder and name (e.g. my-mcp-agent).\n\n4. Add your MCP Server\n\n In the ATK sidebar click Add Action → Start with an MCP server, then enter your MCP discovery URL (e.g. https://mcp.contoso.com/discover).\n\n5. Start your MCP Server \n\n After the DA project generated, click the \"Start\" button in the mcp.json file to start your MCP server, when prompt, enter the user ID and password for authentication.\n\n6. Fetch and select tools \n\n When prompted, Click ATK:Fetch Action from MCP\" in the mcp.json file choose Pre‑fetch tools (for offline IntelliSense) or Dynamic. ATK will list all available MCP actions—check the ones you want in your agent.\n\n7. Configure Auth\n\n ATK will retrieve the authentication information for your MCP server and store these values are in env/.env.development and a secure reference is injected into appPackage/ai-plugin.json. If the inputted MCP server authentication information is not configure correctly according to the MCP protocol, ATK will prompt errors.\n\n8. Review generated files\n\n - `appPackage/ai-plugin.json` (function definitions, runtime spec + auth) - This file defines the the action or operations that Copilot can interact with.\n - `appPackage/declarativeAgent.json` (agent configuration & sample prompts) - This file is the definition of your declarative agent\n - `appPackage/manifest.json` (Teams/Outlook integration)\n\n9. Provision & debug\n\n Use the Provision button in ATK to create resources. ATK will detect if your MCP server requires OAuth2 or API‐Key. Provide your Client ID/Secret or Key when prompted. Then Start Debugging to Preview agent in Copilot in Edge/Chrome. Your DA will appear under Copilot chats.\n\n10. Test your MCP‑powered agent \n\n Open the Copilot pane, select your agent and invoke any of the MCP tools with natural‑language prompts. \n\n## Project Structure\n\n| Folder | Description |\n| ------------ | ---------------------------------------------------------------------------------------- |\n| `.vscode` | ATK debug & .vscode/mcp.json for MCP server config |\n| `appPackage` | - `appPackage/ai-plugin.json` (function definitions, runtime spec + auth) - This file defines the the action or operations that Copilot can interact with<br>- `appPackage/declarativeAgent.json` (agent configuration & sample prompts) - This file is the definition of your declarative agent<br>- `appPackage/manifest.json` (Teams/Outlook integration) |\n| `env` | Local environment files (.env.development, .env.local) |\n| `m365agents.yml` | Defines your DA stages & lifecycle for ATK |\n\n## MCP‑specific tips\n\n- **Discovery URL**: your MCP server’s /discover endpoint must expose JSON‑Schema for every action.\n- **Tool selection**: the run_for_functions array in ai-plugin.json limits which MCP tools your agent can call. \n\n- **Auth flows**: ATK supports both OAuth2.1 and API‑Key; you don’t need to hand‑edit auth blocks. \n\n- **Versioning**: when your MCP server schema changes, simply rerun ATK: Fetch Action from MCP to refresh your plugin file. \n\n- **Error logging**: basic request/response logs appear in the ATK console; errors bubble up in your Copilot chat. \n\n\n## Learn More\n\n- [Build Declarative Agents (official docs)](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents)\n\n- [Model Context Protocol (MCP)](https://modelcontextprotocol.io/)\n\n- [Agents Toolkit guide on GitHub](https://github.com/OfficeDev/TeamsFx/wiki/Teams-Toolkit-Visual-Studio-Code-v5-Guide#overview)\n\nHappy building! \n\nWith MCP + Declarative Agents, you’ll have a turnkey path from your existing APIs to a fully operational Copilot‑powered experience. \n",
|
|
214
|
+
"supportedLanguages": [
|
|
215
|
+
"common"
|
|
216
|
+
],
|
|
217
|
+
"templateIds": [
|
|
218
|
+
"declarative-agent-with-action-from-mcp"
|
|
219
|
+
]
|
|
220
|
+
},
|
|
193
221
|
{
|
|
194
222
|
"nodes": [
|
|
195
223
|
{
|
|
@@ -228,7 +256,7 @@
|
|
|
228
256
|
],
|
|
229
257
|
"templateName": "declarative-agent-typespec",
|
|
230
258
|
"description": "Create your own agent by declaring instructions, actions, & knowledge to suit your needs. - Create a declarative agent with or without an action using TypeSpec for Microsoft 365 Copilot",
|
|
231
|
-
"readme": "# Overview of the Declarative Agent with TypeSpec for Microsoft 365 template\n\nWith the declarative agent, you can build a custom version of Copilot that can be used for specific scenarios, such as for specialized knowledge, implementing specific processes, or simply to save time by reusing a set of AI prompts. For example, a grocery shopping Copilot declarative agent can be used to create a grocery list based on a meal plan that you send to Copilot.\n\n## Get started with the template\n\n> **Prerequisites**\n>\n> To run this app template in your local dev machine, you will need:\n>\n> - [Node.js](https://nodejs.org/), supported versions: 18, 20, 22\n> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts).\n> - [Microsoft 365 Agents Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\n> - [Microsoft 365 Copilot license](https://learn.microsoft.com/microsoft-365-copilot/extensibility/prerequisites#prerequisites)\n\n\n\n1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.\n2. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't already.\n3. Run `npm install` to install dependencies before working with TypeSpec files.\n4. Update the [`main.tsp`](./main.tsp) to configure your agent and its plugins. This is the default entry point for TypeSpec files. \n5.
|
|
259
|
+
"readme": "# Overview of the Declarative Agent with TypeSpec for Microsoft 365 template\n\nWith the declarative agent, you can build a custom version of Copilot that can be used for specific scenarios, such as for specialized knowledge, implementing specific processes, or simply to save time by reusing a set of AI prompts. For example, a grocery shopping Copilot declarative agent can be used to create a grocery list based on a meal plan that you send to Copilot.\n\n## Get started with the template\n\n> **Prerequisites**\n>\n> To run this app template in your local dev machine, you will need:\n>\n> - [Node.js](https://nodejs.org/), supported versions: 18, 20, 22\n> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts).\n> - [Microsoft 365 Agents Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\n> - [Microsoft 365 Copilot license](https://learn.microsoft.com/microsoft-365-copilot/extensibility/prerequisites#prerequisites)\n\n\n\n1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.\n2. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't already.\n3. Run `npm install` to install dependencies before working with TypeSpec files.\n4. Update the [`main.tsp`](./main.tsp) to configure your agent and its plugins. This is the default entry point for TypeSpec files. \n5. Select `Preview Local in Copilot (Edge)` or `Preview Local in Copilot (Chrome)` from the launch configuration dropdown.\n6. Select your declarative agent from the `Copilot` app.\n7. Ask a question to your declarative agent and it should respond based on the instructions provided.\n\n## What's included in the template\n\n| Folder | Contents |\n| ------------ | ---------------------------------------------------------------------------------------- |\n| `.vscode` | VSCode files for debugging |\n| `appPackage` | Templates for the application manifest, the GPT manifest and the API specification |\n| `env` | Environment files |\n\nThe following files can be customized and demonstrate an example implementation to get you started.\n\n| File | Contents |\n| ---------------------------------- | ---------------------------------------------------------------------------- |\n| `appPackage/manifest.json` | application manifest that defines metadata for your declarative agent. |\n\nThe following are Microsoft 365 Agents Toolkit specific project files. You can [visit a complete guide on Github](https://github.com/OfficeDev/TeamsFx/wiki/Teams-Toolkit-Visual-Studio-Code-v5-Guide#overview) to understand how Microsoft 365 Agents Toolkit works.\n\n| File | Contents |\n| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `m365agents.yml` | This is the main Microsoft 365 Agents Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions. |\n\nThe following are TypeSpec template files. You need to customize these files to configure your agent.\n\n| File | Contents |\n| ------------- | ------------------------------------------------------------------------------------------- |\n| `main.tsp` | This is the root file of TSP files. Please manually update this file to add your own agent. |\n| `actions.tsp` | This is the actions file containing API endpoints to extend your declarative agent. |\n\n## Extend the template\n\n- [Add conversation starters](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=3): Conversation starters are hints that are displayed to the user to demonstrate how they can get started using the declarative agent.\n- [Add web content](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=4) for the ability to search web information.\n- [Add OneDrive and SharePoint content](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=5) as grounding knowledge for the agent.\n- [Add Microsoft Copilot Connectors content](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=6) to ground agent with enterprise knowledge.\n\n## Addition information and references\n\n- [Declarative agents for Microsoft 365](https://aka.ms/teams-toolkit-declarative-agent)\n",
|
|
232
260
|
"supportedLanguages": [
|
|
233
261
|
"common"
|
|
234
262
|
],
|
|
@@ -300,15 +328,17 @@
|
|
|
300
328
|
}
|
|
301
329
|
],
|
|
302
330
|
"templateName": "custom-copilot-basic",
|
|
303
|
-
"description": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Teams
|
|
304
|
-
"readme": "# Overview of the Basic AI Chatbot template\r\n\r\nThis app template is built on top of [Teams
|
|
331
|
+
"description": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Microsoft Teams SDK. - Agent that chats with users in Teams built with Microsoft Teams SDK and connects to LLMs",
|
|
332
|
+
"readme": "# Overview of the Basic AI Chatbot template\r\n\r\nThis app template is built on top of [Microsoft Teams SDK](https://aka.ms/teams-ai-library-v2).\r\nIt showcases an agent app that responds to user questions like ChatGPT. This enables your users to talk with the AI agent in Teams.\r\n\r\n## Get started with the template\r\n\r\n> **Prerequisites**\r\n>\r\n> To run the template in your local dev machine, you will need:\r\n>\r\n> - [Node.js](https://nodejs.org/), supported versions: 20, 22.\r\n{{^enableTestToolByDefault}}\r\n> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts).\r\n{{/enableTestToolByDefault}}\r\n> - [Microsoft 365 Agents Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) latest version or [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli).\r\n{{#useOpenAI}}\r\n> - An account with [OpenAI](https://platform.openai.com/).\r\n{{/useOpenAI}}\r\n{{#useAzureOpenAI}}\r\n> - Prepare your own [Azure OpenAI](https://aka.ms/oai/access) resource.\r\n{{/useAzureOpenAI}}\r\n\r\n> For local debugging using Microsoft 365 Agents Toolkit CLI, you need to do some extra steps described in [Set up your Microsoft 365 Agents Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).\r\n\r\n1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.\r\n{{#enableTestToolByDefault}}\r\n{{#useOpenAI}}\r\n1. In file *env/.env.playground.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY=<your-key>`.\r\n{{/useOpenAI}}\r\n{{#useAzureOpenAI}}\r\n1. In file *env/.env.playground.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_API_KEY=<your-key>`, endpoint `AZURE_OPENAI_ENDPOINT=<your-endpoint>`, and deployment name `AZURE_OPENAI_DEPLOYMENT_NAME=<your-deployment>`.\r\n{{/useAzureOpenAI}}\r\n1. Press F5 to start debugging which launches your app in Microsoft 365 Agents Playground using a web browser. Select `Debug in Microsoft 365 Agents Playground`.\r\n1. You can send any message to get a response from the agent.\r\n\r\n**Congratulations**! You are running an application that can now interact with users in Microsoft 365 Agents Playground:\r\n\r\n\r\n{{/enableTestToolByDefault}}\r\n{{^enableTestToolByDefault}}\r\n1. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't yet.\r\n{{#useOpenAI}}\r\n1. In file *env/.env.local.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY=<your-key>`.\r\n{{/useOpenAI}}\r\n{{#useAzureOpenAI}}\r\n1. In file *env/.env.local.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_API_KEY=<your-key>`, endpoint `AZURE_OPENAI_ENDPOINT=<your-endpoint>`, and deployment name `AZURE_OPENAI_DEPLOYMENT_NAME=<your-deployment>`.\r\n{{/useAzureOpenAI}}\r\n1. Press F5 to start debugging which launches your app in Teams using a web browser. Select `Debug in Teams (Edge)` or `Debug in Teams (Chrome)`.\r\n1. When Teams launches in the browser, select the Add button in the dialog to install your app to Teams.\r\n1. You can send any message to get a response from the agent.\r\n\r\n**Congratulations**! You are running an application that can now interact with users in Teams:\r\n\r\n\r\n{{/enableTestToolByDefault}}\r\n\r\n## What's included in the template\r\n\r\n| Folder | Contents |\r\n| - | - |\r\n| `.vscode` | VSCode files for debugging |\r\n| `appPackage` | Templates for the application manifest |\r\n| `env` | Environment files |\r\n| `infra` | Templates for provisioning Azure resources |\r\n| `src` | The source code for the application |\r\n\r\nThe following files can be customized and demonstrate an example implementation to get you started.\r\n\r\n| File | Contents |\r\n| - | - |\r\n|`src/index.ts`| Application entry point. |\r\n|`src/config.ts`| Defines the environment variables.|\r\n|`src/app/instructions.txt`| Defines the prompt.|\r\n|`src/app/app.ts`| Handles business logics for the Basic AI Chatbot.|\r\n\r\nThe following are Microsoft 365 Agents Toolkit specific project files. You can [visit a complete guide on Github](https://github.com/OfficeDev/TeamsFx/wiki/Teams-Toolkit-Visual-Studio-Code-v5-Guide#overview) to understand how Microsoft 365 Agents Toolkit works.\r\n\r\n| File | Contents |\r\n| - | - |\r\n|`m365agents.yml`|This is the main Microsoft 365 Agents Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions. |\r\n|`m365agents.local.yml`|This overrides `m365agents.yml` with actions that enable local execution and debugging.|\r\n|`m365agents.playground.yml`| This overrides `m365agents.yml` with actions that enable local execution and debugging in Microsoft 365 Agents Playground.|\r\n\r\n## Extend the template\r\n\r\nTo extend the Basic AI Chatbot template with more AI capabilities, explore [Microsoft Teams SDK documentation](https://aka.ms/m365-agents-toolkit/teams-agent-extend-ai).\r\n\r\n## Additional information and references\r\n\r\n- [Microsoft 365 Agents Toolkit Documentations](https://docs.microsoft.com/microsoftteams/platform/toolkit/teams-toolkit-fundamentals)\r\n- [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\r\n- [Microsoft 365 Agents Toolkit Samples](https://github.com/OfficeDev/TeamsFx-Samples)\r\n{{#CEAEnabled}}\r\n\r\n## Known issue\r\n- Streaming is only currently supported for single 1:1 chats, and not for groups or channels.\r\n{{/CEAEnabled}}",
|
|
305
333
|
"supportedLanguages": [
|
|
306
334
|
"typescript",
|
|
307
|
-
"javascript"
|
|
335
|
+
"javascript",
|
|
336
|
+
"python"
|
|
308
337
|
],
|
|
309
338
|
"templateIds": [
|
|
310
339
|
"custom-copilot-basic-ts",
|
|
311
|
-
"custom-copilot-basic-js"
|
|
340
|
+
"custom-copilot-basic-js",
|
|
341
|
+
"custom-copilot-basic-python"
|
|
312
342
|
]
|
|
313
343
|
},
|
|
314
344
|
{
|
|
@@ -330,15 +360,17 @@
|
|
|
330
360
|
}
|
|
331
361
|
],
|
|
332
362
|
"templateName": "custom-copilot-rag-customize",
|
|
333
|
-
"description": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Teams
|
|
334
|
-
"readme": "# Overview of the Chat With Your Data (Custom Data Source) template\r\n\r\nThis app template showcases how to build one of the most powerful applications enabled by LLM - sophisticated question-answering (Q&A) chat bots that can answer questions about specific source information right in the Microsoft Teams.\r\nThis app template also demonstrates usage of techniques like: \r\n- [Retrieval Augmented Generation](https://python.langchain.com/docs/use_cases/question_answering/#what-is-rag), or RAG.\r\n- [Teams
|
|
363
|
+
"description": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Microsoft Teams SDK. - Agent that uses your content and knowledge to accurately answer domain-specific questions - Decide how to load your data",
|
|
364
|
+
"readme": "# Overview of the Chat With Your Data (Custom Data Source) template\r\n\r\nThis app template showcases how to build one of the most powerful applications enabled by LLM - sophisticated question-answering (Q&A) chat bots that can answer questions about specific source information right in the Microsoft Teams.\r\nThis app template also demonstrates usage of techniques like: \r\n- [Retrieval Augmented Generation](https://python.langchain.com/docs/use_cases/question_answering/#what-is-rag), or RAG.\r\n- [Microsoft Teams SDK](https://aka.ms/teams-ai-library-v2)\r\n\r\n## Get started with the template\r\n\r\n> **Prerequisites**\r\n>\r\n> To run the template in your local dev machine, you will need:\r\n>\r\n> - [Node.js](https://nodejs.org/), supported versions: 20, 22\r\n> - [Microsoft 365 Agents Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\r\n{{#useOpenAI}}\r\n> - An account with [OpenAI](https://platform.openai.com/).\r\n{{/useOpenAI}}\r\n{{#useAzureOpenAI}}\r\n> - Prepare your own [Azure OpenAI](https://aka.ms/oai/access) resource.\r\n{{/useAzureOpenAI}}\r\n\r\n> For local debugging using Microsoft 365 Agents Toolkit CLI, you need to do some extra steps described in [Set up your Microsoft 365 Agents Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).\r\n\r\n1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.\r\n{{#useOpenAI}}\r\n1. In file *env/.env.playground.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY=<your-key>`.\r\n{{/useOpenAI}}\r\n{{#useAzureOpenAI}}\r\n1. In file *env/.env.playground.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_API_KEY=<your-key>`, endpoint `AZURE_OPENAI_ENDPOINT=<your-endpoint>` and deployment name `AZURE_OPENAI_DEPLOYMENT_NAME=<your-deployment>`.\r\n{{/useAzureOpenAI}}\r\n1. Press F5 to start debugging which launches your app in Microsoft 365 Agents Playground using a web browser. Select `Debug in Microsoft 365 Agents Playground`.\r\n1. You can send any message to get a response from the agent.\r\n\r\n**Congratulations**! You are running an application that can now interact with users in Microsoft 365 Agents Playground:\r\n\r\n\r\n\r\n## What's included in the template\r\n\r\n| Folder | Contents |\r\n| - | - |\r\n| `.vscode` | VSCode files for debugging |\r\n| `appPackage` | Templates for the application manifest |\r\n| `env` | Environment files |\r\n| `infra` | Templates for provisioning Azure resources |\r\n| `src` | The source code for the application |\r\n\r\nThe following files can be customized and demonstrate an example implementation to get you started.\r\n\r\n| File | Contents |\r\n| - | - |\r\n|`src/index.ts`| Application entry point.|\r\n|`src/config.ts`| Defines the environment variables.|\r\n|`src/app/app.ts`| Main application code.|\r\n|`src/app/myDataSource.ts`| Defines the data source.|\r\n|`src/data/*.md`| Raw text data sources.|\r\n\r\nThe following are Microsoft 365 Agents Toolkit specific project files. You can [visit a complete guide on Github](https://github.com/OfficeDev/TeamsFx/wiki/Teams-Toolkit-Visual-Studio-Code-v5-Guide#overview) to understand how Microsoft 365 Agents Toolkit works.\r\n\r\n| File | Contents |\r\n| - | - |\r\n|`m365agents.yml`|This is the main Microsoft 365 Agents Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions. |\r\n|`m365agents.local.yml`|This overrides `m365agents.yml` with actions that enable local execution and debugging.|\r\n|`m365agents.playground.yml`| This overrides `m365agents.yml` with actions that enable local execution and debugging in Microsoft 365 Agents Playground.|\r\n\r\n## Extend the template\r\n\r\nTo extend the Basic AI Chatbot template with more AI capabilities, explore [Microsoft Teams SDK documentation](https://aka.ms/m365-agents-toolkit/teams-agent-extend-ai).\r\n\r\n## Additional information and references\r\n\r\n- [Microsoft 365 Agents Toolkit Documentations](https://docs.microsoft.com/microsoftteams/platform/toolkit/teams-toolkit-fundamentals)\r\n- [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\r\n- [Microsoft 365 Agents Toolkit Samples](https://github.com/OfficeDev/TeamsFx-Samples)",
|
|
335
365
|
"supportedLanguages": [
|
|
336
366
|
"typescript",
|
|
337
|
-
"javascript"
|
|
367
|
+
"javascript",
|
|
368
|
+
"python"
|
|
338
369
|
],
|
|
339
370
|
"templateIds": [
|
|
340
371
|
"custom-copilot-rag-customize-ts",
|
|
341
|
-
"custom-copilot-rag-customize-js"
|
|
372
|
+
"custom-copilot-rag-customize-js",
|
|
373
|
+
"custom-copilot-rag-customize-python"
|
|
342
374
|
]
|
|
343
375
|
},
|
|
344
376
|
{
|
|
@@ -360,15 +392,17 @@
|
|
|
360
392
|
}
|
|
361
393
|
],
|
|
362
394
|
"templateName": "custom-copilot-rag-azure-ai-search",
|
|
363
|
-
"description": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Teams
|
|
364
|
-
"readme": "# Overview of the Chat With Your Data (Using Azure AI Search) template\r\n\r\nThis app template showcases how to build one of the most powerful applications enabled by LLM - sophisticated question-answering (Q&A) chat bots that can answer questions about specific source information right in the Microsoft Teams.\r\nThis app template also demonstrates usage of techniques like: \r\n- [Retrieval Augmented Generation](https://python.langchain.com/docs/use_cases/question_answering/#what-is-rag), or RAG.\r\n- [Azure AI Search](https://learn.microsoft.com/azure/search/search-what-is-azure-search)\r\n- [Teams
|
|
395
|
+
"description": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Microsoft Teams SDK. - Agent that uses your content and knowledge to accurately answer domain-specific questions - Load your data from Azure AI Search service",
|
|
396
|
+
"readme": "# Overview of the Chat With Your Data (Using Azure AI Search) template\r\n\r\nThis app template showcases how to build one of the most powerful applications enabled by LLM - sophisticated question-answering (Q&A) chat bots that can answer questions about specific source information right in the Microsoft Teams.\r\nThis app template also demonstrates usage of techniques like: \r\n- [Retrieval Augmented Generation](https://python.langchain.com/docs/use_cases/question_answering/#what-is-rag), or RAG.\r\n- [Azure AI Search](https://learn.microsoft.com/azure/search/search-what-is-azure-search)\r\n- [Microsoft Teams SDK](https://aka.ms/teams-ai-library-v2)\r\n\r\n## Get started with the template\r\n\r\n> **Prerequisites**\r\n>\r\n> To run the template in your local dev machine, you will need:\r\n>\r\n> - [Node.js](https://nodejs.org/), supported versions: 20, 22\r\n> - [Microsoft 365 Agents Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\r\n{{#useOpenAI}}\r\n> - An account with [OpenAI](https://platform.openai.com/) and [Azure AI Search](https://azure.microsoft.com/en-us/products/ai-services/ai-search).\r\n{{/useOpenAI}}\r\n{{#useAzureOpenAI}}\r\n> - Prepare your own [Azure OpenAI](https://aka.ms/oai/access) resource and [Azure AI Search](https://azure.microsoft.com/en-us/products/ai-services/ai-search).\r\n{{/useAzureOpenAI}}\r\n\r\n> For local debugging using Microsoft 365 Agents Toolkit CLI, you need to do some extra steps described in [Set up your Microsoft 365 Agents Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).\r\n\r\n1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.\r\n{{#useOpenAI}}\r\n1. In file *env/.env.playground.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY=<your-key>`. And fill in your Azure AI search key `SECRET_AZURE_SEARCH_KEY=<your-ai-search-key>` and endpoint `AZURE_SEARCH_ENDPOINT=<your-ai-search-endpoint>`.\r\n{{/useOpenAI}}\r\n{{#useAzureOpenAI}}\r\n1. In file *env/.env.playground.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_API_KEY=<your-key>`, endpoint `AZURE_OPENAI_ENDPOINT=<your-endpoint>`, deployment name `AZURE_OPENAI_DEPLOYMENT_NAME=<your-deployment>`, and embedding deployment name `AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME=<your-embedding-deployment>`. And fill in your Azure AI search key `SECRET_AZURE_SEARCH_KEY=<your-ai-search-key>` and endpoint `AZURE_SEARCH_ENDPOINT=<your-ai-search-endpoint>`.\r\n{{/useAzureOpenAI}}\r\n{{#useOpenAI}}\r\n1. Do `npm install` and `npm run indexer:create -- <your-ai-search-key> <your-openai-api-key>` to create the my documents index. Once you're done using the sample it's good practice to delete the index. You can do so with the `npm run indexer:delete -- <your-ai-search-key>` command.\r\n{{/useOpenAI}}\r\n{{#useAzureOpenAI}}\r\n1. Do `npm install` and `npm run indexer:create -- <your-ai-search-key> <your-azure-openai-api-key>` to create the my documents index. Once you're done using the sample it's good practice to delete the index. You can do so with the `npm run indexer:delete -- <your-ai-search-key>` command.\r\n{{/useAzureOpenAI}}\r\n1. Press F5 to start debugging which launches your app in Microsoft 365 Agents Playground using a web browser. Select `Debug in Microsoft 365 Agents Playground`.\r\n1. You can send any message to get a response from the agent.\r\n\r\n**Congratulations**! You are running an application that can now interact with users in Microsoft 365 Agents Playground:\r\n\r\n\r\n\r\n## What's included in the template\r\n\r\n| Folder | Contents |\r\n| - | - |\r\n| `.vscode` | VSCode files for debugging |\r\n| `appPackage` | Templates for the application manifest |\r\n| `env` | Environment files |\r\n| `infra` | Templates for provisioning Azure resources |\r\n| `src` | The source code for the application |\r\n\r\nThe following files can be customized and demonstrate an example implementation to get you started.\r\n\r\n| File | Contents |\r\n| - | - |\r\n|`src/index.ts`| Application entry point.|\r\n|`src/config.ts`| Defines the environment variables.|\r\n|`src/app/app.ts`| Main application code|\r\n|`src/app/azureAISearchDataSource.ts`| Defines the Azure AI search data source.|\r\n|`src/indexers/data/*.md`| Raw text data sources.|\r\n|`src/indexers/utils.ts`| Basic index tools. |\r\n|`src/indexers/setup.ts`| A script to create index and upload documents. |\r\n|`src/indexers/delete.ts`| A script to delete index and documents. |\r\n\r\nThe following are Microsoft 365 Agents Toolkit specific project files. You can [visit a complete guide on Github](https://github.com/OfficeDev/TeamsFx/wiki/Teams-Toolkit-Visual-Studio-Code-v5-Guide#overview) to understand how Microsoft 365 Agents Toolkit works.\r\n\r\n| File | Contents |\r\n| - | - |\r\n|`m365agents.yml`|This is the main Microsoft 365 Agents Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions. |\r\n|`m365agents.local.yml`|This overrides `m365agents.yml` with actions that enable local execution and debugging.|\r\n|`m365agents.playground.yml`| This overrides `m365agents.yml` with actions that enable local execution and debugging in Microsoft 365 Agents Playground.|\r\n\r\n## Extend the template\r\n\r\nTo extend the Basic AI Chatbot template with more AI capabilities, explore [Microsoft Teams SDK documentation](https://aka.ms/m365-agents-toolkit/teams-agent-extend-ai).\r\n\r\n## Additional information and references\r\n\r\n- [Microsoft 365 Agents Toolkit Documentations](https://docs.microsoft.com/microsoftteams/platform/toolkit/teams-toolkit-fundamentals)\r\n- [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\r\n- [Microsoft 365 Agents Toolkit Samples](https://github.com/OfficeDev/TeamsFx-Samples)",
|
|
365
397
|
"supportedLanguages": [
|
|
366
398
|
"typescript",
|
|
367
|
-
"javascript"
|
|
399
|
+
"javascript",
|
|
400
|
+
"python"
|
|
368
401
|
],
|
|
369
402
|
"templateIds": [
|
|
370
403
|
"custom-copilot-rag-azure-ai-search-ts",
|
|
371
|
-
"custom-copilot-rag-azure-ai-search-js"
|
|
404
|
+
"custom-copilot-rag-azure-ai-search-js",
|
|
405
|
+
"custom-copilot-rag-azure-ai-search-python"
|
|
372
406
|
]
|
|
373
407
|
},
|
|
374
408
|
{
|
|
@@ -390,15 +424,40 @@
|
|
|
390
424
|
}
|
|
391
425
|
],
|
|
392
426
|
"templateName": "custom-copilot-rag-custom-api",
|
|
393
|
-
"description": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Teams
|
|
394
|
-
"readme": "# Overview of the Chat With Your Data (Using Custom API) template\r\n\r\nThis template showcases how to build an AI-powered intelligent chatbot that can understand natural language to invoke the API defined in the OpenAPI description document, so you can enable your users to chat with the data provided through API service.\r\nThis app template is built on top of [Teams
|
|
427
|
+
"description": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Microsoft Teams SDK. - Agent that uses your content and knowledge to accurately answer domain-specific questions - Load your data from custom APIs based on OpenAPI description document",
|
|
428
|
+
"readme": "# Overview of the Chat With Your Data (Using Custom API) template\r\n\r\nThis template showcases how to build an AI-powered intelligent chatbot that can understand natural language to invoke the API defined in the OpenAPI description document, so you can enable your users to chat with the data provided through API service.\r\nThis app template is built on top of [Microsoft Teams SDK](https://aka.ms/teams-ai-library-v2), which provides the capabilities to build AI-based applications.\r\n\r\n## Get started with the template\r\n\r\n> **Prerequisites**\r\n>\r\n> To run the template in your local dev machine, you will need:\r\n>\r\n> - [Node.js](https://nodejs.org/), supported versions: 20, 22\r\n{{^enableTestToolByDefault}}\r\n> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts)\r\n{{/enableTestToolByDefault}}\r\n> - [Microsoft 365 Agents Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\r\n{{#useOpenAI}}\r\n> - An account with [OpenAI](https://platform.openai.com/)\r\n{{/useOpenAI}}\r\n{{#useAzureOpenAI}}\r\n> - Prepare your own [Azure OpenAI](https://aka.ms/oai/access) resource.\r\n{{/useAzureOpenAI}}\r\n\r\n> For local debugging using Microsoft 365 Agents Toolkit CLI, you need to do some extra steps described in [Set up your Microsoft 365 Agents Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).\r\n\r\n1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.\r\n{{#enableTestToolByDefault}}\r\n{{#useOpenAI}}\r\n1. In file *env/.env.playground.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY=<your-key>`.\r\n{{/useOpenAI}}\r\n{{#useAzureOpenAI}}\r\n1. In file *env/.env.playground.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_ENDPOINT=<your-key>`, endpoint `SECRET_AZURE_OPENAI_ENDPOINT=<your-endpoint>` and deployment name `AZURE_OPENAI_MODEL_DEPLOYMENT_NAME=<your-deployment-name>`.\r\n{{/useAzureOpenAI}}\r\n1. Press F5 to start debugging which launches your app in Microsoft 365 Agents Playground using a web browser. Select `Debug in Microsoft 365 Agents Playground`.\r\n1. You can send any message to get a response from the agent.\r\n\r\n**Congratulations**! You are running an application that can now interact with users in Microsoft 365 Agents Playground:\r\n\r\n\r\n{{/enableTestToolByDefault}}\r\n{{^enableTestToolByDefault}}\r\n1. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't yet.\r\n{{#useOpenAI}}\r\n1. In file *env/.env.local.user*, fill in your OpenAI key `SECRET_OPENAI_API_KEY=<your-key>`.\r\n{{/useOpenAI}}\r\n{{#useAzureOpenAI}}\r\n1. In file *env/.env.local.user*, fill in your Azure OpenAI key `SECRET_AZURE_OPENAI_ENDPOINT=<your-key>`, endpoint `SECRET_AZURE_OPENAI_ENDPOINT=<your-endpoint> and deployment name `AZURE_OPENAI_MODEL_DEPLOYMENT_NAME=<your-deployment-name>`.\r\n{{/useAzureOpenAI}}\r\n1. Press F5 to start debugging which launches your app in Teams using a web browser. Select `Debug in Teams (Edge)` or `Debug in Teams (Chrome)`.\r\n1. When Teams launches in the browser, select the Add button in the dialog to install your app to Teams.\r\n1. You can send any message to get a response from the agent.\r\n\r\n**Congratulations**! You are running an application that can now interact with users in Teams:\r\n\r\n\r\n{{/enableTestToolByDefault}}\r\n\r\n## What's included in the template\r\n\r\n| Folder | Contents |\r\n| - | - |\r\n| `.vscode` | VSCode files for debugging |\r\n| `appPackage` | Templates for the application manifest |\r\n| `appPackage/apiSpecificationFile` | Generated API spec file |\r\n| `env` | Environment files |\r\n| `infra` | Templates for provisioning Azure resources |\r\n| `src` | The source code for the application |\r\n\r\nThe following files can be customized and demonstrate an example implementation to get you started.\r\n\r\n| File | Contents |\r\n| - | - |\r\n|`src/index.ts`| Application entry point.|\r\n|`src/config.ts`| Defines the environment variables.|\r\n|`src/app/instructions.txt`| Defines the prompt.|\r\n|`src/app/handlers.ts`| Function handlers.|\r\n|`src/app/functions.json`| Defines the functions.|\r\n|`src/app/utility.ts`| Utility methods for the AI agent.|\r\n\r\nThe following are Microsoft 365 Agents Toolkit specific project files. You can [visit a complete guide on Github](https://github.com/OfficeDev/TeamsFx/wiki/Teams-Toolkit-Visual-Studio-Code-v5-Guide#overview) to understand how Microsoft 365 Agents Toolkit works.\r\n\r\n| File | Contents |\r\n| - | - |\r\n|`m365agents.yml`|This is the main Microsoft 365 Agents Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions. |\r\n|`m365agents.local.yml`|This overrides `m365agents.yml` with actions that enable local execution and debugging.|\r\n|`m365agents.playground.yml`| This overrides `m365agents.yml` with actions that enable local execution and debugging in Microsoft 365 Agents Playground.|\r\n\r\n## Extend the template\r\n\r\nTo extend the Basic AI Chatbot template with more AI capabilities, explore [Microsoft Teams SDK documentation](https://aka.ms/m365-agents-toolkit/teams-agent-extend-ai).\r\n\r\n## Additional information and references\r\n\r\n- [Microsoft 365 Agents Toolkit Documentations](https://docs.microsoft.com/microsoftteams/platform/toolkit/teams-toolkit-fundamentals)\r\n- [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\r\n- [Microsoft 365 Agents Toolkit Samples](https://github.com/OfficeDev/TeamsFx-Samples)\r\n",
|
|
395
429
|
"supportedLanguages": [
|
|
396
430
|
"typescript",
|
|
397
|
-
"javascript"
|
|
431
|
+
"javascript",
|
|
432
|
+
"python"
|
|
398
433
|
],
|
|
399
434
|
"templateIds": [
|
|
400
435
|
"custom-copilot-rag-custom-api-ts",
|
|
401
|
-
"custom-copilot-rag-custom-api-js"
|
|
436
|
+
"custom-copilot-rag-custom-api-js",
|
|
437
|
+
"teams-agent-with-data-custom-api-v2-python"
|
|
438
|
+
]
|
|
439
|
+
},
|
|
440
|
+
{
|
|
441
|
+
"nodes": [
|
|
442
|
+
{
|
|
443
|
+
"nodeId": "project-type",
|
|
444
|
+
"optionId": "teams-agent-and-app-type",
|
|
445
|
+
"optionLabel": "Teams Agents and Apps"
|
|
446
|
+
},
|
|
447
|
+
{
|
|
448
|
+
"nodeId": "teams-app-type",
|
|
449
|
+
"optionId": "teams-collaborator-agent",
|
|
450
|
+
"optionLabel": "Teams Collaborator Agent"
|
|
451
|
+
}
|
|
452
|
+
],
|
|
453
|
+
"templateName": "teams-collaborator-agent",
|
|
454
|
+
"description": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Microsoft Teams SDK. - Agent that enhances collaboration in group chat, channels or meetings through summarization, task management, and conversation search",
|
|
455
|
+
"readme": "# Collaborator Agent for Microsoft Teams\r\n\r\nThis intelligent collaboration assistant is built with the [Microsoft Teams SDK](https://aka.ms/teamsai-v2), and showcases how to create a sophisticated bot that can analyze conversations, manage tasks, and search through chat history using advanced AI capabilities and natural language processing.\r\n\r\nThis agent can listen to all messages in a group chat (even without being @mentioned) using RSC (Resource Specific Control) permissions defined in [App Manifest](appPackage/manifest.json). For more details, see the documentation [RSC Documentation](https://staticsint.teams.cdn.office.net/evergreen-assets/safelinks/2/atp-safelinks.html).\r\n\r\n## Key Features\r\n\r\n- 📋 **Intelligent Summarization** - Analyze conversations and provide structured summaries with proper participant attribution and topic identification\r\n- ✅ **Action Items** - Automatically identify and create action items from team discussions with smart assignment\r\n- 🔍 **Conversation Search** - Search through chat history using natural language queries with time-based filtering and deep linking to original messages\r\n\r\n## Adding Custom Capabilities\r\n\r\nAdding your own capabilities only requires a few steps:\r\n\r\n1. Copy the template folder under capabilities [template](src\\capabilities\\template\\template.ts)\r\n2. Customize your capability to do what you want (helpful to look at existing capabilities)\r\n3. Make sure to create a CapabilityDefinition at the bottom of your main file\r\n4. Register your capability by importing the CapabilityDefinition and adding to the definition list in [registry](src\\capabilities\\registry.ts)\r\n5. The manager will automatically be instantiated with the capability you defined!\r\n\r\n## Agent Architecture\r\n\r\n\r\n\r\n## Flow of the Agent\r\n\r\n\r\n\r\nIf Collab Agent is added to a groupchat or private message, it will always listen and log each message to its database. The messages are stored in an SQLite DB by the conversation ID of the given conversation. \r\nThe agent will respond whenever @mentioned in groupchats and will always respond in 1-on-1 messages. When the agent responds, the request is first passed through a manger prompt.\r\nThis manager may route to a capability based on the request--this capability returns its result back to the manager where it will be passed back to the user.\r\n\r\n## Running the Sample\r\n\r\n### Prerequisites\r\n\r\n- [Node.js](https://nodejs.org/) version 20, 22\r\n- [npm](https://www.npmjs.com/) (comes with Node.js)\r\n- [Microsoft 365 Agents Toolkit](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension) for Visual Studio Code\r\n- [Visual Studio Code](https://code.visualstudio.com/)\r\n- A Microsoft Teams account with the ability to upload custom apps\r\n- Azure OpenAI resource with GPT-4 deployment\r\n\r\n### Environment Variables\r\n\r\nUpdate the `.env.*.user` file with your configuration:\r\n - `SECRET_AZURE_OPENAI_API_KEY`: Your Azure OpenAI API key\r\n - `AZURE_OPENAI_ENDPOINT`: Your Azure OpenAI endpoint URL\r\n - `AZURE_OPENAI_DEPLOYMENT_NAME`: Your GPT-4 model deployment name\r\n\r\n### Running the Bot\r\n\r\n> For local debugging using Microsoft 365 Agents Toolkit CLI, you need to do some extra steps described in [Set up your Microsoft 365 Agents Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).\r\n\r\n1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.\r\n2. Press F5 to start debugging which launches your app in Microsoft 365 Agents Playground using a web browser. Select `Debug in Microsoft 365 Agents Playground`.\r\n3. The browser will pop up to open Microsoft 365 Agents Playground.\r\n4. You will receive a welcome message from the agent, and you can send anything to the agent to get an response.\r\n5. @mention the bot in any conversation to start using its capabilities!\r\n\r\n#### Sample Questions\r\n\r\nYou can ask the Collaborator agent questions like:\r\n\r\n**Summarization:**\r\n- \"@Collaborator summarize yesterday's discussion\"\r\n- \"@Collaborator what were the main topics from last week?\"\r\n- \"@Collaborator give me an overview of recent messages\"\r\n\r\n**Action Items:**\r\n- \"@Collaborator find action items from the past 3 days\"\r\n- \"@Collaborator create a task to review the proposal by Friday\"\r\n- \"@Collaborator what tasks are assigned to me?\"\r\n\r\n**Search:**\r\n- \"@Collaborator find messages about the project deadline\"\r\n- \"@Collaborator search for conversations between Alice and Bob\"\r\n- \"@Collaborator locate discussions from this morning about the budget\"\r\n\r\n## Architecture\r\n\r\nThe Collaborator agent uses a sophisticated multi-capability architecture:\r\n\r\n- **Manager**: Coordinates between specialized capabilities and handles natural language time parsing\r\n- **Summarizer**: Analyzes conversation content and provides structured summaries\r\n- **Action Items**: Identifies tasks, manages assignments, and tracks completion\r\n- **Search**: Performs semantic search across conversation history with citation support\r\n- **Context Management**: Global message context handling for concurrent request support\r\n\r\n## Deployment\r\n\r\nThe agent can be deployed to Azure App Service for production use. See following documentation for detailed instructions on setting up Azure resources and configuring the production environment.\r\n- Host your app in Azure by [provision cloud resources](https://learn.microsoft.com/microsoftteams/platform/toolkit/provision) and [deploy the code to cloud](https://learn.microsoft.com/microsoftteams/platform/toolkit/deploy)\r\n- Azure SQL Database is used to store data, you can set admin password in `env/.env.dev.user`.\r\n\r\nIf you are trying to local debug / preview deployed version, then either of the two conditions must be met as a min-bar:\r\n1. The user doing the operation should be an admin in the org.\r\n2. The Entra app ID specified in webAppInfo.Id must be homed in the same tenant.\r\n",
|
|
456
|
+
"supportedLanguages": [
|
|
457
|
+
"typescript"
|
|
458
|
+
],
|
|
459
|
+
"templateIds": [
|
|
460
|
+
"teams-collaborator-agent-ts"
|
|
402
461
|
]
|
|
403
462
|
},
|
|
404
463
|
{
|
|
@@ -420,13 +479,15 @@
|
|
|
420
479
|
}
|
|
421
480
|
],
|
|
422
481
|
"templateName": "non-sso-tab",
|
|
423
|
-
"description": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Teams
|
|
424
|
-
"readme": "# Overview of the Basic Tab template\n\nThis template showcases how Microsoft Teams supports the ability to run web-based UI inside \"custom tabs\" that users can install either for just themselves (personal tabs) or within a team or group chat context.\n\n## Get started with the Basic Tab template\n\n> **Prerequisites**\n>\n> To run the basic tab template in your local dev machine, you will need:\n>\n> - [Node.js](https://nodejs.org/), supported versions: >=20.\n> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts)\n> Please note that after you enrolled your developer tenant in Office 365 Target Release, it may take couple days for the enrollment to take effect.\n> - [Microsoft 365 Agents Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 6.0.0 and higher or [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\n\n1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.\n2. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't already.\n3. Press F5 to start debugging which launches your app in Teams using a web browser. Select `Debug in Teams (Edge)` or `Debug in Teams (Chrome)`.\n4. When Teams launches in the browser, select the Add button in the dialog to install your app to Teams.\n\n**Congratulations**! You are running an application that can now show a basic web page in Teams, Outlook and the Microsoft 365 app.\n\n\n\n## What's included in the template\n\n| Folder | Contents |\n| ------------ | -------------------------------------------- |\n| `.vscode` | VSCode files for debugging |\n| `appPackage` | Templates for the application manifest |\n| `env` | Environment files |\n| `infra` | Templates for provisioning Azure resources |\n| `src` | The source code for the application |\n\nThe following files can be customized and demonstrate an example implementation to get you started.\n\n| File | Contents |\n| -------------------------------- | --------------------------------------------------------------------------------------------------------------- |\n| `index.html` | HTML file. |\n| `src/Tab/App.css` | CSS file for the app. |\n| `src/Tab/App.tsx` | Tab source file. It calls `teamsjs` SDK to get the context of on which Microsoft 365 application your app is running. |\n| `src/index.ts` | Starting the app using [Teams
|
|
482
|
+
"description": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Microsoft Teams SDK. - App that uses tab, bot and message extension - A simple implementation of a web app that's ready to customize",
|
|
483
|
+
"readme": "# Overview of the Basic Tab template\n\nThis template showcases how Microsoft Teams supports the ability to run web-based UI inside \"custom tabs\" that users can install either for just themselves (personal tabs) or within a team or group chat context.\n\n## Get started with the Basic Tab template\n\n> **Prerequisites**\n>\n> To run the basic tab template in your local dev machine, you will need:\n>\n> - [Node.js](https://nodejs.org/), supported versions: >=20.\n> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts)\n> Please note that after you enrolled your developer tenant in Office 365 Target Release, it may take couple days for the enrollment to take effect.\n> - [Microsoft 365 Agents Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 6.0.0 and higher or [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\n\n1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.\n2. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't already.\n3. Press F5 to start debugging which launches your app in Teams using a web browser. Select `Debug in Teams (Edge)` or `Debug in Teams (Chrome)`.\n4. When Teams launches in the browser, select the Add button in the dialog to install your app to Teams.\n\n**Congratulations**! You are running an application that can now show a basic web page in Teams, Outlook and the Microsoft 365 app.\n\n\n\n## What's included in the template\n\n| Folder | Contents |\n| ------------ | -------------------------------------------- |\n| `.vscode` | VSCode files for debugging |\n| `appPackage` | Templates for the application manifest |\n| `env` | Environment files |\n| `infra` | Templates for provisioning Azure resources |\n| `src` | The source code for the application |\n\nThe following files can be customized and demonstrate an example implementation to get you started.\n\n| File | Contents |\n| -------------------------------- | --------------------------------------------------------------------------------------------------------------- |\n| `index.html` | HTML file. |\n| `src/Tab/App.css` | CSS file for the app. |\n| `src/Tab/App.tsx` | Tab source file. It calls `teamsjs` SDK to get the context of on which Microsoft 365 application your app is running. |\n| `src/index.ts` | Starting the app using [Microsoft Teams SDK](https://microsoft.github.io/teams-ai). |\n| `vite.config.js` | Configuration for Vite build tool. | \n| `nodemon.json` | Configuration for Nodemon to watch and restart the server. |\n\nThe following are Microsoft 365 Agents Toolkit specific project files. You can [visit a complete guide on Github](https://github.com/OfficeDev/TeamsFx/wiki/Teams-Toolkit-Visual-Studio-Code-v5-Guide#overview) to understand how Microsoft 365 Agents Toolkit works.\n\n| File | Contents |\n| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| `m365agents.yml` | This is the main Microsoft 365 Agents Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions. |\n| `m365agents.local.yml` | This overrides `m365agents.yml` with actions that enable local execution and debugging. |\n\n## Extend the Basic Tab template\n\nFollowing documentation will help you to extend the Basic Tab template.\n\n- [Add or manage the environment](https://learn.microsoft.com/microsoftteams/platform/toolkit/teamsfx-multi-env)\n- [Create multi-capability app](https://learn.microsoft.com/microsoftteams/platform/toolkit/add-capability)\n- [Access data in Microsoft Graph](https://learn.microsoft.com/microsoftteams/platform/toolkit/teamsfx-sdk#microsoft-graph-scenarios)\n- [Use an existing Microsoft Entra application](https://learn.microsoft.com/microsoftteams/platform/toolkit/use-existing-aad-app)\n- [Customize the app manifest](https://learn.microsoft.com/microsoftteams/platform/toolkit/teamsfx-preview-and-customize-app-manifest)\n- Host your app in Azure by [provision cloud resources](https://learn.microsoft.com/microsoftteams/platform/toolkit/provision) and [deploy the code to cloud](https://learn.microsoft.com/microsoftteams/platform/toolkit/deploy)\n- [Collaborate on app development](https://learn.microsoft.com/microsoftteams/platform/toolkit/teamsfx-collaboration)\n- [Set up the CI/CD pipeline](https://learn.microsoft.com/microsoftteams/platform/toolkit/use-cicd-template)\n- [Publish the app to your organization or the Microsoft app store](https://learn.microsoft.com/microsoftteams/platform/toolkit/publish)\n- [Enable the app for multi-tenant](https://github.com/OfficeDev/TeamsFx/wiki/Multi-tenancy-Support-for-Azure-AD-app)\n- [Preview the app on mobile clients](https://aka.ms/teamsfx-mobile)\n",
|
|
425
484
|
"supportedLanguages": [
|
|
426
|
-
"typescript"
|
|
485
|
+
"typescript",
|
|
486
|
+
"python"
|
|
427
487
|
],
|
|
428
488
|
"templateIds": [
|
|
429
|
-
"basic-tab-ts"
|
|
489
|
+
"basic-tab-ts",
|
|
490
|
+
"basic-tab-python"
|
|
430
491
|
]
|
|
431
492
|
},
|
|
432
493
|
{
|
|
@@ -448,13 +509,15 @@
|
|
|
448
509
|
}
|
|
449
510
|
],
|
|
450
511
|
"templateName": "default-message-extension",
|
|
451
|
-
"description": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Teams
|
|
512
|
+
"description": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Microsoft Teams SDK. - App that uses tab, bot and message extension - Receive user input, process it, and send customized results",
|
|
452
513
|
"readme": "# Overview of Message Extensions template\n\nA Teams app that show cases three message extensions features:\n\n- action commands: allows users to interact with your app through buttons and forms in the compose message area in Microsoft Teams.\n- search commands: allows users to search for information or perform actions within the context of the message.\n- link unfurling: unfurls a link into an adaptive card when URLs with a particular domain are pasted into the compose message area in Microsoft Teams.\n\n## Get Started\n\n> **Prerequisites**\n>\n> - [Node.js](https://nodejs.org/), supported versions: 20, 22\n> - [Microsoft 365 Agents Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\n\n> For local debugging using Microsoft 365 Agents Toolkit CLI, you need to do some extra steps described in [Set up your Microsoft 365 Agents Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).\n\n1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.\n2. Press F5 to start debugging which launches your app in Microsoft 365 Agents Playground using a web browser.\n3. The browser will pop up to open Microsoft 365 Agents Playground.\n4. Click the \"+\" button in the input box, select \"Action Command\" and input \"createCard\" into \"Command Id\" field. Select \"Static list of parameters\" and then click \"Create\". Fill out the form and click `Submit` to send an adaptive card to the current chat or channel.\n5. Click the \"+\" button in the input box, select \"Search Command\" and input \"searchQuery\" into \"Command Id\" field. Input a search query. Select one of the search results to send an adaptive card to the current chat or channel.\n6. Click the \"+\" button in the input box, select \"Link Unfurling\" and paste a link ending with `.botframework.com`. You should see an adaptive card unfurled. Click `Send to Conversation` to send it to the current chat or channel.\n\n## What's included in the template\n\n| Folder / File | Contents |\n| --------------------------- | -------------------------------------------------------------------------------------------------------------------------- |\n| `m365agents.yml` | Main project file describes your application configuration and defines the set of actions to run in each lifecycle stages |\n| `m365agents.local.yml` | This overrides `m365agents.yml` with actions that enable local execution and debugging |\n| `m365agents.playground.yml` | This overrides `m365agents.yml` with actions that enable local execution and debugging in Microsoft 365 Agents Playground. |\n| `.vscode/` | VSCode files for local debug |\n| `src/` | The source code for the link unfurling application |\n| `appPackage/` | Templates for the application manifest |\n| `infra/` | Templates for provisioning Azure resources |\n\nThe following files can be customized and demonstrate an example implementation to get you started.\n\n| File | Contents |\n| -------------- | ------------------------------------- |\n| `src/index.ts` | Application entry point |\n| `src/card.ts` | Adaptive card creation and management |\n",
|
|
453
514
|
"supportedLanguages": [
|
|
454
|
-
"typescript"
|
|
515
|
+
"typescript",
|
|
516
|
+
"python"
|
|
455
517
|
],
|
|
456
518
|
"templateIds": [
|
|
457
|
-
"message-extension-v2-ts"
|
|
519
|
+
"message-extension-v2-ts",
|
|
520
|
+
"message-extension-v2-python"
|
|
458
521
|
]
|
|
459
522
|
},
|
|
460
523
|
{
|
|
@@ -476,15 +539,17 @@
|
|
|
476
539
|
}
|
|
477
540
|
],
|
|
478
541
|
"templateName": "default-bot",
|
|
479
|
-
"description": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Teams
|
|
480
|
-
"readme": "# Overview of the Basic Bot template\r\n\r\nExamples of Microsoft Teams bots in everyday use include:\r\n\r\n- Bots that notify about build failures.\r\n- Bots that provide information about the weather or bus schedules.\r\n- Bots that provide travel information.\r\n\r\nA bot interaction can be a quick question and answer, or it can be a complex conversation. Being a cloud application, a bot can provide valuable and secure access to cloud services and corporate resources. \r\nThis app template is built on top of [Teams
|
|
542
|
+
"description": "Create agent, chat bot, web pages or other apps in Microsoft Teams using Microsoft Teams SDK. - App that uses tab, bot and message extension - A simple implementation of an echo bot that's ready for customization",
|
|
543
|
+
"readme": "# Overview of the Basic Bot template\r\n\r\nExamples of Microsoft Teams bots in everyday use include:\r\n\r\n- Bots that notify about build failures.\r\n- Bots that provide information about the weather or bus schedules.\r\n- Bots that provide travel information.\r\n\r\nA bot interaction can be a quick question and answer, or it can be a complex conversation. Being a cloud application, a bot can provide valuable and secure access to cloud services and corporate resources. \r\nThis app template is built on top of [Microsoft Teams SDK](https://aka.ms/teams-ai-library-v2).\r\n## Get started with the Basic Bot template\r\n\r\n> **Prerequisites**\r\n>\r\n> To run the Basic Bot template in your local dev machine, you will need:\r\n>\r\n> - [Node.js](https://nodejs.org/), supported versions: 20, 22\r\n{{^enableTestToolByDefault}}\r\n> - A [Microsoft 365 account for development](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts)\r\n{{/enableTestToolByDefault}}\r\n> - [Microsoft 365 Agents Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Microsoft 365 Agents Toolkit CLI](https://aka.ms/teamsfx-toolkit-cli)\r\n\r\n> For local debugging using Microsoft 365 Agents Toolkit CLI, you need to do some extra steps described in [Set up your Microsoft 365 Agents Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).\r\n\r\n1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.\r\n{{#enableTestToolByDefault}}\r\n2. Press F5 to start debugging which launches your app in Microsoft 365 Agents Playground using a web browser. Select `Debug in Microsoft 365 Agents Playground`.\r\n3. The browser will pop up to open Microsoft 365 Agents Playground.\r\n4. You will receive a welcome message from the bot, and you can send anything to the bot to get an echoed response.\r\n\r\n**Congratulations**! You are running an application that can now interact with users in Microsoft 365 Agents Playground:\r\n\r\n\r\n\r\n{{/enableTestToolByDefault}}\r\n{{^enableTestToolByDefault}}\r\n2. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't already.\r\n3. Press F5 to start debugging which launches your app in Teams using a web browser. Select `Debug in Teams (Edge)` or `Debug in Teams (Chrome)`.\r\n4. When Teams launches in the browser, select the Add button in the dialog to install your app to Teams.\r\n5. You will receive a welcome message from the bot, and you can send anything to the bot to get an echoed response.\r\n\r\n**Congratulations**! You are running an application that can now interact with users in Teams:\r\n\r\n\r\n{{/enableTestToolByDefault}}\r\n\r\n## What's included in the template\r\n\r\n| Folder | Contents |\r\n| - | - |\r\n| `.vscode` | VSCode files for debugging |\r\n| `appPackage` | Templates for the application manifest |\r\n| `env` | Environment files |\r\n| `infra` | Templates for provisioning Azure resources |\r\n\r\nThe following files can be customized and demonstrate an example implementation to get you started.\r\n\r\n| File | Contents |\r\n| - | - |\r\n|`app.ts`| Handles business logics for the echo bot.|\r\n|`index.ts`|`index.ts` is used to setup and configure the echo bot.|\r\n\r\nThe following are Microsoft 365 Agents Toolkit specific project files. You can [visit a complete guide on Github](https://github.com/OfficeDev/TeamsFx/wiki/Teams-Toolkit-Visual-Studio-Code-v5-Guide#overview) to understand how Microsoft 365 Agents Toolkit works.\r\n\r\n| File | Contents |\r\n| - | - |\r\n|`m365agents.yml`|This is the main Microsoft 365 Agents Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions. |\r\n|`m365agents.local.yml`|This overrides `m365agents.yml` with actions that enable local execution and debugging.|\r\n|`m365agents.playground.yml`| This overrides `m365agents.yml` with actions that enable local execution and debugging in Microsoft 365 Agents Playground.|\r\n\r\n## Extend the Basic Bot template\r\n\r\nFollowing documentation will help you to extend the Basic Bot template.\r\n\r\n- [Add or manage the environment](https://learn.microsoft.com/microsoftteams/platform/toolkit/teamsfx-multi-env)\r\n- [Create multi-capability app](https://learn.microsoft.com/microsoftteams/platform/toolkit/add-capability)\r\n- [Add single sign on to your app](https://learn.microsoft.com/microsoftteams/platform/toolkit/add-single-sign-on)\r\n- [Access data in Microsoft Graph](https://learn.microsoft.com/microsoftteams/platform/toolkit/teamsfx-sdk#microsoft-graph-scenarios)\r\n- [Use an existing Microsoft Entra application](https://learn.microsoft.com/microsoftteams/platform/toolkit/use-existing-aad-app)\r\n- [Customize the app manifest](https://learn.microsoft.com/microsoftteams/platform/toolkit/teamsfx-preview-and-customize-app-manifest)\r\n- Host your app in Azure by [provision cloud resources](https://learn.microsoft.com/microsoftteams/platform/toolkit/provision) and [deploy the code to cloud](https://learn.microsoft.com/microsoftteams/platform/toolkit/deploy)\r\n- [Collaborate on app development](https://learn.microsoft.com/microsoftteams/platform/toolkit/teamsfx-collaboration)\r\n- [Set up the CI/CD pipeline](https://learn.microsoft.com/microsoftteams/platform/toolkit/use-cicd-template)\r\n- [Publish the app to your organization or the Microsoft app store](https://learn.microsoft.com/microsoftteams/platform/toolkit/publish)\r\n- [Develop with Microsoft 365 Agents Toolkit CLI](https://aka.ms/teams-toolkit-cli/debug)\r\n- [Preview the app on mobile clients](https://aka.ms/teamsfx-mobile)\r\n",
|
|
481
544
|
"supportedLanguages": [
|
|
482
545
|
"typescript",
|
|
483
|
-
"javascript"
|
|
546
|
+
"javascript",
|
|
547
|
+
"python"
|
|
484
548
|
],
|
|
485
549
|
"templateIds": [
|
|
486
550
|
"default-bot-ts",
|
|
487
|
-
"default-bot-js"
|
|
551
|
+
"default-bot-js",
|
|
552
|
+
"default-bot-python"
|
|
488
553
|
]
|
|
489
554
|
},
|
|
490
555
|
{
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|