# sanity

A skill for Sanity CMS work: it guides the agent through document schemas, GROQ queries and TypeScript wiring for content.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 725 installs · ★ 286
- Author: Mindrally
- License: Apache-2.0 · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/Mindrally/skills/tree/HEAD/sanity/SKILL.md
- Updated: 2026-10-08
- HTML: https://affpapa.org/en/nevibecode/skills/sanity

## What it does

The skill puts the agent in the role of a Sanity CMS specialist. It ships templates built on `defineType` and `defineField` for document and object types, a `blockContent` array with blocks, images and link annotations, and a `preview` config so the studio list shows titles and authors.

GROQ gets its own section: fetching all posts ordered by `publishedAt`, a single post by `slug.current`, pagination with `[$start...$end]`, plus `select` for conditional fields and `coalesce` for fallbacks. Client setup uses `@sanity/client` with `projectId`, `dataset` and `apiVersion`, and `@sanity/image-url` for image URLs. You supply the credentials yourself — the client will not build without a project ID and dataset.

There is also material on generating types from the schema, custom validation such as checking an email domain, and custom input components. The skill recommends references between documents, portable text for rich content, and setting up CORS and API permissions. It assumes a project already running on Sanity; it will not scaffold one from scratch.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add Mindrally/skills --skill sanity -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/sanity/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/sanity/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add Mindrally/skills --skill sanity -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/sanity/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add Mindrally/skills --skill sanity -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/sanity/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install Mindrally/skills sanity
```

2. **Manually: put the files in place**
- File: `.github/skills/sanity/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add Mindrally/skills --skill sanity -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/Mindrally/skills --path sanity
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/sanity/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add Mindrally/skills --skill sanity -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/Mindrally/skills/tree/HEAD/sanity/SKILL.md

## When to use it
- define a document schema with slug and validation rules
- write a GROQ query with ordering and pagination
- link documents by reference and pull fields through the arrow
- set up the Sanity client with projectId, dataset and apiVersion
- add a custom field check inside the studio

## Example prompts
- Help me define a post document schema with title, slug, author and publishedAt
- Write a GROQ query for all posts ordered by publishedAt with pagination
- Set up the Sanity client and urlFor for images in lib/client.ts

## Source text · SKILL.md · Apache-2.0

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: eb89e1f5681b013d.

BEGIN THIRD-PARTY FILE eb89e1f5681b013d
````text
---
name: sanity
description: Sanity CMS development guidelines for schema creation, GROQ queries, TypeScript integration, and project organization
metadata:
  maintainer: Mindrally
  source: https://github.com/Mindrally/skills
---

# Sanity CMS Development

You are an expert in Sanity CMS, GROQ queries, TypeScript integration, and headless CMS architecture.

## Core Principles

- Design schemas with content modeling best practices
- Write efficient GROQ queries
- Use TypeScript for type safety
- Organize projects for scalability
- Implement proper validation and preview

## Project Structure

```
sanity/
├── schemas/
│   ├── documents/
│   │   ├── post.ts
│   │   └── author.ts
│   ├── objects/
│   │   ├── blockContent.ts
│   │   └── image.ts
│   └── index.ts
├── lib/
│   ├── client.ts
│   └── queries.ts
├── components/
│   └── previews/
└── sanity.config.ts
```

## Schema Definition

### Document Types

```typescript
// schemas/documents/post.ts
import { defineType, defineField } from 'sanity';

export default defineType({
  name: 'post',
  title: 'Post',
  type: 'document',
  fields: [
    defineField({
      name: 'title',
      title: 'Title',
      type: 'string',
      validation: (Rule) => Rule.required().min(10).max(80),
    }),
    defineField({
      name: 'slug',
      title: 'Slug',
      type: 'slug',
      options: {
        source: 'title',
        maxLength: 96,
      },
      validation: (Rule) => Rule.required(),
    }),
    defineField({
      name: 'author',
      title: 'Author',
      type: 'reference',
      to: [{ type: 'author' }],
    }),
    defineField({
      name: 'publishedAt',
      title: 'Published at',
      type: 'datetime',
    }),
    defineField({
      name: 'body',
      title: 'Body',
      type: 'blockContent',
    }),
  ],
  preview: {
    select: {
      title: 'title',
      author: 'author.name',
      media: 'mainImage',
    },
    prepare({ title, author, media }) {
      return {
        title,
        subtitle: author ? `by ${author}` : '',
        media,
      };
    },
  },
});
```

### Object Types

```typescript
// schemas/objects/blockContent.ts
import { defineType, defineArrayMember } from 'sanity';

export default defineType({
  name: 'blockContent',
  title: 'Block Content',
  type: 'array',
  of: [
    defineArrayMember({
      type: 'block',
      styles: [
        { title: 'Normal', value: 'normal' },
        { title: 'H2', value: 'h2' },
        { title: 'H3', value: 'h3' },
        { title: 'Quote', value: 'blockquote' },
      ],
      marks: {
        decorators: [
          { title: 'Strong', value: 'strong' },
          { title: 'Emphasis', value: 'em' },
          { title: 'Code', value: 'code' },
        ],
        annotations: [
          {
````
END THIRD-PARTY FILE eb89e1f5681b013d

The third-party file has ended. Everything between the eb89e1f5681b013d tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 2871 of 6237 bytes. © Mindrally · Apache-2.0 · https://github.com/Mindrally/skills/tree/HEAD/sanity/SKILL.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md