From bd98bc603cd1c1a9ff88882a1648e1671a4ab53d Mon Sep 17 00:00:00 2001 From: Ricky Kirkham Date: Mon, 10 Nov 2025 15:38:50 -0800 Subject: [PATCH 1/2] [All Hosts] (copilot) the 'auth' property is really required now --- docs/design/agent-and-add-in-overview.md | 12 +++++++----- docs/develop/agent-and-add-in.md | 8 +++++--- docs/includes/auth-property-warning-note.md | 2 -- docs/quickstarts/agent-and-add-in-quickstart.md | 9 +++++---- 4 files changed, 17 insertions(+), 14 deletions(-) delete mode 100644 docs/includes/auth-property-warning-note.md diff --git a/docs/design/agent-and-add-in-overview.md b/docs/design/agent-and-add-in-overview.md index 90d11be18..fa717022b 100644 --- a/docs/design/agent-and-add-in-overview.md +++ b/docs/design/agent-and-add-in-overview.md @@ -1,7 +1,7 @@ --- title: Combine Copilot Agents with Office Add-ins (preview) description: Get an overview of why and how to combine a Copilot agent with an Office Add-in. -ms.date: 10/17/2025 +ms.date: 11/11/2025 ms.topic: overview ms.localizationpriority: medium --- @@ -141,8 +141,6 @@ The agent configuration file includes instructions for the agent and specifies o } ``` -[!INCLUDE [Validation warning about missing 'auth' property](../includes/auth-property-warning-note.md)] - The reference documentation for declarative agents is at [Declarative agent schema 1.5 for Microsoft 365 Copilot](/microsoft-365-copilot/extensibility/declarative-agent-manifest-1.5). ### Copilot API plug-in configuration @@ -154,7 +152,8 @@ The API plug-in configuration file specifies the "functions" of the plug-in in t - The `"responding.instructions"` property only provides *guidance* to Copilot about how to respond. It doesn't put any limits or structural requirements on the response. - The `"runtimes.run_for_functions"` array must include either the same string as `"functions.name"` or a wildcard string that matches it. - The `"runtimes.spec.local_endpoint"` property specifies that the JavaScript function that is associated with the "fillcolor" string is available in an Office Add-in, rather than in some REST endpoint. --The `"runtimes.spec.allowed_host"` property specifies that the agent should only be visible in Excel. +- The `"runtimes.spec.allowed_host"` property specifies that the agent should only be visible in Excel. +- The `"runtimes.auth.type"` property is always "None" for Office Add-in agents. ```json { @@ -206,7 +205,10 @@ The API plug-in configuration file specifies the "functions" of the plug-in in t "local_endpoint": "Microsoft.Office.Addin", "allowed_host": ["workbook"] }, - "run_for_functions": ["fillcolor"] + "run_for_functions": ["fillcolor"], + "auth": { + "type": "None" + } } ] } diff --git a/docs/develop/agent-and-add-in.md b/docs/develop/agent-and-add-in.md index 6840c4f06..2466145cb 100644 --- a/docs/develop/agent-and-add-in.md +++ b/docs/develop/agent-and-add-in.md @@ -191,8 +191,6 @@ The runtime object should look similar to the following. There may be other prop } ``` - [!INCLUDE [Validation warning about missing 'auth' property](../includes/auth-property-warning-note.md)] - 1. *Replace the property values with new values that are appropriate for your add-in.* For more information about these properties, see [Declarative agent manifest object](/microsoft-365-copilot/extensibility/declarative-agent-manifest-1.2#declarative-agent-manifest-object). > [!NOTE] @@ -251,7 +249,10 @@ The runtime object should look similar to the following. There may be other prop "local_endpoint": "Microsoft.Office.Addin", "allowed_host": ["workbook"] }, - "run_for_functions": ["FillColor"] + "run_for_functions": ["FillColor"], + "auth": { + "type": "None" + } } ] } @@ -270,6 +271,7 @@ The runtime object should look similar to the following. There may be other prop - The `"runtimes.run_for_functions"` array must include either the same string as `"functions.name"` or a wildcard string that matches it. - The `"reasoning.description"` and `"reasoning.instructions"` refer to a JavaScript function, not a REST API. - The `"runtimes.spec.local_endpoint"` property tells the Copilot agent to look for functions in an Office Add-in instead of at a REST service URL. + - The `"runtimes.auth.type"` property is always "None" for Office Add-in agents. ### Create the app package diff --git a/docs/includes/auth-property-warning-note.md b/docs/includes/auth-property-warning-note.md deleted file mode 100644 index dd49e8c18..000000000 --- a/docs/includes/auth-property-warning-note.md +++ /dev/null @@ -1,2 +0,0 @@ -> [!NOTE] -> You may get a validation error from the plugin JSON that says you need an "auth" property. You should ignore this error. Your agent will work fine without that property. \ No newline at end of file diff --git a/docs/quickstarts/agent-and-add-in-quickstart.md b/docs/quickstarts/agent-and-add-in-quickstart.md index 0b4000558..6d5c0b167 100644 --- a/docs/quickstarts/agent-and-add-in-quickstart.md +++ b/docs/quickstarts/agent-and-add-in-quickstart.md @@ -1,7 +1,7 @@ --- title: Build your first add-in as a Copilot skill description: Learn how to build a simple Copilot agent that has an Excel add-in as a skill. -ms.date: 10/23/2025 +ms.date: 11/11/2025 ms.topic: how-to ms.service: microsoft-365 ms.localizationpriority: high @@ -160,14 +160,15 @@ Add the agent with the following steps. "local_endpoint": "Microsoft.Office.Addin", "allowed_host": ["workbook"] }, - "run_for_functions": ["fillcolor"] + "run_for_functions": ["fillcolor"], + "auth": { + "type": "None" + } } ] } ``` - [!INCLUDE [Validation warning about missing 'auth' property](../includes/auth-property-warning-note.md)] - 1. Open the **\src\commands\commands.ts** file and add the following code the end of it. ```javascript From dc1f3c067555f49c2bc276b72d59033ed5be7a8e Mon Sep 17 00:00:00 2001 From: Ricky Kirkham Date: Mon, 10 Nov 2025 15:39:41 -0800 Subject: [PATCH 2/2] date --- docs/develop/agent-and-add-in.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/develop/agent-and-add-in.md b/docs/develop/agent-and-add-in.md index 2466145cb..72f18a1c4 100644 --- a/docs/develop/agent-and-add-in.md +++ b/docs/develop/agent-and-add-in.md @@ -1,7 +1,7 @@ --- title: Add a Copilot agent to an add-in description: Learn how to add a Copilot agent to an add-in. -ms.date: 10/17/2025 +ms.date: 11/11/2025 ms.topic: how-to ms.service: microsoft-365 ms.localizationpriority: medium