Skip to content

Commit 93f006e

Browse files
committed
docs: update readme
1 parent f9a7611 commit 93f006e

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
⭐ If you like this sample, star it on GitHub — it helps a lot!
1616

17-
[Overview](#overview)[Architecture](#architecture)[Getting started](#getting-started)[Local development](#local-development)[MCP tools](#mcp-tools)[Deploy to Azure](#deploy-to-azure)[Resources](#resources)[Troubleshooting](#troubleshooting)
17+
[Overview](#overview)[Architecture](#architecture)[Getting started](#getting-started)[MCP tools](#mcp-tools)[Deploy to Azure](#deploy-to-azure)[Resources](#resources)[Troubleshooting](#troubleshooting)
1818

1919
![Animation showing the agent in action](./docs/images/demo.gif)
2020

@@ -107,7 +107,7 @@ Then you can get the project code:
107107

108108
</details>
109109

110-
## Local development
110+
### Local development
111111

112112
After setting up your environment, you can run the entire application locally:
113113

@@ -140,9 +140,11 @@ You can then open the Agent web app and ask things like:
140140

141141
The agent will decide which MCP tool(s) to call, then come up with a response.
142142

143-
### Available scripts
143+
#### Available scripts
144144

145-
Common scripts (run from repo root unless noted):
145+
This project uses [npm workspaces](https://docs.npmjs.com/cli/v9/using-npm/workspaces) to manage multiple packages in a single repository. You can run scripts from the root folder that will apply to all packages, or you can run scripts for individual packages as indicated in their respective README files.
146+
147+
Common scripts (run from repo root):
146148

147149
| Action | Command |
148150
|--------|---------|
@@ -220,7 +222,7 @@ To use the MCP server in local mode with GitHub Copilot, create a local `.vscode
220222
}
221223
```
222224

223-
Make sure that you have the Burger services running locally by running `npm start` in the project root.
225+
If you open that file
224226

225227
Then, you can use GitHub Copilot in **agent mode** to interact with the MCP server. For example, you can ask questions like "What burgers are available?" or "Place an order for a vegan burger" and Copilot will use the MCP server to provide answers or perform actions.
226228

0 commit comments

Comments
 (0)