Skip to content

Commit 47e4ac2

Browse files
authored
Update best practices docs (#186)
1 parent a71d75f commit 47e4ac2

File tree

4 files changed

+25
-1
lines changed

4 files changed

+25
-1
lines changed

.github/CODEOWNERS

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,10 @@
6161

6262
# ServiceLabel: %area-ServiceBus
6363
# ServiceOwners: @shankarsama @EldertGrootenboer
64+
65+
# PRLabel: %area-BestPractices
66+
/src/Commands/AzureBestPractices/ @g2vinay @conniey
67+
/src/Resources/azure-best-practices.txt @g2vinay @conniey
68+
69+
# ServiceLabel: %area-BestPractices
70+
# ServiceOwners: @g2vinay @conniey

.vscode/cspell.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,32 @@
1515
"**/.work/**",
1616
"**/.git/**",
1717
"**/.vscode/**",
18-
"**/.editorconfig"
18+
"**/.editorconfig",
19+
"**/.github/CODEOWNERS"
1920
],
2021
"words": [
2122
"1espt",
2223
"appconfig",
2324
"azmcp",
25+
"azuremcp",
2426
"azsdk",
2527
"azuresdk",
28+
"bestpractices",
2629
"codesign",
2730
"CODEOWNERS",
2831
"cvzf",
2932
"esrp",
3033
"ESRPRELPACMANTEST",
3134
"jongio",
35+
"keyvault",
36+
"servicebus",
3237
"Kusto",
3338
"Linq",
3439
"LINUXOS",
3540
"LINUXPOOL",
3641
"LINUXVMIMAGE",
42+
"mysvc",
43+
"mycluster",
3744
"MACOS",
3845
"MACPOOL",
3946
"MACVMIMAGE",

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,12 @@ The Azure MCP Server provides tools for interacting with the following Azure ser
116116
- Support for template discovery, template initialization, provisioning and deployment
117117
- Cross-platform compatibility
118118

119+
### 🛡️ Azure Best Practices
120+
- Get secure, production-grade Azure SDK best practices for effective code generation.
121+
119122
For detailed command documentation and examples, see [Azure MCP Commands](https://github.com/Azure/azure-mcp/blob/main/docs/azmcp-commands.md).
120123

124+
121125
## 🔌 Getting Started
122126

123127
The Azure MCP Server requires Node.js to install and run the server. If you don't have it installed, follow the instructions [here](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).

docs/azmcp-commands.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ azmcp server start [--transport <transport>]
2929
azmcp subscription list [--tenant-id <tenant-id>]
3030
```
3131

32+
### Best Practices
33+
```bash
34+
# Get secure, production-grade Azure SDK best practices for effective code generation.
35+
azmcp bestpractices get
36+
```
37+
3238
### Azure Cosmos DB Operations
3339
```bash
3440
# List Cosmos DB accounts in a subscription

0 commit comments

Comments
 (0)