This repository was archived by the owner on Feb 6, 2026. It is now read-only.
📝 README Improvements: Enhanced UX, Navigation, and Tools Documentation Link #732
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,116 @@ | ||
| # 🌟 Azure MCP Server | ||
|
|
||
| [](https://www.npmjs.com/package/@azure/mcp) | ||
|
spboyer marked this conversation as resolved.
|
||
| [](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-github-copilot) | ||
| [](https://opensource.org/licenses/MIT) | ||
| [](https://github.com/Azure/azure-mcp/issues) | ||
|
|
||
| The Azure MCP Server implements the [MCP specification](https://modelcontextprotocol.io) to create a seamless connection between AI agents and Azure services. Azure MCP Server can be used alone or with the [GitHub Copilot for Azure extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-github-copilot) in VS Code. | ||
|
Contributor
There was a problem hiding this comment. This text is a bit stodgy. How about something like:
|
||
|
|
||
| > **🚀 New in v0.5.0:** Namespace mode (default), improved tool organization, and Azure Workbooks support | ||
|
Contributor
There was a problem hiding this comment. Need to update for v0.5.3 |
||
| > **📢 Public Preview:** This project is in Public Preview - implementation may significantly change prior to General Availability. | ||
|
|
||
| ## 📋 Table of Contents | ||
|
|
||
| - [🚀 Quick Start](#-quick-start) | ||
| - [⚙️ VS Code Install Steps](#️-vs-code-install-steps-recommended) | ||
| - [▶️ Getting Started](#️-getting-started) | ||
| - [✨ What can you do with the Azure MCP Server?](#-what-can-you-do-with-the-azure-mcp-server) | ||
| - [🛠️ Currently Supported Tools](#️-currently-supported-tools) | ||
| - [📖 Complete Tools Documentation](#-complete-tools-documentation) | ||
| - [🔄️ Upgrading Existing Installs](#️-upgrading-existing-installs-to-the-latest-version) | ||
| - [⚙️ Advanced Install Scenarios](#️-advanced-install-scenarios-optional) | ||
| - [📝 Troubleshooting](#-troubleshooting) | ||
| - [❓ Frequently Asked Questions](#-frequently-asked-questions) | ||
| - [👥 Contributing](#-contributing) | ||
|
|
||
| ## 🚀 Quick Start | ||
|
spboyer marked this conversation as resolved.
|
||
|
|
||
| **Get started in under 60 seconds:** | ||
|
|
||
| 1. **Install the GitHub Copilot for Azure extension**: [](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-github-copilot) | ||
|
Contributor
There was a problem hiding this comment. We need the button for installing to Insiders here too. |
||
| 1. **Open GitHub Copilot Chat** in VS Code and [switch to Agent mode](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode) | ||
| 1. **Try it**: Ask "List my Azure Storage accounts" and watch the magic happen! ✨ | ||
|
|
||
| ### ⚙️ VS Code Install Steps (Recommended) | ||
|
|
||
| 1. Install either the stable or Insiders release of VS Code: | ||
| * [💫 Stable release](https://code.visualstudio.com/download) | ||
| * [🔮 Insiders release](https://code.visualstudio.com/insiders) | ||
| 1. Install the [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) and [GitHub Copilot Chat](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) extensions | ||
|
|
||
| 1. Install the [Azure MCP Server](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-mcp-server) extension | ||
|
Contributor
There was a problem hiding this comment. We don't need this if they install GHCP4A |
||
|
|
||
| 1. Install the [GitHub Copilot for Azure](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-github-copilot) extension from the VS Code Marketplace | ||
|
Contributor
There was a problem hiding this comment. We need the button for installing to Insiders here too. |
||
|
|
||
| ### 🚀 Next Steps | ||
|
|
||
| **Once you've installed the Azure MCP Server:** | ||
|
|
||
| 1. **Open GitHub Copilot Chat** in VS Code and [switch to Agent mode](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode) | ||
| 2. **Verify installation**: You should see "Azure MCP Server" (or specific service names) in the tools list | ||
| 3. **Click refresh** on the tools list if you don't see Azure tools immediately | ||
| 4. **Test your setup** with a simple prompt like: | ||
| - `"List my Azure Storage accounts"` | ||
| - `"Show my resource groups"` | ||
| - `"List my Azure subscriptions"` | ||
| 5. **Explore capabilities**: The agent will use Azure MCP tools to complete your queries! | ||
|
|
||
| **Need help?** Check out the [official documentation](https://learn.microsoft.com/azure/developer/azure-mcp-server/) and [troubleshooting guide](https://github.com/Azure/azure-mcp/blob/main/TROUBLESHOOTING.md#128-tool-limit-issue). | ||
|
|
||
| ## ✨ What can you do with the Azure MCP Server? | ||
|
|
||
| The Azure MCP Server supercharges your agents with Azure context. Here are some examples organized by common use cases: | ||
|
|
||
| ### � **Data & Analytics** | ||
|
|
||
| **Azure AI Search:** | ||
| - "What indexes do I have in my Azure AI Search service 'mysvc'?" | ||
| - "Let's search this index for 'my search query'" | ||
|
|
||
| **Azure Cosmos DB:** | ||
| - "Show me all my Cosmos DB databases" | ||
| - "List containers in my Cosmos DB database" | ||
|
|
||
| **Azure Data Explorer:** | ||
| - "Get Azure Data Explorer databases in cluster 'mycluster'" | ||
| - "Sample 10 rows from table 'StormEvents' in Azure Data Explorer database 'db1'" | ||
|
|
||
| **Azure Monitor:** | ||
| - "Query my Log Analytics workspace" | ||
|
|
||
| ### 🏗️ **Infrastructure & Resources** | ||
|
|
||
| **Azure Resource Management:** | ||
| - "List my resource groups" | ||
| - "List my Azure CDN endpoints" | ||
| - "Help me build an Azure application using Node.js" | ||
|
|
||
| **Azure Kubernetes Service (AKS):** | ||
| - "List my AKS clusters in my subscription" | ||
| - "Show me all my Azure Kubernetes Service clusters" | ||
|
|
||
| **Azure Storage:** | ||
| - "List my Azure storage accounts" | ||
| - "Show me the tables in my Storage account" | ||
| - "Get details about my Storage container" | ||
| - "List paths in my Data Lake file system" | ||
|
|
||
| ### 🗄️ **Databases** | ||
|
|
||
| **Azure SQL Database:** | ||
| - "Show me details about my Azure SQL database 'mydb'" | ||
| - "List Active Directory administrators for my SQL server 'myserver'" | ||
| - "List all firewall rules for my SQL server 'myserver'" | ||
| - "List all elastic pools in my SQL server 'myserver'" | ||
|
|
||
| ### ⚙️ **Configuration & Management** | ||
|
|
||
| **Azure App Configuration:** | ||
| - "List my App Configuration stores" | ||
| - "Show my key-value pairs in App Config" | ||
|
|
||
| > **💡 Pro Tip:** Try combining multiple operations in a single prompt like *"List my storage accounts and show me the containers in the first one"* to see the power of chained Azure operations! | ||
|
|
||
| ## 🛠️ Currently Supported Tools | ||
|
|
||
|
|
@@ -248,6 +284,19 @@ Agents and models can discover and learn best practices and usage guidelines for | |
|
|
||
| For detailed command documentation and examples, see [Azure MCP Commands](https://github.com/Azure/azure-mcp/blob/main/docs/azmcp-commands.md). | ||
|
|
||
| ## 📖 Complete Tools Documentation | ||
|
|
||
| For comprehensive documentation of all 130+ available tools across 29+ Azure service namespaces, including detailed parameters, examples, and usage patterns, see our **[Complete Tools Documentation](./docs/tools.md)**. | ||
|
|
||
| The tools documentation provides: | ||
| - **Detailed tool reference** with parameters and examples | ||
| - **Service-specific workflows** and common scenarios | ||
| - **Authentication and security** considerations | ||
| - **Performance optimization** tips | ||
| - **Troubleshooting guidance** for each tool category | ||
|
|
||
| Whether you're exploring what's possible or need specific implementation details, the tools documentation is your comprehensive reference guide. | ||
|
|
||
| ## 🔄️ Upgrading Existing Installs to the Latest Version | ||
|
|
||
| <details> | ||
|
|
@@ -398,6 +447,51 @@ Your credentials are always handled securely through the official [Azure Identit | |
|
|
||
| MCP as a phenomenon is very novel and cutting-edge. As with all new technology standards, consider doing a security review to ensure any systems that integrate with MCP servers follow all regulations and standards your system is expected to adhere to. This includes not only the Azure MCP Server, but any MCP client/agent that you choose to implement down to the model provider. | ||
|
|
||
| ## ❓ Frequently Asked Questions | ||
|
|
||
| <details> | ||
| <summary><strong>Q: What's the difference between "All Tools" and individual service installs?</strong></summary> | ||
|
|
||
| - **All Tools**: Installs 130+ tools across all Azure services in a single server | ||
| - **Individual Services**: Install only specific services (e.g., just Storage, just Key Vault) | ||
| - **Recommendation**: Start with "All Tools" for exploration, then switch to specific services for production | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary><strong>Q: Do I need Azure CLI installed?</strong></summary> | ||
|
|
||
| No! Azure MCP Server includes its own Azure CLI tools. However, having Azure CLI installed can provide additional authentication options. | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary><strong>Q: What authentication methods are supported?</strong></summary> | ||
|
|
||
| Azure MCP supports all Azure Identity authentication methods: | ||
| - **Interactive browser login** (recommended for development) | ||
| - **Managed Identity** (recommended for production) | ||
| - **Service Principal** with client secret or certificate | ||
| - **Azure CLI** authentication | ||
| - **Environment variables** (AZURE_CLIENT_ID, AZURE_CLIENT_SECRET, etc.) | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary><strong>Q: Can I use this in production?</strong></summary> | ||
|
|
||
| Azure MCP Server is currently in **Public Preview**. While functional, the API may change before General Availability. For production use: | ||
| - Pin to specific versions: `@azure/mcp@0.5.0` instead of `@latest` | ||
| - Use managed identity authentication | ||
| - Review security considerations for your environment | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary><strong>Q: How do I troubleshoot connection issues?</strong></summary> | ||
|
|
||
| 1. Check the [Troubleshooting Guide](https://github.com/Azure/azure-mcp/blob/main/TROUBLESHOOTING.md) | ||
| 2. Verify your Azure authentication: `az account show` | ||
| 3. Check VS Code developer console for MCP-related errors | ||
| 4. Try the "refresh" button in the tools list | ||
| </details> | ||
|
|
||
| ## 👥 Contributing | ||
|
|
||
| We welcome contributions to the Azure MCP Server! Whether you're fixing bugs, adding new features, or improving documentation, your contributions are welcome. | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these should be indented 4 spaces under the ` - [ ] For MCP tool changes, updated:"