You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[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]>
Copy file name to clipboardExpand all lines: docs/design/agent-and-add-in-overview.md
+9-14Lines changed: 9 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Combine Copilot Agents with Office Add-ins (preview)
3
3
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
5
5
ms.topic: overview
6
6
ms.localizationpriority: medium
7
7
---
@@ -141,18 +141,18 @@ The agent configuration file includes instructions for the agent and specifies o
141
141
}
142
142
```
143
143
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).
145
145
146
146
### Copilot API plug-in configuration
147
147
148
148
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:
149
149
150
150
- The `"functions.name"` must match the `"extensions.runtimes.actions.id"` property in the add-in manifest.
151
151
- 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.
153
153
- 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.
156
156
157
157
```json
158
158
{
@@ -168,18 +168,18 @@ The API plug-in configuration file specifies the "functions" of the plug-in in t
168
168
"parameters": {
169
169
"type": "object",
170
170
"properties": {
171
-
"Cell": {
171
+
"cell": {
172
172
"type": "string",
173
173
"description": "A cell location in the format of A1, B2, etc.",
174
174
"default" : "B2"
175
175
},
176
-
"Color": {
176
+
"color": {
177
177
"type": "string",
178
178
"description": "A color in hex format, e.g., #30d5c8",
179
179
"default" : "#30d5c8"
180
180
}
181
181
},
182
-
"required": ["Cell", "Color"]
182
+
"required": ["cell", "color"]
183
183
},
184
184
"returns": {
185
185
"type": "string",
@@ -210,12 +210,7 @@ The API plug-in configuration file specifies the "functions" of the plug-in in t
210
210
}
211
211
```
212
212
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).
@@ -213,18 +213,18 @@ The runtime object should look similar to the following. There may be other prop
213
213
"parameters": {
214
214
"type": "object",
215
215
"properties": {
216
-
"Cell": {
216
+
"cell": {
217
217
"type": "string",
218
218
"description": "A cell location in the format of A1, B2, etc.",
219
219
"default" : "B2"
220
220
},
221
-
"Color": {
221
+
"color": {
222
222
"type": "string",
223
223
"description": "A color in hex format, e.g., #30d5c8",
224
224
"default" : "#30d5c8"
225
225
}
226
226
},
227
-
"required": ["Cell", "Color"]
227
+
"required": ["cell", "color"]
228
228
},
229
229
"returns": {
230
230
"type": "string",
@@ -267,7 +267,7 @@ The runtime object should look similar to the following. There may be other prop
267
267
268
268
- The `"runtimes.run_for_functions"` array must include either the same string as `"functions.name"` or a wildcard string that matches it.
269
269
- 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.
271
271
272
272
### Create the app package
273
273
@@ -324,7 +324,7 @@ In a command prompt or Visual Studio Code **TERMINAL** in the root of the projec
324
324
- With Copilot open to the list of agents, click the cursor on the Copilot window and press <kbd>Ctrl</kbd>+<kbd>R</kbd>.
325
325
326
326
:::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
+
328
328
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.
329
329
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.
330
330
1. Try entering prompts the conversation box that are different from the conversation starters, but that your agent should be able to do.
Copy file name to clipboardExpand all lines: docs/quickstarts/agent-and-add-in-quickstart.md
+8-9Lines changed: 8 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Build your first add-in as a Copilot skill
3
3
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
5
5
ms.topic: how-to
6
6
ms.service: microsoft-365
7
7
ms.localizationpriority: high
@@ -20,11 +20,11 @@ In this article, you'll walk through the process of building a simple Excel Copi
20
20
## Software prerequisites
21
21
22
22
- 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).
24
24
25
25
## Start with an Office Add-in
26
26
27
-
Create a basic Excel add-in with the following steps.
27
+
Create a basic Excel add-in with the following steps.
28
28
29
29
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.*
30
30
@@ -124,18 +124,18 @@ Add the agent with the following steps.
124
124
"parameters": {
125
125
"type": "object",
126
126
"properties": {
127
-
"Cell": {
127
+
"cell": {
128
128
"type": "string",
129
129
"description": "A cell location in the format of A1, B2, etc.",
130
130
"default" : "B2"
131
131
},
132
-
"Color": {
132
+
"color": {
133
133
"type": "string",
134
134
"description": "A color in hex format, e.g., #30d5c8",
135
135
"default" : "#30d5c8"
136
136
}
137
137
},
138
-
"required": ["Cell", "Color"]
138
+
"required": ["cell", "color"]
139
139
},
140
140
"returns": {
141
141
"type": "string",
@@ -180,7 +180,7 @@ Add the agent with the following steps.
@@ -290,7 +290,7 @@ Add the agent with the following steps.
290
290
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.
291
291
292
292
> [!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.
294
294
295
295
1. The first step in testing depends on the platform.
296
296
@@ -302,7 +302,6 @@ Add the agent with the following steps.
302
302
- Wait a few minutes and reload Copilot.
303
303
- With Copilot open to the list of agents, click the cursor on the Copilot window and press <kbd>Ctrl</kbd>+<kbd>R</kbd>.
304
304
305
-
306
305
1. When the agent is listed, select it. The **Excel Add-in + Agent** pane opens.
307
306
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.
0 commit comments