-
Notifications
You must be signed in to change notification settings - Fork 339
Document API permissions #1458
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Document API permissions #1458
Conversation
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.
Pull request overview
This PR adds a new documentation file that maps Azure MCP tool namespaces to their required API permissions. The file helps users configure downstream API permissions when setting up Azure MCP Server as a remote server with On-Behalf-Of (OBO) authentication flow.
Key changes:
- Added
api-permissions.mdfile documenting namespace-to-API permission mappings - Includes two tables: one for APIs with exposed permissions and one for APIs without exposed API permissions
- Covers 13 different Azure services including Storage, Key Vault, Cosmos DB, Event Hubs, and others
Comments suppressed due to low confidence (1)
servers/Azure.Mcp.Server/azd-templates/api-permissions.md:3
- The documentation should include introductory context explaining when and how to use this information. Consider adding: 1) A brief explanation of when users need to configure these permissions (e.g., when setting up Azure MCP as a remote server with OBO flow for service-to-service authentication), 2) Basic instructions or a link to documentation on how to add API permissions to an Azure AD app registration, and 3) An explanation of the relationship between namespaces and the required permissions.
# API permissions
A table of known API permissions of downstream APIs that can be called by Azure MCP.
What does this PR do?
[Provide a clear, concise description of the changes]Users who want to run Azure MCP as a remote server with OBO flow need to add downstream API permissions to the server app registration. This PR adds a markdown file documenting the tool namespace to API permissions map to help users figure out what they need to add for the tools they want to use in their self-hosted server.
[Any additional context, screenshots, or information that helps reviewers]GitHub issue number?
#1450
Pre-merge Checklist
servers/Azure.Mcp.Server/CHANGELOG.mdand/orservers/Fabric.Mcp.Server/CHANGELOG.mdfor product changes (features, bug fixes, UI/UX, updated dependencies)servers/Azure.Mcp.Server/README.mdand/orservers/Fabric.Mcp.Server/README.mddocumentationeng/scripts/Process-PackageReadMe.ps1. See Package README/servers/Azure.Mcp.Server/docs/azmcp-commands.mdand/or/docs/fabric-commands.md.\eng\scripts\Update-AzCommandsMetadata.ps1to update tool metadata in azmcp-commands.md (required for CI)ToolDescriptionEvaluatorand obtained a score of0.4or more and a top 3 ranking for all related test promptsconsolidated-tools.json/servers/Azure.Mcp.Server/docs/e2eTestPrompts.mdcrypto mining, spam, data exfiltration, etc.)/azp run mcp - pullrequest - liveto run Live Test Pipeline