Skip to content

Commit 83f39aa

Browse files
authored
Add update instructions to readme (#229)
1 parent d9da9cf commit 83f39aa

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ The Azure MCP Server implements the [MCP specification](https://modelcontextprot
1616
6. [👥 Contributing to Azure MCP Server](#-contributing)
1717

1818

19-
2019
## 🎯 Overview
2120

2221
### ✨ What can you do with the Azure MCP Server?
@@ -214,6 +213,24 @@ AZURE_CLIENT_SECRET={YOUR_AZURE_CLIENT_SECRET}
214213

215214
Optionally, customers can use `--env` or `--volume` to pass authentication values.
216215

216+
### 🔄️ Updates
217+
218+
#### NPX
219+
220+
If you use the default package spec of `@azure/mcp@latest`, npx will look for a new version on each server start. If you use just `@azure/mcp`, npx will continue to use its cached version until its cache is cleared.
221+
222+
#### NPM
223+
224+
If you globally install the cli via `npm install -g @azure/mcp` it will use the installed version until you manually update it with `npm update -g @azure/mcp`.
225+
226+
#### Docker
227+
228+
There is no version update built into the docker image. To update, just pull the latest from the repo and repeat the [docker installation instructions](#docker-install).
229+
230+
#### VS Code
231+
232+
Installation in VS Code should be in one of the previous forms and the update instructions are the same. If you installed the mcp server with the `npx` command and `-y @azure/mcp@latest` args, npx will check for package updates each time VS Code starts the server. Using a docker container in VS Code has the same no-update limitation described above.
233+
217234
## 🧪 Test the Azure MCP Server
218235

219236
1. Open GitHub Copilot in VS Code and [switch to Agent mode](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode)
@@ -227,7 +244,7 @@ You can easily configure your MCP client to use the Azure MCP Server. Have your
227244

228245
### Using standard IO
229246

230-
Configure the MCP client to execute: `npx -y @azure/mcp@latest server start`. For instructions on using VS Code, follow instructions in [One-Click Install](#-one-click-install) or [Manual Install](#-manual-install).
247+
Configure the MCP client to execute: `npx -y @azure/mcp@latest server start`. For instructions on using , follow instructions in [One-Click Install](#-one-click-install) or [Manual Install](#-manual-install).
231248

232249
### Using SSE
233250

@@ -301,5 +318,5 @@ This project has adopted the
301318
[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
302319
For more information, see the
303320
[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
304-
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com)
321+
or contact [open@microsoft.com](mailto:open@microsoft.com)
305322
with any additional questions or comments.

0 commit comments

Comments
 (0)