PluginBench
Skill
Pass
Audit score 90

sanity-migration

sanity-io/agent-toolkit

Plan, implement, and validate CMS-to-Sanity migrations with structured ETL workflows.

What is sanity-migration?

This skill guides migrations from legacy CMSes (WordPress, Contentful, Strapi, Drupal, AEM, Webflow, Payload, Markdown, and others) into Sanity. Use it to design extraction, transformation, Portable Text conversion, asset migration, validation, and cutover strategies—treating migration as a content strategy project, not a blind lift-and-shift.

  • Plans content inventory, source-to-Sanity schema mapping, and extraction approaches for known platforms (WordPress, Contentful, Strapi, Drupal, AEM, Webflow, Payload, Markdown/MDX)
  • Designs deterministic ETL scripts with stable IDs, write order, asset handling, and rich-text-to-Portable-Text conversion
  • Produces validation checklists, redirect strategies, and cutover plans before go-live
  • Enforces Sanity modeling best practices: documents for reusable entities, Portable Text for rich content, uploaded assets instead of legacy CDN URLs
  • Provides platform-specific extraction routes, common modeling traps, and blind-spot checks for each source system

How to install sanity-migration

npx skills add https://github.com/sanity-io/agent-toolkit --skill sanity-migration
Prerequisites
  • Access to the source CMS (API credentials, export files, database connection, or WXR/XML dumps)
  • Target Sanity project and dataset ID (or permission to create a scratch dataset for testing)
  • Clarity on content scope: draft/archived/scheduled content, locales, asset accessibility, and schema design decisions
Claude Code
Cursor
Windsurf
Cline

How to use sanity-migration

  1. 1.Read `references/general.md` for shared migration principles and ETL best practices
  2. 2.Identify your source platform and read its dedicated guide (e.g., `references/wordpress.md`, `references/contentful.md`)
  3. 3.Work with the skill to produce a migration plan covering source access, content inventory, schema mapping, extraction approach, and cutover strategy
  4. 4.Write deterministic, repeatable extraction and transformation scripts; snapshot raw source data to disk before transforming
  5. 5.Use `createOrReplace` or `createIfNotExists` for idempotent imports; import referenced documents before documents that reference them
  6. 6.Convert rich text to Portable Text, upload assets to Sanity, and run validation checks (counts, samples, references, redirects) before cutover

Use cases

Good for
  • Migrating a WordPress site with custom post types, ACF fields, and media to Sanity with Portable Text rich text
  • Replatforming from Contentful to Sanity with schema redesign, locale handling, and asset re-upload
  • Converting Markdown/MDX documentation or frontmatter-based blogs into Sanity documents with structured metadata
  • Extracting content from AEM or Drupal via API or database dump, transforming hierarchies into flat Sanity documents
  • Planning a multi-locale migration from Webflow or Strapi with validation and delta-sync cutover strategy
Who it's for
  • Content strategists and migration leads planning CMS transitions
  • Backend engineers implementing ETL scripts and validation logic
  • Sanity implementation partners managing client replatforming projects
  • DevOps or data engineers handling large-scale content extractions and transformations

sanity-migration FAQ

What if my source CMS is not listed (AEM, Contentful, Strapi, etc.)?

Apply the general migration principles from `references/general.md` and adapt the closest platform pattern: use Contentful/Strapi/Payload guidance for API-first systems, WordPress/Drupal/Webflow for monolithic/page-builder systems, and Markdown guidance for HTML-heavy or Markdown-first exports.

Should I migrate all content or just published/live content?

Clarify scope upfront: decide whether to include drafts, archived, scheduled, or version history. The skill will help you design extraction and import logic that respects these boundaries.

How do I handle rich text (HTML, Markdown) conversion to Portable Text?

The skill provides platform-specific rich-text conversion guidance in each reference guide. Use deterministic parsing and block detection; do not store raw HTML or Markdown as the canonical body in Sanity.

What if asset URLs are no longer accessible or the legacy CDN is being shut down?

Plan asset migration upfront: download files during extraction, upload to Sanity or Media Library, and update references. Do not leave production content dependent on legacy CDN URLs.

How do I validate the migration before cutover?

The skill requires count checks (source vs. imported documents), sample checks (spot-verify content and references), reference integrity checks, and route/redirect validation. Produce a validation summary and address issues before go-live.

Full instructions (SKILL.md)

Source of truth, from sanity-io/agent-toolkit.


name: sanity-migration description: 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.

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.