Official agent skill

Sanity Plugin Authoring

Explain and create Sanity Studio plugins using the public plugin and tool APIs.

OfficialMITAuto-check passedDevelopment

Install Sanity Plugin Authoring

skills CLI

$ npx skills add sanity-io/sanity --skill sanity-plugin-authoring -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI

$ gh skill install sanity-io/sanity sanity-plugin-authoring --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy

$ git clone --depth 1 https://github.com/sanity-io/sanity.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/sanity-plugin-authoring .claude/skills/sanity-plugin-authoring && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Paste into Claude Code

Install the "sanity-plugin-authoring" agent skill from https://github.com/sanity-io/sanity/tree/main/.agents/skills/sanity-plugin-authoring into .claude/skills/sanity-plugin-authoring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "sanity-plugin-authoring", then confirm the skill loads.

Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

$skill-installer

$skill-installer install https://github.com/sanity-io/sanity/tree/main/.agents/skills/sanity-plugin-authoring

Type this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.

skills CLI

$ npx skills add sanity-io/sanity --skill sanity-plugin-authoring -a codex

Project install goes to .agents/skills/; add -g for ~/.codex/skills/.

GitHub CLI

$ gh skill install sanity-io/sanity sanity-plugin-authoring --agent codex

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/sanity-io/sanity.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/sanity-plugin-authoring .agents/skills/sanity-plugin-authoring && rm -rf skills-src

Use ~/.agents/skills/ instead of .agents/skills for a personal install.

Codex skills documentation · loads skills from .agents/skills/

Paste into Codex

Install the "sanity-plugin-authoring" agent skill from https://github.com/sanity-io/sanity/tree/main/.agents/skills/sanity-plugin-authoring into .agents/skills/sanity-plugin-authoring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "sanity-plugin-authoring", then confirm the skill loads.

Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add sanity-io/sanity --skill sanity-plugin-authoring -a cursor

Project install goes to .agents/skills/; add -g for ~/.cursor/skills/.

GitHub CLI

$ gh skill install sanity-io/sanity sanity-plugin-authoring --agent cursor

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/sanity-io/sanity.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/sanity-plugin-authoring .cursor/skills/sanity-plugin-authoring && rm -rf skills-src

Use ~/.cursor/skills/ instead of .cursor/skills for a personal install.

Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/

Paste into Cursor

Install the "sanity-plugin-authoring" agent skill from https://github.com/sanity-io/sanity/tree/main/.agents/skills/sanity-plugin-authoring into .cursor/skills/sanity-plugin-authoring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "sanity-plugin-authoring", then confirm the skill loads.

Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

gemini skills install

$ gemini skills install https://github.com/sanity-io/sanity.git --path .agents/skills/sanity-plugin-authoring

--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.

skills CLI

$ npx skills add sanity-io/sanity --skill sanity-plugin-authoring -a gemini-cli

Project install goes to .agents/skills/; add -g for ~/.gemini/skills/.

GitHub CLI

$ gh skill install sanity-io/sanity sanity-plugin-authoring --agent gemini-cli

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/sanity-io/sanity.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/sanity-plugin-authoring .gemini/skills/sanity-plugin-authoring && rm -rf skills-src

Use ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.

Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/

Paste into Gemini CLI

Install the "sanity-plugin-authoring" agent skill from https://github.com/sanity-io/sanity/tree/main/.agents/skills/sanity-plugin-authoring into .gemini/skills/sanity-plugin-authoring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "sanity-plugin-authoring", then confirm the skill loads.

Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

GitHub CLI

$ gh skill install sanity-io/sanity sanity-plugin-authoring

Installs for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).

skills CLI

$ npx skills add sanity-io/sanity --skill sanity-plugin-authoring -a github-copilot

Project install goes to .agents/skills/; add -g for ~/.copilot/skills/.

Manual copy

$ git clone --depth 1 https://github.com/sanity-io/sanity.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/sanity-plugin-authoring .github/skills/sanity-plugin-authoring && rm -rf skills-src

Use ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.

GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/

Paste into GitHub Copilot

Install the "sanity-plugin-authoring" agent skill from https://github.com/sanity-io/sanity/tree/main/.agents/skills/sanity-plugin-authoring into .github/skills/sanity-plugin-authoring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "sanity-plugin-authoring", then confirm the skill loads.

GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add sanity-io/sanity --skill sanity-plugin-authoring -a opencode

OpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.

GitHub CLI

$ gh skill install sanity-io/sanity sanity-plugin-authoring --agent opencode

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/sanity-io/sanity.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/sanity-plugin-authoring .opencode/skills/sanity-plugin-authoring && rm -rf skills-src

Use ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.

OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/

Paste into OpenCode

Install the "sanity-plugin-authoring" agent skill from https://github.com/sanity-io/sanity/tree/main/.agents/skills/sanity-plugin-authoring into .opencode/skills/sanity-plugin-authoring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "sanity-plugin-authoring", then confirm the skill loads.

OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

Facts

Skill name: sanity-plugin-authoring
GitHub stars: 6.4k
Token cost: ~1.3k tokens
SKILL.md length: 441 words
Files: 1
Skills in repo: 34
Repo updated: Oct 8, 2026
First seen: Oct 7, 2026
Licence: MIT

At a glance

Explain and create Sanity Studio plugins using the public plugin and tool APIs.

Works in 5 steps: Identify whether the feature is a… → Check existing plugin examples in the… → Choose a stable plugin name. → …
Creating user-facing plugins
SKILL.md covers What A Plugin Is, Configurable Plugins, What Plugins Can Provide and Tools In Plugins, plus 4 more sections
Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Sanity Plugin Authoring is an agent skill from sanity-io/sanity, published by the product's own GitHub organization. Explain and create Sanity Studio plugins using the public plugin and tool APIs. Use when creating user-facing plugins, adding tools through plugins, or when an agent needs to understand what a Sanity plugin can configure before applying monorepo-specific default plugin wiring.

Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Monorepo tooling. The repository describes itself as: Sanity Studio – Rapidly configure content workspaces powered by structured content. The licence is MIT.

When your agent uses it

Creating user-facing plugins
Adding tools through plugins
An agent needs to understand what a Sanity plugin can configure before applying monorepo-specific default plugin wiring

Example prompts

“/sanity-plugin-authoring”

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

Identify whether the feature is a plugin, a tool, a schema extension, a form extension, or a document extension.
Check existing plugin examples in the repo.
Choose a stable plugin name.
Decide whether the plugin needs options.
Add focused tests for the configured behavior.

What it can do on your machine

Read from SKILL.md and the folder at commit 73980e6. It shows what the files ask for, not the result of running them.

Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md (its code samples are typescript).
From the folder's file list and the shell code blocks in SKILL.md.
Network
Links to these hosts (documentation or services it may open):
- sanity.io
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Sanity Plugin Authoring loads about 1.3k tokens when it runs. Until then it costs about 75 tokens; SKILL.md has 441 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it: ~75
When it runs · the whole SKILL.md, loaded when a task matches: ~1.3k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from sanity-io/sanity at commit 73980e6, republished under its MIT licence (© sanity-io). 441 words, ~1,258 tokens.

Download SKILL.mdSave it as .claude/skills/sanity-plugin-authoring/SKILL.md (or your agent's skills folder).

name: sanity-plugin-authoring
description: Explain and create Sanity Studio plugins using the public plugin and tool APIs. Use when creating user-facing plugins, adding tools through plugins, or when an agent needs to understand what a Sanity plugin can configure before applying monorepo-specific default plugin wiring.

Sanity Plugin Authoring

What A Plugin Is

A Sanity Studio plugin is a named configuration bundle that can be added to a Studio through the plugins array. Plugin configuration accepts most workspace config properties, except workspace-owned settings such as dataset, projectId, auth, and theme.

Always give plugins a stable unique name. Prefer definePlugin() so editors expose useful types and autocomplete.

import {definePlugin} from 'sanity'

export const previewUrlPlugin = definePlugin({
  name: 'preview-url-plugin',
  document: {
    productionUrl: async (prev, {document}) => {
      const slug = document.slug?.current
      return slug ? `https://example.com/${slug}` : prev
    },
  },
})

Configurable Plugins

Use definePlugin((options) => ({...})) when callers need to configure behavior.

export const myPlugin = definePlugin<{enabled?: boolean}>((options) => ({
  name: 'my-plugin',
  tools: options.enabled === false ? [] : [myTool],
}))

Keep option namespaces extensible. Prefer object shapes such as {feature: {enabled: true}} instead of direct booleans when future settings are likely.

What Plugins Can Provide

Common plugin properties:

document: Document actions, badges, production URL resolvers, and new document defaults.
form: Form customizations, asset sources, and custom input rendering.
plugins: Nested plugins.
tools: Studio tools contributed by the plugin.
schema: Schema types and initial value templates.
studio: Studio component overrides and middleware.
i18n: Locale resource bundles used by plugin UI.
title: Human-readable plugin name.
onUncaughtError: Custom error handling, logging, or telemetry.

Use the smallest surface that solves the feature.

Tools In Plugins

A tool is a top-level Studio view with routing and predictable URLs. Tools commonly represent full-screen workflows such as Structure, Vision, Dashboard, or Presentation.

When adding a tool through a plugin:

Add it through the plugin tools property.
Give it a stable name, title, component, and router when needed.
Remember tool visual order is affected by the order tools are added, followed by tools added through plugins.
Use studio.components.toolMenu when the visual menu order needs custom rendering.
Use the top-level tools reducer pattern when changing the default opened tool, because visual menu order alone does not choose the default route.

Show full SKILL.md (170 more words)Show less

Studio Components

studio.components can customize parts of the Studio UI. Components that receive renderDefault are middleware: call props.renderDefault(props) unless intentionally replacing the default UI.

Use this for UI wrappers, navigation changes, or tool menu ordering. Be careful not to change scroll containers or layout ownership accidentally.

Locale Resources

If a plugin renders UI text, add an i18n bundle instead of hard-coding user-facing strings. The usual file shape is:

txt

feature/
├── i18n/
│   ├── index.ts
│   └── resources.ts
└── plugin/
    └── index.ts

In i18n/index.ts, define a namespace and default US English bundle:

import {type LocaleResourceBundle} from '../../i18n'

export const featureNamespace: 'feature' = 'feature'

export const featureUsEnglishLocaleBundle: LocaleResourceBundle = {
  locale: 'en-US',
  namespace: featureNamespace,
  resources: () => import('./resources'),
}

export type {FeatureLocaleResourceKeys} from './resources'

In i18n/resources.ts, export the default strings and key type:

const featureLocaleStrings = {
  'action.example': 'Example',
}

export type FeatureLocaleResourceKeys = keyof typeof featureLocaleStrings

export default featureLocaleStrings

Then register the bundle from the plugin:

import {featureUsEnglishLocaleBundle} from '../i18n'

export const feature = definePlugin({
  name: 'sanity/feature',
  i18n: {
    bundles: [featureUsEnglishLocaleBundle],
  },
})

Before Coding

Identify whether the feature is a plugin, a tool, a schema extension, a form extension, or a document extension.
Check existing plugin examples in the repo.
Choose a stable plugin name.
Decide whether the plugin needs options.
Add focused tests for the configured behavior.

For Sanity monorepo default plugin wiring, read sanity-core-plugin after this skill.

References

Files

Just SKILL.md in .agents/skills/sanity-plugin-authoring of sanity-io/sanity.

Open the folder on GitHubat commit 73980e6

Compare with similar skills

Sanity Plugin Authoring next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Sanity Plugin Authoring compared with similar skills
Skill	Stars	Used in	Tokens	Auto-check	Licence	Repo updated
Sanity Plugin Authoring this skillsanity-io/sanity	6.4k	—	~1.3k	Automated safety check: Pass	MIT	yesterday
Nx Importnrwl/nx	29k	6 repos	~3.5k	Automated safety check: Pass	MIT	yesterday
Nx Workspacenomcopter/react-mosaic	4.8k	8 repos	~1.9k	Automated safety check: Pass	Custom licence	11 days ago
Electron Multi-Process ArchitectureiOfficeAI/AionUi	33k	1 repos	~1.8k	Automated safety check: Pass	Apache-2.0	1 mo ago
Nx Run Tasksnomcopter/react-mosaic	4.8k	8 repos	~613	Automated safety check: Pass	Custom licence	11 days ago
Astro Developerwithastro/astro	63k	1 repos	~1.5k	Automated safety check: Pass	Custom licence	today

Similar skills

Nx Import
nrwl/nx
Import, merge, or combine repositories into an Nx workspace using nx import.
29k GitHub starsUsed in 6 repos~3.5k tokens
DevelopmentAuto-check passed
Nx Workspace
nomcopter/react-mosaic
Explore and understand Nx workspaces. An agent skill from nomcopter/react-mosaic.
4.8k GitHub starsUsed in 8 repos~1.9k tokens
DevelopmentAuto-check passed
Electron Multi-Process Architecture
iOfficeAI/AionUi
Tells the agent where new code belongs in an Electron multi-process project and which APIs each process may use, with rules for new bridges, services, agents and workers.
33k GitHub starsUsed in 1 repo~1.8k tokens
DevelopmentAuto-check passed
Nx Run Tasks
nomcopter/react-mosaic
Helps with running tasks in an Nx workspace. An agent skill from nomcopter/react-mosaic.
4.8k GitHub starsUsed in 8 repos~613 tokens
DevelopmentAuto-check passed
Astro Developer
withastro/astro
Official
Comprehensive guide for developing in the Astro monorepo. An agent skill from withastro/astro.
63k GitHub starsUsed in 1 repo~1.5k tokens
DevelopmentAuto-check passed
Migrate Internal Package into Ghost
TryGhost/Ghost
Moves a package from another TryGhost repository into Ghost as an internal workspace package while keeping its Git history, with checkpoints for the steps that need an administrator.
56k GitHub stars~3.8k tokensUpdated today
DevelopmentAuto-check passed

Questions about Sanity Plugin Authoring

What does Sanity Plugin Authoring do?

Explain and create Sanity Studio plugins using the public plugin and tool APIs. Sanity Plugin Authoring is an agent skill from sanity-io/sanity, published by the product's own GitHub organization. Explain and create Sanity Studio plugins using the public plugin and tool APIs.

When should I use Sanity Plugin Authoring?

Sanity Plugin Authoring fits situations like: creating user-facing plugins; adding tools through plugins; an agent needs to understand what a Sanity plugin can configure before applying monorepo-specific default plugin wiring.

How do I install Sanity Plugin Authoring in Claude Code?

Run `npx skills add sanity-io/sanity --skill sanity-plugin-authoring -a claude-code`. Or copy the skill folder (.agents/skills/sanity-plugin-authoring in sanity-io/sanity) into .claude/skills/sanity-plugin-authoring in your project. Claude Code loads it when a task matches its description.

How do I install Sanity Plugin Authoring in Codex?

Run `npx skills add sanity-io/sanity --skill sanity-plugin-authoring -a codex`. Or copy the skill folder (.agents/skills/sanity-plugin-authoring in sanity-io/sanity) into .agents/skills/sanity-plugin-authoring in your project. Codex loads it when a task matches its description.

Can I use Sanity Plugin Authoring in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add sanity-io/sanity --skill sanity-plugin-authoring -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/sanity-plugin-authoring, .gemini/skills/sanity-plugin-authoring, .github/skills/sanity-plugin-authoring and .opencode/skills/sanity-plugin-authoring in your project.

What does Sanity Plugin Authoring need to run?

SKILL.md names no scripts, command-line tools or credentials: Sanity Plugin Authoring is instructions for the agent only.

Does Sanity Plugin Authoring access the network?

SKILL.md names 1 domain. As links in the text: sanity.io. This is read from the text; nothing was executed.

Is Sanity Plugin Authoring safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Sanity Plugin Authoring use?

Sanity Plugin Authoring is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Sanity Plugin Authoring use?

About 1.3k tokens (SKILL.md is roughly 5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Sanity Plugin Authoring?

Skills that share tags, products or a category with Sanity Plugin Authoring: Nx Import (nrwl/nx, 29k stars), Nx Workspace (nomcopter/react-mosaic, 4.8k stars), Electron Multi-Process Architecture (iOfficeAI/AionUi, 33k stars) and Nx Run Tasks (nomcopter/react-mosaic, 4.8k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Sanity Plugin Authoring?

sanity-io (a GitHub organization, an official publisher) maintains it in sanity-io/sanity, which has 6,352 GitHub stars. The repository holds 34 skills in this directory. The repository was last updated on October 8, 2026.

Source: sanity-io/sanity on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.

Install Sanity Plugin Authoring

Facts

At a glance

What it does

When your agent uses it

Example prompts

Workflow steps

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

Sanity Plugin Authoring

What A Plugin Is

Configurable Plugins

What Plugins Can Provide

Tools In Plugins

Studio Components

Locale Resources

Before Coding

References

Files

Compare with similar skills

Similar skills

More from sanity-io/sanity

Related

Questions about Sanity Plugin Authoring