Sanity Agent Toolkit

Collection of resources to help AI agents build better with Sanity. Supports Cursor, Claude Code, VS Code, and any other editor/agent compatible with MCP or .mdc rules.

---

Features

• Agent rules: 20+ portable .mdc files covering schema design, GROQ, Visual Editing, SEO, localization, migrations, and front-end framework integrations.
• MCP server: Direct access to your Sanity projects (content, datasets, releases, schemas) and agent rules.
• Claude Code plugin: Slash commands and MCP integration for Claude Code users.
• Claude Code agent skills: Interactive workflows for schema scaffolding, visual editing setup, and type generation.

---

Get started

Choose your path based on how you want agents to work with Sanity:

1. MCP server — Give your agent always up-to-date rules and full access to your Sanity projects. No local files to maintain. Works with Cursor, VS Code, Claude Code, and other MCP-compatible editors.
2. Claude Code plugin — Adds interactive skills and slash commands on top of MCP for guided workflows.
3. Manual installation — Copy rules locally for offline use. You'll need to update them yourself.

Option 1: Install MCP server (recommended)

Give agents direct access to Sanity projects and always up-to-date agent rules via the MCP server.

Configure with Sanity CLI

Run in terminal to detect and configure MCP for Cursor, Claude Code and VS Code automatically:

npx sanity@latest mcp configure

Uses your logged-in CLI user for authentication — no API tokens or OAuth needed.

Cursor

One-click install →

Or add to .cursor/mcp.json:

{
  "mcpServers": {
    "Sanity": {
      "type": "http",
      "url": "https://mcp.sanity.io"
    }
  }
}

Claude Code

Run in terminal and authenticate with OAuth on next launch:

claude mcp add Sanity -t http https://mcp.sanity.io --scope user

VS Code

Command Palette → MCP: Open User Configuration → add:

{
  "servers": {
    "Sanity": {
      "type": "http",
      "url": "https://mcp.sanity.io"
    }
  }
}

See the Sanity MCP docs for more options and troubleshooting.

Option 2: Install Claude Code plugin

For Claude Code users, install the full plugin with skills and slash commands:

1. Add the Sanity marketplace:

/plugin marketplace add sanity-io/agent-toolkit

2. Install the plugin:

/plugin install sanity-plugin@sanity-agent-toolkit

3. Verify installation: Ask Claude Code: "which skills do you have access to?"

You should see the Sanity skills listed.

4. Start using: Use natural language and skills activate automatically:

Use the sanity-scaffold skill to create a blog post schema

Or run /sanity to explore all capabilities.

Option 3: Manual installation

Install the context rules locally to teach your editor Sanity best practices:

1. Create a rules directory: mkdir -p .cursor/rules
2. Copy the contents of the rules/ folder to your project's .cursor/rules/ directory.
3. (Recommended) Copy AGENTS.md to your project root to act as a knowledge router.

---

Capabilities

MCP tools

With MCP connected, your AI can use tools like:

• query_documents — run GROQ queries directly
• create_project — create a new Sanity project
• create_document_from_markdown — map markdown to Sanity documents
• patch_document — surgical edits to existing documents
• transform_image — edit images with AI
• list_sanity_rules / get_sanity_rules — load agent rules on demand

Slash commands (Claude Code)

Command	What it does
/sanity	List available skills and help topics
/review	Review code for Sanity best practices
/typegen	Run TypeGen and troubleshoot issues
/deploy-schema	Deploy schema with verification

Interactive skills (Claude Code)

Skills guide the AI through multi-step workflows in your codebase.

Skill	What it does	Example Trigger
Schema Scaffolder	Creates strict, well-typed schema definitions using best-practice templates.	"Create a blog post schema"
Visual Editing Setup	Detects your framework and configures loaders, stega, and overlays.	"Configure preview mode"
Schema Manager	Handles the full lifecycle: scaffolding, safe deprecation, and migrations.	"Deprecate the 'body' field"
GROQ Assistant	Writes optimized queries using defineQuery and proper projections.	"Write a query for recent posts"
TypeGen Fixer	Diagnoses and fixes TypeScript generation issues.	"Why are my types missing?"
Install Rules	Copies context rules to your project for local agent guidance.	"Install Sanity rules locally"

Getting started flow

The onboarding guide follows three phases:

1. Studio & Schema — Set up Sanity Studio and define your content model
2. Content — Import existing content or generate placeholder content via MCP
3. Frontend — Integrate with your application (framework-specific)

Just say: "Get started with Sanity" to begin.

Context rules

These files provide passive knowledge to the AI, ensuring generated code follows Sanity standards.

Core fundamentals

• sanity-schema.mdc: The "Data > Presentation" philosophy, defineType syntax, and shared fields.
• sanity-groq.mdc: Performance rules, fragment reuse, and the "Golden Rule" of projections.
• sanity-visual-editing.mdc: Implementation of Content Source Maps (Stega) and Presentation Tool.
• sanity-typegen.mdc: TypeScript type generation from schema.
• sanity-project-structure.mdc: File organization for Studio and monorepos.
• sanity-get-started.mdc: Interactive 3-phase onboarding guide.

Framework rules

• sanity-nextjs.mdc: App Router, defineLive, and metadata handling.
• sanity-remix.mdc: React Router loaders and data fetching patterns.
• sanity-svelte.mdc: SvelteKit hooks and loaders.
• sanity-nuxt.mdc: Nuxt modules and useSanityQuery.
• sanity-astro.mdc: Astro content collections and islands.
• sanity-hydrogen.mdc: Shopify Hydrogen and Sanity Connect.

Best practices

• sanity-migration.mdc: Strategies for importing HTML/Markdown from legacy CMSs.
• sanity-image.mdc: Hotspots, LQIP, and the urlFor builder.
• sanity-studio-structure.mdc: Organizing the Studio sidebar (singletons, groupings).
• sanity-portable-text.mdc: Rendering rich text with custom components.
• sanity-page-builder.mdc: Page builder patterns and block component rendering.
• sanity-localization.mdc: Internationalization patterns.
• sanity-seo.mdc: Metadata, sitemaps, and Open Graph.

---

Repository structure

sanity-io/agent-toolkit/
├── AGENTS.md                      # Knowledge router & agent behavior
├── README.md                      # This file
├── rules/                         # Context rules (.mdc)
│   ├── sanity-schema.mdc          # Schema design patterns
│   ├── sanity-get-started.mdc     # 3-phase onboarding guide
│   ├── sanity-nextjs.mdc          # Next.js integration
│   ├── sanity-remix.mdc           # React Router integration
│   └── ...                        # Additional rules
└── sanity-plugin/                 # Claude Code plugin
    ├── commands/                  # Slash commands
    │   ├── sanity.md              # /sanity help
    │   ├── review.md              # /review
    │   ├── typegen.md             # /typegen
    │   └── deploy-schema.md       # /deploy-schema
    └── skills/                    # Interactive workflows
        ├── sanity-scaffold/
        ├── sanity-visual-editing-setup/
        └── ...

---

Resources

• Create Sanity account
• Sanity documentation
• GROQ language reference
• Visual Editing guide
• Sanity TypeGen
• MCP server docs

---

Contributing

Found a better pattern? Missing a framework?

1. Fork the repo.
2. Update the relevant .mdc file in rules/.
3. Submit a PR.

---

Support

• Sanity Community (Discord)
• GitHub issues

---

License: MIT