Skip to content

Commit 6c9dfab

Browse files
[All Hosts] (copilot) various technical changes (#5277)
* various technical changes * Update docs/quickstarts/agent-and-add-in-quickstart.md Co-authored-by: Elizabeth Samuel <[email protected]> --------- Co-authored-by: Elizabeth Samuel <[email protected]>
1 parent aaa3afa commit 6c9dfab

File tree

3 files changed

+24
-30
lines changed

3 files changed

+24
-30
lines changed

docs/design/agent-and-add-in-overview.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Combine Copilot Agents with Office Add-ins (preview)
33
description: Get an overview of why and how to combine a Copilot agent with an Office Add-in.
4-
ms.date: 06/10/2025
4+
ms.date: 07/15/2025
55
ms.topic: overview
66
ms.localizationpriority: medium
77
---
@@ -141,18 +141,18 @@ The agent configuration file includes instructions for the agent and specifies o
141141
}
142142
```
143143

144-
The reference documentation for declarative agents is at [Declarative agent schema 1.3 for Microsoft 365 Copilot](/microsoft-365-copilot/extensibility/declarative-agent-manifest-1.3).
144+
The reference documentation for declarative agents is at [Declarative agent schema 1.4 for Microsoft 365 Copilot](/microsoft-365-copilot/extensibility/declarative-agent-manifest-1.4).
145145

146146
### Copilot API plug-in configuration
147147

148148
The API plug-in configuration file specifies the "functions" of the plug-in in the sense of agent actions, not JavaScript functions, including the instructions for the action. It also configures the JavaScript runtime for Copilot. The following is an example. About this JSON, note the following:
149149

150150
- The `"functions.name"` must match the `"extensions.runtimes.actions.id"` property in the add-in manifest.
151151
- The `"reasoning.description"` and `"reasoning.instructions"` refer to a JavaScript function, not a REST API.
152-
- 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.
152+
- 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.
153153
- The `"runtimes.run_for_functions"` array must include either the same string as `"functions.name"` or a wildcard string that matches it.
154-
- The `"runtimes.spec.local_endpoint"` property is new and isn't yet in the main reference documentation for the API plugins schema. See below for more about it. In this case, it 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.
155-
-The `"runtimes.spec.allowed_host"` property is new and isn't yet in the main reference documentation for the API plugins schema. See below for more about it. In this case, it specifies that the agent should only be visible in Excel.
154+
- 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.
155+
-The `"runtimes.spec.allowed_host"` property specifies that the agent should only be visible in Excel.
156156

157157
```json
158158
{
@@ -168,18 +168,18 @@ The API plug-in configuration file specifies the "functions" of the plug-in in t
168168
"parameters": {
169169
"type": "object",
170170
"properties": {
171-
"Cell": {
171+
"cell": {
172172
"type": "string",
173173
"description": "A cell location in the format of A1, B2, etc.",
174174
"default" : "B2"
175175
},
176-
"Color": {
176+
"color": {
177177
"type": "string",
178178
"description": "A color in hex format, e.g., #30d5c8",
179179
"default" : "#30d5c8"
180180
}
181181
},
182-
"required": ["Cell", "Color"]
182+
"required": ["cell", "color"]
183183
},
184184
"returns": {
185185
"type": "string",
@@ -210,12 +210,7 @@ The API plug-in configuration file specifies the "functions" of the plug-in in t
210210
}
211211
```
212212

213-
The reference documentation for API plug-ins is at [API plugin manifest schema 2.3 for Microsoft 365 Copilot](/microsoft-365-copilot/extensibility/api-plugin-manifest-2.3). The following is the documentation for two new properties of the `"runtimes.spec"` property.
214-
215-
| Property | Type | Description |
216-
| -------- | ---- | ----------- |
217-
| `local_endpoint` | String | Optional. The ID of a set of available JavaScript functions. This property is roughly analogous to the [`"runtimes.spec.url"`](/microsoft-365-copilot/extensibility/api-plugin-manifest-2.3#openapi-specification-object) property, but for local functions on the client, not REST APIs. Currently, the only allowed value is "Microsoft.Office.Addin".|
218-
| `allowed_host` | String | Optional. Specifies which Office application Copilots can host the agent. Possible values are "document", "mail", "presentation", and "workbook".|
213+
The reference documentation for API plug-ins is at [API plugin manifest schema 2.3 for Microsoft 365 Copilot](/microsoft-365-copilot/extensibility/api-plugin-manifest-2.3).
219214

220215
## Create the JavaScript functions
221216

docs/develop/agent-and-add-in.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Add a Copilot agent to an add-in
33
description: Learn how to add a Copilot agent to an add-in.
4-
ms.date: 06/10/2025
4+
ms.date: 07/15/2025
55
ms.topic: how-to
66
ms.service: microsoft-365
77
ms.localizationpriority: medium
@@ -86,7 +86,7 @@ Office.onReady(function() {
8686
});
8787

8888
async function fillColorFromUserData(message) {
89-
const {Cell: cell, Color: color} = JSON.parse(message);
89+
const {cell, color} = JSON.parse(message);
9090
await Excel.run(async (context) => {
9191
context.workbook.worksheets
9292
.getActiveWorksheet()
@@ -213,18 +213,18 @@ The runtime object should look similar to the following. There may be other prop
213213
"parameters": {
214214
"type": "object",
215215
"properties": {
216-
"Cell": {
216+
"cell": {
217217
"type": "string",
218218
"description": "A cell location in the format of A1, B2, etc.",
219219
"default" : "B2"
220220
},
221-
"Color": {
221+
"color": {
222222
"type": "string",
223223
"description": "A color in hex format, e.g., #30d5c8",
224224
"default" : "#30d5c8"
225225
}
226226
},
227-
"required": ["Cell", "Color"]
227+
"required": ["cell", "color"]
228228
},
229229
"returns": {
230230
"type": "string",
@@ -267,7 +267,7 @@ The runtime object should look similar to the following. There may be other prop
267267

268268
- The `"runtimes.run_for_functions"` array must include either the same string as `"functions.name"` or a wildcard string that matches it.
269269
- The `"reasoning.description"` and `"reasoning.instructions"` refer to a JavaScript function, not a REST API.
270-
- The `"runtimes.spec.local_endpoint"` property is new and isn't yet in the main reference documentation for the API plugins schema. See below for more about it. It tells the Copilot agent to look for functions in an Office Add-in instead of at a REST service URL.
270+
- 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.
271271

272272
### Create the app package
273273

@@ -324,7 +324,7 @@ In a command prompt or Visual Studio Code **TERMINAL** in the root of the projec
324324
- With Copilot open to the list of agents, click the cursor on the Copilot window and press <kbd>Ctrl</kbd>+<kbd>R</kbd>.
325325

326326
:::image type="content" source="../images/copilot-agent-list.png" alt-text="A screenshot of the agent list in the Copilot pane in an Office application":::
327-
327+
328328
1. When the agent is listed, select it and the pane for the agent opens. The conversation starters you configured in the `"conversation_starters"` property of declarative agent configuration file will be displayed.
329329
1. Select a conversation starter, and then press the **Send** control in the conversation box at the bottom of the pane. Select **Confirm** in response to the confirmation prompt. The agent action occurs.
330330
1. Try entering prompts the conversation box that are different from the conversation starters, but that your agent should be able to do.

docs/quickstarts/agent-and-add-in-quickstart.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Build your first add-in as a Copilot skill
33
description: Learn how to build a simple Copilot agent that has an Excel add-in as a skill.
4-
ms.date: 06/10/2025
4+
ms.date: 07/15/2025
55
ms.topic: how-to
66
ms.service: microsoft-365
77
ms.localizationpriority: high
@@ -20,11 +20,11 @@ In this article, you'll walk through the process of building a simple Excel Copi
2020
## Software prerequisites
2121

2222
- All the prerequisites listed at [Create declarative agents using Microsoft 365 Agent Toolkit](/microsoft-365-copilot/extensibility/build-declarative-agents).
23-
- The [Microsoft 365 Agent Toolkit](../develop/teams-toolkit-overview.md).
23+
- The [Microsoft 365 Agent Toolkit](../develop/teams-toolkit-overview.md).
2424

2525
## Start with an Office Add-in
2626

27-
Create a basic Excel add-in with the following steps.
27+
Create a basic Excel add-in with the following steps.
2828

2929
1. Create an Office Add-in in Microsoft 365 Agent Toolkit by following the instructions in [Create Office Add-in projects with Microsoft 365 Agent Toolkit](../develop/teams-toolkit-overview.md#create-an-office-add-in-project). *Stop after the project is created. Don't carry out the steps in the sideloading section.*
3030

@@ -124,18 +124,18 @@ Add the agent with the following steps.
124124
"parameters": {
125125
"type": "object",
126126
"properties": {
127-
"Cell": {
127+
"cell": {
128128
"type": "string",
129129
"description": "A cell location in the format of A1, B2, etc.",
130130
"default" : "B2"
131131
},
132-
"Color": {
132+
"color": {
133133
"type": "string",
134134
"description": "A color in hex format, e.g., #30d5c8",
135135
"default" : "#30d5c8"
136136
}
137137
},
138-
"required": ["Cell", "Color"]
138+
"required": ["cell", "color"]
139139
},
140140
"returns": {
141141
"type": "string",
@@ -180,7 +180,7 @@ Add the agent with the following steps.
180180

181181
Office.onReady((info) => {
182182
Office.actions.associate("fillcolor", async (message) => {
183-
const {Cell: cell, Color: color} = JSON.parse(message);
183+
const {cell, color} = JSON.parse(message);
184184
await fillcolor(cell, color);
185185
return "Cell color changed.";
186186
});
@@ -290,7 +290,7 @@ Add the agent with the following steps.
290290
1. In a command prompt or Visual Studio Code **TERMINAL** in the root of the project, run `npm run dev-server` to start the server on localhost. Wait until you see a line in the server window that the app compiled successfully. This means the server is running and serving the files.
291291
292292
> [!NOTE]
293-
> If this is the first time inover a month you have run a local server for an Office Add-in on your computer, you may be prompted to delete an old certificate and/or to install a new one. Agree to both prompts.
293+
> If this is the first time in over a month you have run a local server for an Office Add-in on your computer, you may be prompted to delete an old certificate and to install a new one. Agree to both prompts.
294294
295295
1. The first step in testing depends on the platform.
296296
@@ -302,7 +302,6 @@ Add the agent with the following steps.
302302
- Wait a few minutes and reload Copilot.
303303
- With Copilot open to the list of agents, click the cursor on the Copilot window and press <kbd>Ctrl</kbd>+<kbd>R</kbd>.
304304
305-
306305
1. When the agent is listed, select it. The **Excel Add-in + Agent** pane opens.
307306
1. Select the **Change cell color** conversation starter, and then press the **Send** control in the conversation box at the bottom of the pane. Select **Confirm** in response to the confirmation prompt. The cell's color should change.
308307

0 commit comments

Comments
 (0)