Generated banner for Sanity Migration
Generated logo for Sanity Migration

Sanity Migration

SanityOfficialPublished by Sanity

  • Skill
  • Tool integration
  • Software development
  • MIT
  • No issues found

From the author

Plans, implements, and reviews migrations from other CMSes and content systems into Sanity. Use when migrating or replatforming to Sanity from AEM, Adobe Experience Manager, Contentful, Strapi, Webflow, WordPress, Payload, Drupal, Markdown/MDX/frontmatter files, WXR/XML exports, CMS APIs, database dumps, static HTML, or when designing extraction, transformation, Portable Text conversion, asset migration, redirects, validation, and cutover workflows.
— the description by Sanity

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a systematic approach to migrating content from various CMS platforms into Sanity. It treats migration as an ETL (Extract, Transform, Load) project, emphasizing deterministic scripts, content modeling, and validation over manual operations. The skill includes specific guidance for platforms such as AEM, Contentful, Strapi, Webflow, WordPress, Payload, Drupal, and Markdown-based systems, ensuring that content is properly mapped, transformed into Portable Text, and validated before final cutover.

What it does

  • Provides a structured workflow for planning and executing CMS-to-Sanity migrations.
  • Offers platform-specific guidance for extracting data from common CMS environments.
  • Defines best practices for mapping source content to Sanity schemas and Portable Text.
  • Requires the creation of migration plans, content inventories, and validation reports.
  • Encourages the use of deterministic scripts for repeatable and reliable data imports.
  • Includes procedures for handling assets, redirects, and final cutover synchronization.

When to use it

  • When replatforming a website or application to use Sanity as the content backend.
  • When moving content from legacy systems like AEM, Drupal, or WordPress.
  • When migrating static files like Markdown or MDX into a structured CMS.
  • When you need to perform a complex data transformation and cleanup during an import.
  • When you need to ensure data integrity through validation checks and delta syncs.

Advantages

  • Reduces risk by mandating planning and validation steps before execution.
  • Promotes repeatable migrations through script-based ETL patterns.
  • Ensures content is modeled for Sanity's capabilities rather than just copied.
  • Provides clear paths for handling complex data like rich text and assets.
  • Supports iterative development through deterministic ID management.

Usage examples

“I need to migrate my site from Contentful to Sanity. Where do I start?”
The agent will guide you through the Contentful-specific extraction process, help you plan your content mapping, and suggest using the contentful-to-sanity toolkit for an initial pass.
“How should I handle AEM content fragments during a migration?”
The agent will provide instructions on using AEM GraphQL to extract fragments and mapping them to Sanity document types or page builder blocks.
“Create a migration plan for my WordPress site.”
The agent will outline the steps to export WXR data, map WordPress posts to Sanity schemas, convert HTML to Portable Text, and set up redirects.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/sanity-io/sanity-migration/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip sanity-migration.zip -d .agents/skills

Documentation by Sanity

Sanity Migration

Use this skill for CMS-to-Sanity migration work. Treat migration as a content strategy and ETL project, not a blind lift-and-shift.

Required Workflow

  1. Read references/general.md first.

  2. If the source platform is known, also read its guide:

    • AEM / Adobe Experience Manager: references/aem.md

    • Contentful: references/contentful.md

    • Strapi: references/strapi.md

    • Webflow: references/webflow.md

    • WordPress / WXR / Elementor: references/wordpress.md

    • Payload: references/payload.md

    • Drupal: references/drupal.md

    • Markdown / MDX / frontmatter files: references/markdown.md

  3. Before writing code, produce a short migration plan covering source access, content scope, schema decisions, extraction, transformation, import, validation, redirects, and cutover.

  4. Prefer deterministic, repeatable scripts for real migrations. Write and review migration scripts, mappings, and validation checks; do not rely on one-off content operations for large content volumes.

Deliverables to Produce

For implementation or planning tasks, produce these artifacts or explain why they are not needed:

  • Content inventory: source types, counts, locales, status/draft scope, assets, and relationship types.

  • Source-to-Sanity mapping: document types, object types, references, Portable Text fields, asset fields, IDs, and skipped content.

  • Extraction approach: credentials/access needed, API/export commands, raw snapshot location, and known blind spots.

  • Transform/import plan: deterministic IDs, write order, asset handling, rich text conversion, validation, and rerun strategy.

  • Cutover plan: delta sync/content freeze, redirects, broken-link checks, SEO metadata, and manual cleanup.

Defaults

  • Use stable document IDs derived from source IDs, slugs, paths, or hashes.

  • Use createOrReplace, createIfNotExists, or sanity datasets import --replace so reruns converge.

  • Snapshot extracted source data to disk before transforming it.

  • Import or create referenced documents before documents that reference them.

  • Convert rich text to Portable Text instead of storing raw HTML or Markdown strings.

  • Upload assets to Sanity or the Media Library; do not leave production content dependent on legacy CDN URLs.

  • Track per-document quality issues and produce a validation summary before cutover.

  • Preserve legacy URLs and source IDs for redirects, QA, and future debugging.

Sanity Guardrails

  • Model what content is, not how the old site rendered it.

  • Use documents for reusable or independently managed entities; use objects for content owned by one document.

  • Use defineType, defineField, and defineArrayMember if authoring Sanity schemas.

  • Use image/file fields with uploaded Sanity assets or Media Library assets, not legacy CDN URLs.

  • Use Portable Text arrays for rich text and custom blocks; do not store raw HTML as the canonical body.

  • Run schema extraction and TypeGen after schema or GROQ query changes when the project uses TypeScript.

  • Deploy or apply schema changes before using MCP/content tools against the target dataset.

For deeper Sanity implementation guidance, use sanity-best-practices if it is already available. If it is not installed, tell the user they can add it with:

npx skills add sanity-io/agent-toolkit --skill sanity-best-practices

Stop and Ask

Stop before coding when any of these are unclear:

  • Source access path, credentials, export file, or database connection.

  • Target Sanity project/dataset or whether a scratch dataset should be used.

  • Draft, archived, scheduled, locale, or version history scope.

  • Whether media files should be migrated and whether asset URLs/files are accessible.

  • Whether the destination schema exists or should be designed as part of the migration.

Do Not Do This

  • Do not create random IDs for source-backed documents.

  • Do not fetch-then-create referenced documents; use deterministic IDs and createIfNotExists/createOrReplace.

  • Do not run bulk migrations through MCP content tools when NDJSON or scripts are appropriate.

  • Do not flatten locale fallback values into translations unless requested.

  • Do not leave TODOs for required media, authors, references, or rich text conversion.

  • Do not declare a migration done without count checks, sample checks, reference checks, and route/redirect checks.

Reference Map

Use references/general.md for shared migration principles and the platform references for source-specific extraction routes, modeling traps, and validation checks.

For source systems not explicitly covered, apply references/general.md and adapt the closest platform pattern:

  • API-first CMSes: start from Contentful, Strapi, or Payload.

  • Monolithic/page-builder systems: start from WordPress, Drupal, Webflow, or AEM.

  • HTML-heavy exports: start from the WordPress and Webflow rich-text guidance.

  • Markdown-first sources: start from references/markdown.md.

Files

references/drupal.md

Drupal to Sanity

What to Determine First

Before writing migration code, determine:

  • Drupal major version.

  • Whether Drush, database, admin UI, repository config, JSON:API, REST, or GraphQL access is available.

  • Which node types, taxonomy vocabularies, Paragraphs, media entities, menus, Views, users, redirects, and translations are in scope.

  • Whether content moderation, revisions, drafts, unpublished nodes, aliases, and redirects need to be preserved.

  • Whether rich text is Filtered HTML, Full HTML, Markdown, CKEditor output, or embedded media/shortcode-like tokens.

Schema Discovery

Use Drush and configuration export when available:

composer require drush/drush
drush config:export --destination=./drupal-config
drush config:get node.type --include-overridden
drush config:get field.storage --include-overridden
drush config:get field.field --include-overridden
drush entity:info node_type

Key config files:

  • node.type.*.yml: content type definitions.

  • field.storage.*.yml: reusable field storage definitions.

  • field.field.*.yml: field instances on bundles.

  • core.entity_view_display.*.yml: display config; useful for identifying presentation-only fields.

  • taxonomy.vocabulary.*.yml: taxonomy vocabularies.

  • Paragraphs config: paragraph bundles and fields when the Paragraphs module is used.

If Drush is unavailable, inspect exported config, custom modules, entity query usage, Twig templates, Views config exports, and field definitions in code.

Extraction Paths

Choose the most complete source:

  • Drush/config + database: best for full-fidelity migrations and schema discovery.

  • Drupal JSON:API: useful for structured extraction when enabled; include relationships and pagination explicitly.

  • REST/GraphQL: use when configured and complete enough for the target scope.

  • Database dump: complete but requires joining entity tables, field tables, revisions, files, and taxonomy terms.

  • Static crawl: fallback for public content only; loses entity relationships and editorial metadata.

Snapshot raw entity exports before transforming. Drupal field tables and revisions can be hard to reason about after the fact.

Mapping to Sanity

  • Node types become Sanity document types.

  • Taxonomy vocabularies and terms become reference documents.

  • Entity references become Sanity references.

  • Paragraph bundles become Sanity object types, Portable Text custom objects, or page builder blocks.

  • Media entities and file/image fields become Sanity image/file assets.

  • Menus can become navigation singleton documents or frontend configuration.

  • Views usually become frontend GROQ queries or route/listing logic, not migrated content.

  • URL aliases and redirect entities become redirect data or frontend redirect config.

Transformation Notes

  • Use deterministic IDs from entity type, bundle, entity ID, and language, such as node.article.123.en.

  • Import taxonomy terms, media, users/authors, and reusable referenced entities before nodes.

  • Preserve path.alias or alias tables as legacy URLs for redirects.

  • Convert rich text after applying or accounting for Drupal text filters. Filtered HTML may contain tokens, media embeds, or text-format-specific markup.

  • Resolve file IDs to real file URLs or local file paths before using _sanityAsset.

  • For Paragraphs, enumerate all paragraph bundle types across all content, not only from a sample node.

Gotchas

  • Drupal field storage and field instances are separate. Read both before mapping fields.

  • Revisions and moderation states may contain unpublished content not visible through public APIs.

  • Paragraphs can be deeply nested and reused differently across node types.

  • Views are presentation/query configuration; do not blindly model every View as content.

  • URL aliases, redirects, and menu links may live outside node records.

  • Translations may be entity-level or field-level depending on site configuration.

Validation Checklist

  • Compare counts by node type, taxonomy vocabulary, media type, language, and published/moderation state.

  • Confirm every field storage/field instance pair is mapped, skipped, or intentionally consolidated.

  • Confirm every Paragraph bundle has a Sanity object/block mapping or an intentional skip.

  • Confirm file/media references resolve to accessible assets.

  • Confirm aliases and redirects cover old public URLs.

  • Spot-check translated nodes and unpublished/draft content if they are in scope.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs Node.js

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Published by
Sanity
Publisher
Sanity (Official)
Source
sanity-io/agent-toolkit · skills/sanity-migration · commit 3ed3a14
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Sanity.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download sanity-migration.zip