Sanity Project

This is a Sanity-powered project. Use the Knowledge Router below to find Sanity guidance for your task. Available as a Claude Code plugin and Cursor plugin.

Commands

# MCP Setup
npx sanity@latest mcp configure  # Configure MCP for your AI editor

# Schema & Types
npx sanity schemas deploy     # Deploy schema to Content Lake for MCP/editor access
npx sanity schemas extract    # Extract schema for TypeGen
npx sanity typegen generate  # Generate TypeScript types

# Development
npx sanity dev               # Start Studio dev server
npx sanity build             # Build Studio for production
npx sanity deploy            # Deploy Studio to Sanity hosting

# Blueprints (infrastructure as code)
npx sanity blueprints init    # Initialize a Blueprint and create a Stack
npx sanity blueprints plan    # Preview infrastructure changes (read-only)
npx sanity blueprints deploy  # Apply the Blueprint to the Stack
npx sanity blueprints info    # Verify Stack status and deployed resources
npx sanity blueprints logs    # View Stack deployment logs

# Help
npx sanity docs search "query"  # Search Sanity documentation
npx sanity --help               # List all CLI commands

Knowledge Router

If the Sanity MCP server (https://mcp.sanity.io) is available, use list_sanity_rules and get_sanity_rules to load always up-to-date rules on demand. Otherwise, use the table below to find local reference files.

For the full reference index, see skills/sanity-best-practices/SKILL.md.

Using the Knowledge Router

Before modifying any code:

1. Identify which topics from the table above apply to your task
2. Read the corresponding reference file(s) using the file path
3. Follow the patterns and constraints defined in those references

Example: If asked to "create a blog post schema", read skills/sanity-best-practices/references/schema.md first.

Agent Behavior

• Specialize in Structured Content, GROQ, and Sanity Studio configuration.
• Write best-practice, type-safe code using Sanity TypeGen.
• Build scalable content platforms, not just websites.
• Detect the user's framework from package.json and consult the appropriate reference file.

MCP Server (Preferred for Content Operations)

Prefer MCP tools over writing scripts for content operations:

Content Operations:

Schema & Development:

Media & AI:

Releases:

Project Management:

Critical: After schema changes, deploy with deploy_schema so content tools see the latest schema. If using an MCP-managed Studio, redeploy it with deploy_studio after schema changes.

Boundaries

• Always:
  • Use defineQuery for all GROQ queries.
  • Prefer MCP tools for content operations (query, create, update, patch). For bulk migrations or when MCP is unavailable, NDJSON scripts are a valid alternative. Never use NDJSON scripts when MCP tools can accomplish the same task more simply.
  • Run deploy_schema after schema changes so MCP content tools use the latest schema. If a local Studio exists, update schema files first to keep them in sync with the deployed schema. If using an MCP-managed Studio, run deploy_studio after deploy_schema.
  • Follow the "Deprecation Pattern" when removing fields (ReadOnly -> Hidden -> Deprecated).
  • Run npm run typegen after schema or query changes (or enable automatic generation with typegen.enabled: true in sanity.cli.ts).
• Ask First:
  • Before modifying sanity.config.ts.
  • Before deleting any schema definition file.
• Never:
  • Hardcode API tokens (use process.env).
  • Use loose types (any) for Sanity content.