azure-documentdb
Expert knowledge for Azure DocumentDB development including troubleshooting, best practices, decision making, architecture & design patterns, limits & quotas, security, configuration, integrations & coding patterns, and deployment. Use when using Azure DocumentDB indexing/search, MongoDB API, HA/replicas, vector/RAG workloads, or IaC deployments, and other Azure DocumentDB related development tasks. Not for Azure Cosmos DB (use azure-cosmos-db), Azure Table Storage (use azure-table-storage), Azure SQL Database (use azure-sql-database), Azure SQL Managed Instance (use azure-sql-managed-instance).
How do I install this agent skill?
npx skills add https://github.com/microsoftdocs/agent-skills --skill azure-documentdbIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill provides expert guidance and documentation references for Azure DocumentDB development. It fetches content from official Microsoft documentation sources and references installation guides from the vendor's official GitHub repository. No security issues were detected.
- Socketpass
No alerts
- Snykwarn
Risk: MEDIUM · 1 issue
What does this agent skill do?
Azure DocumentDB Skill
This skill provides expert guidance for Azure DocumentDB. Covers troubleshooting, best practices, decision making, architecture & design patterns, limits & quotas, security, configuration, integrations & coding patterns, and deployment. 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), useread_filewith the specified lines. For categories with file links (e.g.,[security.md](security.md)), useread_fileon the linked reference file
IMPORTANT for Agent: If
metadata.generated_atis more than 3 months old, suggest the user pull the latest version from the repository. Ifmcp_microsoftdocstools 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_fetchwith query stringfrom=learn-agent-skill. Returns Markdown. - Fallback: Use
fetch_webpagewith query stringfrom=learn-agent-skill&accept=text/markdown. Returns Markdown.
Category Index
| Category | Lines | Description |
|---|---|---|
| Troubleshooting | L37-L45 | Diagnosing and fixing DocumentDB issues: query performance, CMK encryption, replication, and common connectivity/network errors including migration-related problems. |
| Best Practices | L46-L56 | Best practices for DocumentDB indexing, query optimization, background indexing safety, and designing high-availability, cross-region replicated deployments. |
| Decision Making | L57-L72 | Guides for choosing between DocumentDB and MongoDB services, planning migrations and connectivity, cross-region failover, and selecting optimal vector index/search algorithms across languages. |
| Architecture & Design Patterns | L73-L82 | Patterns for scaling, HA/DR, sharding, multi‑cloud setups, and building Go/TypeScript AI agents (including autonomous travel) on Azure DocumentDB. |
| Limits & Quotas | L83-L96 | Limits, quotas, and configuration constraints for DocumentDB: compute/storage tiers, free tier caps, SSD performance, indexing/text index limits, document/batch sizes, diagnostics, and feature availability. |
| Security | L97-L108 | Securing DocumentDB: encryption at rest and with customer keys, firewall and RBAC setup, Private Link and public access control, native user management, and cluster security best practices. |
| Configuration | L109-L131 | Configuring DocumentDB features: indexing, search (BM25, vector, fuzzy, full-text, geo), MongoDB compatibility, HA/replicas, scaling, transactions, monitoring, alerts, backups, and MCP toolkit. |
| Integrations & Coding Patterns | L132-L155 | Patterns and code samples for integrating Azure DocumentDB with languages, frameworks, vector search/RAG tools, migrations (Mongo/Cassandra), and external services like Databricks and OpenAI. |
| Deployment | L156-L162 | Guides for deploying and managing DocumentDB clusters: local dev to Azure, backup/restore, version upgrades, and IaC deployment with Bicep and Terraform. |
Troubleshooting
| Topic | URL |
|---|---|
| Troubleshoot CMK encryption issues in Azure DocumentDB | https://learn.microsoft.com/en-us/azure/documentdb/how-to-database-encryption-troubleshoot |
| Diagnose query performance using explain() in DocumentDB | https://learn.microsoft.com/en-us/azure/documentdb/how-to-read-explain-output |
| Troubleshoot common Azure DocumentDB errors and connectivity | https://learn.microsoft.com/en-us/azure/documentdb/troubleshoot-common-issues |
| Troubleshoot network connectivity for DocumentDB migrations | https://learn.microsoft.com/en-us/azure/documentdb/troubleshoot-connectivity |
| Troubleshoot Azure DocumentDB replication issues | https://learn.microsoft.com/en-us/azure/documentdb/troubleshoot-replication |
Best Practices
| Topic | URL |
|---|---|
| Use background indexing safely in Azure DocumentDB | https://learn.microsoft.com/en-us/azure/documentdb/background-indexing |
| Apply cross-region replication best practices in DocumentDB | https://learn.microsoft.com/en-us/azure/documentdb/cross-region-replication |
| Implement HA and cross-region replication best practices | https://learn.microsoft.com/en-us/azure/documentdb/high-availability-replication-best-practices |
| Apply indexing best practices for Azure DocumentDB collections | https://learn.microsoft.com/en-us/azure/documentdb/how-to-create-indexes |
| Explore practical indexing scenarios in Azure DocumentDB | https://learn.microsoft.com/en-us/azure/documentdb/how-to-index |
| Safely migrate from non-ordered to ordered indexes in DocumentDB | https://learn.microsoft.com/en-us/azure/documentdb/how-to-migrate-ordered-indexes |
| Optimize Azure DocumentDB queries with Index Advisor | https://learn.microsoft.com/en-us/azure/documentdb/index-advisor |
Decision Making
Architecture & Design Patterns
| Topic | URL |
|---|---|
| Apply autoscale behavior for Azure DocumentDB workloads | https://learn.microsoft.com/en-us/azure/documentdb/autoscale |
| Design multi-cloud architectures with Azure DocumentDB | https://learn.microsoft.com/en-us/azure/documentdb/multi-cloud |
| Design sharding strategy for Azure DocumentDB | https://learn.microsoft.com/en-us/azure/documentdb/partitioning |
| Implement Go-based AI agents with DocumentDB | https://learn.microsoft.com/en-us/azure/documentdb/quickstart-agent-go |
| Build TypeScript AI agents with DocumentDB vector search | https://learn.microsoft.com/en-us/azure/documentdb/quickstart-agent-nodejs |
| Design an autonomous travel agent with DocumentDB | https://learn.microsoft.com/en-us/azure/documentdb/tutorial-ai-agent |
Limits & Quotas
Security
Configuration
Integrations & Coding Patterns
Deployment
| Topic | URL |
|---|---|
| Develop locally with DocumentDB and deploy to Azure | https://learn.microsoft.com/en-us/azure/documentdb/development-loop |
| Upgrade Azure DocumentDB clusters to newer MongoDB versions | https://learn.microsoft.com/en-us/azure/documentdb/how-to-upgrade-cluster |
| Deploy Azure DocumentDB clusters with Bicep | https://learn.microsoft.com/en-us/azure/documentdb/quickstart-bicep |
| Deploy Azure DocumentDB clusters using Terraform | https://learn.microsoft.com/en-us/azure/documentdb/quickstart-terraform |
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/microsoftdocs/agent-skills/azure-documentdb">View azure-documentdb on skillZs</a>