Agent Skill · MongoDB

mongodb-schema-design

MongoDB schema design patterns and anti-patterns. Use when designing data models, reviewing schemas, migrating from SQL, or troubleshooting performance issues caused by schema problems. Triggers on "design schema", "embed vs reference", "MongoDB data model", "schema review", "unbounded arrays", "one-to-many", "tree structure", "16MB limit", "schema validation", "JSON Schema", "time series", "schema migration", "polymorphic", "TTL", "data lifecycle", "archive", "index explosion", "unnecessary indexes", "approximation pattern", "document versioning".

Provider: MongoDB Path in repo: skills/mongodb-schema-design/SKILL.md

Skill body

MongoDB Schema Design

Data modeling patterns and anti-patterns for MongoDB, maintained by MongoDB. Bad schema is the root cause of most MongoDB performance and cost issues—queries and indexes cannot fix a fundamentally wrong model.

When to Apply

Reference these guidelines when:

Quick Reference

1. Schema Anti-Patterns - 3 rules

2. Schema Fundamentals - 4 rules

3. Design Patterns - 11 rules

Key Principle

“Data that is accessed together should be stored together.”

This is MongoDB’s core philosophy. Embedding related data eliminates joins, reduces round trips, and enables atomic updates. Reference only when you must.

A core way to implement this philosophy is the fact that MongoDB exposes flexible schemas. This means you can have different fields in different documents, and even different structures. This allows you to model data in the way that best fits your access patterns, without being constrained by a rigid schema. For example, if different documents have different sets of fields, that is perfectly fine as long as it serves your application’s needs. You can also use schema validation to enforce certain rules while still allowing for flexibility.

Another implication of the key principle is that information about the expected read and write workload becomes very relevant to schema design. If pieces of information from different entities are often queried or updated together, that means that prioritizing co-location of that data in the same document can lead to significant performance benefits. On the other hand, if certain pieces of information are rarely accessed together, it may make sense to store them separately to avoid loading more data than necessary.

Schema Fundamentals Summary

Embed/Reference Decision Framework

Relationship Cardinality Access Pattern Recommendation
One-to-One 1:1 Always together Embed
One-to-Few 1:N (N < 100) Usually together Embed array
One-to-Many 1:N (N > 100) Often separate Reference
Many-to-Many M:N Varies Two-way reference

This is a rough guideline, and whether to embed or reference depends on your specific access patterns, data size, and read/write frequencies. Always verify with your actual workload.

How to Use

Each reference file listed above contains detailed explanations and code examples. Use the descriptions in the Quick Reference to identify which files are relevant to your current task.

Each reference file contains:


How These Rules Work

MongoDB MCP Integration

For automatic verification, connect the MongoDB MCP Server.

If the MCP server is running and connected, I can automatically run verification commands to check your actual schema, document sizes, array lengths, index usage, and more. This allows me to provide tailored recommendations based on your real data, not just code patterns.

⚠️ Security: Use --readOnly for safety. Remove only if you need write operations.

When connected, I can automatically:

⚠️ Action Policy

I will NEVER execute write operations without your explicit approval.

Before any write or destructive operation via MCP, I will: (1) summarize the exact operation (collection, index/validator, estimated number of docs affected), and (2) ask for explicit confirmation (yes/no). I will not proceed on partial or ambiguous approvals.

Operation Type MCP Tools Action
Read (Safe) find, aggregate, collection-schema, db-stats, count I may run automatically to verify
Write (Requires Approval) update-many, insert-many, create-collection I will show the command and wait for your “yes”
Destructive (Requires Approval) delete-many, drop-collection, drop-database I will warn you and require explicit confirmation

When I recommend schema changes or data modifications:

  1. I’ll explain what I want to do and why
  2. I’ll show you the exact command
  3. I’ll wait for your approval before executing
  4. If you say “go ahead” or “yes”, only then will I run it

Your database, your decision. I’m here to advise, not to act unilaterally.

Working Together

If you’re not sure about a recommendation:

  1. Run the verification commands I provide
  2. Share the output with me
  3. I’ll adjust my recommendation based on your actual data

We’re a team—let’s get this right together.

Skill frontmatter

license: Apache-2.0 metadata: {"version"=>"1.0.0"}