mcpField
A
azure-immersive-reader

azure-immersive-reader

github.com/microsoftdocsDevelopment796159 installsUpdated 3d ago
Repository

About azure-immersive-reader

Azure AI Immersive Reader Skill gives agents focused guidance for integrating and configuring Azure AI Immersive Reader. It combines local references with network-fetched documentation on implementation, security, and supported capabilities.

Key features

  1. 01Implementation patterns for web and iOS
  2. 02Read-aloud and translation settings
  3. 03Security and authentication guidance
  4. 04Language support and quotas
  5. 05Remote documentation retrieval

Use cases

  1. 01Configure read-aloud and translation behavior
  2. 02Integrate Immersive Reader into an app
  3. 03Review authentication and cookie policies

MCP support

The skill can fetch documentation through the mcp_microsoftdocs microsoft_docs_fetch tool; fetch_webpage is listed as a fallback.

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/microsoftdocs/agent-skills --skill azure-immersive-reader

After installing, type/azure-immersive-readerin Claude Code to confirm it loaded.

Details

From the project README

Azure AI Immersive Reader Skill

This skill provides expert guidance for Azure AI Immersive Reader. Covers best practices, limits & quotas, security, configuration, and integrations & coding patterns. It combines local quick-reference content with remote documentation fetching capabilities.

How to Use This Skill

IMPORTANT for Agent: Use the Category Index below to locate relevant sections. For categories with line ranges (e.g., L35-L120), use read_file with the specified lines. For categories with file links (e.g., [security.md](security.md)), use read_file on the linked reference file

IMPORTANT for Agent: If metadata.generated_at is more than 3 months old, suggest the user pull the latest version from the repository. If mcp_microsoftdocs tools are not available, suggest the user install it: Installation Guide

This skill requires network access to fetch documentation content:

  • Preferred: Use mcp_microsoftdocs:microsoft_docs_fetch with query string from=learn-agent-skill. Returns Markdown.
  • Fallback: Use fetch_webpage with query string from=learn-agent-skill&accept=text/markdown. Returns Markdown.

Category Index

CategoryLinesDescription
Best PracticesL33-L37Guidance on improving Immersive Reader performance by caching authentication tokens, including token reuse patterns and reducing auth overhead.
Limits & QuotasL38-L42Supported languages and feature availability for Immersive Reader (e.g., which languages work with read-aloud, translation, and other capabilities).
SecurityL43-L49Configuring Immersive Reader security: creating the resource with Entra auth, managing Entra role assignments, and setting cookie policy and user consent.
ConfigurationL50-L56Configuring Immersive Reader behavior: read-aloud voice/speed, translation languages and behavior, and storing/managing per-user reading and language preferences.
Integrations & Coding PatternsL57-L66Implementing Immersive Reader in web/iOS apps: launch flows, JS SDK usage, HTML/MathML prep, custom buttons, multi-resource setups, and Vision Read integration.
Best Practices
TopicURL
Cache Immersive Reader auth tokens for performancehttps://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/how-to-cache-token
Limits & Quotas
TopicURL
Check supported languages for Immersive Reader featureshttps://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/language-support
Security
TopicURL
Create Immersive Reader resource and configure Entra authhttps://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/how-to-create-immersive-reader
Configure Immersive Reader cookie policy and consenthttps://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/how-to/set-cookie-policy
Update Immersive Reader Entra role assignments for securityhttps://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/security-how-to-update-role-assignment
Configuration
TopicURL
Configure Immersive Reader Read Aloud optionshttps://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/how-to-configure-read-aloud
Configure translation settings in Immersive Readerhttps://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/how-to-configure-translation
Store and manage Immersive Reader user preferenceshttps://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/how-to-store-user-preferences
Integrations & Coding Patterns
TopicURL
Customize the Immersive Reader launch buttonhttps://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/how-to-customize-launch-button
Launch Azure Immersive Reader from application codehttps://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/how-to-launch-immersive-reader
Use multiple Immersive Reader resources in one apphttps://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/how-to-multiple-resources
Prepare HTML content for Immersive Reader integrationhttps://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/how-to-prepare-html
Render MathML expressions in Immersive Readerhttps://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/how-to/display-math
Use the Immersive Reader JavaScript SDK APIhttps://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/reference
Build iOS app integrating Vision Read and Immersive Readerhttps://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/tutorial-ios-picture-immersive-reader

Comments

Markdown supported