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
# Overview of the Declarative Agent with TypeSpec for Microsoft 365 template
1
+
# Repair Service Agent - Microsoft 365 Copilot Declarative Agent
2
2
3
-
With 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.
3
+
The Repair Service Agent is a specialized Microsoft 365 Copilot declarative agent designed to help users manage car repair records and maintenance tasks. This agent provides an intuitive interface for tracking repairs, generating reports, and maintaining service history through natural language interactions.
4
4
5
-
## Get started with the template
5
+
## Features
6
+
7
+
The Repair Service Agent provides the following capabilities:
8
+
9
+
### Core Functionality
10
+
-**Repair Management**: Create, update, and delete repair records
11
+
-**Repair Tracking**: List and search repair records by assigned user
12
+
-**Report Generation**: Use code interpreter to generate reports based on repair data
13
+
-**Visual Cards**: Display repair information in rich adaptive cards with images
14
+
15
+
### Repair Record Fields
16
+
Each repair record includes:
17
+
-**Title**: Short summary of the repair
18
+
-**Description**: Detailed description of the repair work
19
+
-**Assigned To**: User responsible for the repair
20
+
-**Date**: Scheduled or completion date (ISO 8601 format)
21
+
-**Image**: URL to associated repair images
22
+
23
+
### Conversation Starters
24
+
- "List all repairs" - View all repair records
25
+
- "Create a new repair titled '[repair name]' and assign it to me" - Quick repair creation
26
+
27
+
### Integration
28
+
- Connects to the Repairs API at `https://repairshub.azurewebsites.net`
29
+
- Displays rich adaptive cards with repair details and images
30
+
- Supports natural language interactions for all repair operations
31
+
32
+
## Get started with the Repair Service Agent
6
33
7
34
> **Prerequisites**
8
35
>
@@ -13,51 +40,82 @@ With the declarative agent, you can build a custom version of Copilot that can b
13
40
> -[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)
1. First, select the Microsoft 365 Agents Toolkit icon on the left in the VS Code toolbar.
19
46
2. In the Account section, sign in with your [Microsoft 365 account](https://docs.microsoft.com/microsoftteams/platform/toolkit/accounts) if you haven't already.
20
47
3. Run `npm install` to install dependencies before working with TypeSpec files.
21
48
4. Update the [`main.tsp`](./main.tsp) to configure your agent and its plugins. This is the default entry point for TypeSpec files.
22
49
5. Create app by clicking `Provision` in "Lifecycle" section.
23
50
6. Select `Preview in Copilot (Edge)` or `Preview in Copilot (Chrome)` from the launch configuration dropdown.
24
-
7. Once the Copilot agent is loaded in the browser, click on the "…" menu and select "Copilot chats". You will see your declarative agent on the right rail. Clicking on it will change the experience to showcase the logo and name of your declarative agent.
25
-
8. Ask a question to your declarative agent and it should respond based on the instructions provided.
51
+
7. Once the Copilot agent is loaded in the browser, click on the "…" menu and select "Copilot chats". You will see the Repair Service Agent on the right rail. Clicking on it will change the experience to showcase the repair service branding.
52
+
8. Try these example interactions with your repair service agent:
53
+
- "List all repairs"
54
+
- "Create a new repair for oil change and assign it to John"
|`appPackage/manifest.json`| application manifest that defines metadata for your declarative agent. |
71
+
|`appPackage/manifest.json`| Application manifest defining the Repair Service Agent metadata |
72
+
|`appPackage/cards/repair.json`| Adaptive card template for displaying repair records with images |
40
73
41
-
The 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.
74
+
The following are Microsoft 365 Agents Toolkit specific project files:
|`m365agents.yml`|This is the main Microsoft 365 Agents Toolkit project file. The project file defines two primary things: Properties and configuration Stage definitions.|
78
+
|`m365agents.yml`|Main Microsoft 365 Agents Toolkit project configuration file with properties and stage definitions |
46
79
47
-
The following are TypeSpec template files. You need to customize these files to configure your agent.
80
+
The following are TypeSpec files that define the repair service functionality:
|`main.tsp`| This is the root file of TSP files. Please manually update this file to add your own agent. |
52
-
|`actions.tsp`| This is the actions file containing API endpoints to extend your declarative agent. |
84
+
|`main.tsp`| Root TypeSpec file defining the Repair Service Agent with instructions and conversation starters |
85
+
|`actions.tsp`| API endpoints and data models for repair operations (CRUD operations for repair records) |
86
+
87
+
88
+
### Advanced Features
89
+
-[Add web content search](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=4) for repair documentation
90
+
-[Integrate OneDrive/SharePoint](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=5) for repair manuals and documentation
91
+
-[Add Microsoft Copilot Connectors](https://learn.microsoft.com/microsoft-365-copilot/extensibility/build-declarative-agents?tabs=ttk&tutorial-step=6) for enterprise repair management systems
92
+
93
+
## API Reference
94
+
95
+
The Repair Service Agent uses the following API endpoints:
53
96
54
-
## Extend the template
97
+
### Repair Operations
98
+
-**GET /repairs**: List all repairs (optionally filtered by `assignedTo`)
99
+
-**POST /repairs**: Create a new repair record
100
+
-**PATCH /repairs**: Update an existing repair record
101
+
-**DELETE /repairs**: Delete a repair record
55
102
56
-
-[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.
57
-
-[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.
58
-
-[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.
59
-
-[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.
103
+
### Repair Data Model
104
+
```typescript
105
+
{
106
+
id?:string; // Unique identifier (auto-generated)
107
+
title: string; // Required: Short summary
108
+
description?:string; // Detailed description
109
+
assignedTo?:string; // User assigned to repair
110
+
date?:string; // ISO 8601 date-time format
111
+
image?:string; // URL to repair image
112
+
}
113
+
```
60
114
61
-
## Addition information and references
115
+
## Additional Information and References
62
116
63
117
-[Declarative agents for Microsoft 365](https://aka.ms/teams-toolkit-declarative-agent)
0 commit comments