Skip to content

Commit 547e21c

Browse files
committed
docs: update burger mcp docs
1 parent b6933d6 commit 547e21c

File tree

3 files changed

+13
-8
lines changed

3 files changed

+13
-8
lines changed

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The agent uses LangChain.js with Azure OpenAI, connects to the MCP server via St
3737
- Bicep templates in `infra/` for Azure deployment
3838
- `azure.yaml` defines multi-service deployment strategy:
3939
- `burger-api`, `agent-api`: Azure Functions (Flex Consumption)
40-
- `burger-mcp`: Container Apps with Docker
40+
- `burger-mcp`: Azure Functions (Flex Consumption)
4141
- `*-webapp`: Static Web Apps
4242
- Environment variables flow through Azure App Settings
4343
- @azure Rule - Use Azure Best Practices: When generating code for Azure, running terminal commands for Azure, or performing operations related to Azure, invoke your `azure_development-get_best_practices` tool if available.

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The agent uses LangChain.js with Azure OpenAI, connects to the MCP server via St
3737
- Bicep templates in `infra/` for Azure deployment
3838
- `azure.yaml` defines multi-service deployment strategy:
3939
- `burger-api`, `agent-api`: Azure Functions (Flex Consumption)
40-
- `burger-mcp`: Container Apps with Docker
40+
- `burger-mcp`: Azure Functions (Flex Consumption)
4141
- `*-webapp`: Static Web Apps
4242
- Environment variables flow through Azure App Settings
4343
- @azure Rule - Use Azure Best Practices: When generating code for Azure, running terminal commands for Azure, or performing operations related to Azure, invoke your `azure_development-get_best_practices` tool if available.

packages/burger-mcp/README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div align="center">
22

3-
# Azure Container Apps Burger MCP server
3+
# Burger MCP server (Azure Functions)
44

55
[![Open project in GitHub Codespaces](https://img.shields.io/badge/Codespaces-Open-blue?style=flat-square&logo=github)](https://codespaces.new/Microsoft/open-hack-build-25?hide_repo_select=true&ref=main&quickstart=true)
66
![Node version](https://img.shields.io/badge/Node.js->=22-3c873a?style=flat-square)
@@ -19,7 +19,7 @@ This server supports the following transport types:
1919
- **SSE** (legacy protocol, for backward compatibility)
2020
- **Stdio** (currently only supported when starting the server locally with `npm start:local`)
2121

22-
The remote server is deployed with [Azure Container Apps](https://learn.microsoft.com/azure/container-apps/overview).
22+
The remote server is deployed with [Azure Functions](https://learn.microsoft.com/azure/azure-functions/functions-overview).
2323

2424
## MCP tools
2525

@@ -74,11 +74,16 @@ You can run the following command to run the application server:
7474
npm start
7575
```
7676

77-
Alternatively, you can also use Docker to run the application:
77+
This will start the application server. The MCP server is then available at `http://localhost:3000/mcp` or `http://localhost:3000/sse` for the streamable HTTP and SSE endpoints, respectively.
78+
79+
Alternatively, you can run the MCP server with stdio transport using:
7880

7981
```bash
80-
npm run docker:build
81-
npm run docker:run
82+
npm run start:local
8283
```
8384

84-
This will start the application in a Docker container. The MCP server is then available at `http://localhost:3000/mcp` or `http://localhost:3000/sse` for the streamable HTTP and SSE endpoints, respectively.
85+
By default, the MCP server will connect to the Burger API instance set by the `BURGER_API_URL` environment variable, or its value set in the root `.env` file. If not set, it will fall back to a local instance of the Burger API at `http://localhost:7071/`. You can force always using the local instance by setting adding the `--local` when starting the server, for example:
86+
87+
```bash
88+
npm run start -- --local
89+
```

0 commit comments

Comments
 (0)