create-agent-with-sanity-context

$28

What You'll Need

Before starting, gather these credentials:

Credential

Where to get it

Sanity Project ID

Your sanity.config.ts or sanity.io/manage

Dataset name

Usually production — check your sanity.config.ts

Sanity API read token

Run npx sanity tokens add "Agent Context" --role=viewer --yes --json from the project directory (or pass --project-id=<id>). Alternatively, create at sanity.io/manage → Project → API → Tokens with Viewer role.

LLM API key

From your LLM provider (Anthropic, OpenAI, etc.) — any provider works

How Agent Context Works

An MCP server that gives AI agents structured access to Sanity content. The core integration pattern:

• MCP Connection: HTTP transport to the Agent Context URL

• Authentication: Bearer token using Sanity API read token

• Tool Discovery: Get available tools from MCP client, pass to LLM

• System Prompt: Tell the production agent its role, tone, and boundaries

MCP URL formats:

• https://api.sanity.io/v2026-03-03/agent-context/:projectId/:dataset — Base URL. No document needed, configure via query params or use as-is.

• https://api.sanity.io/v2026-03-03/agent-context/:projectId/:dataset/:slug — Document URL. Applies the configuration from an Agent Context document.

Agent Context documents (type sanity.agentContext) are created in Sanity Studio and configure the MCP endpoint. They have three fields:

Field

Schema field

Purpose

Slug

slug

Unique URL identifier — becomes the :slug in the MCP URL

Instructions

instructions

Domain-specific guidance for the agent, injected into tool descriptions

Content Filter

groqFilter

A GROQ expression scoping which documents the agent can access

This means Studio users can manage agent behavior without touching code — updating instructions or narrowing the content filter takes effect immediately.

URL query params override the document's configuration (useful for testing and development):

• ?instructions=<content> — Override instructions (use ?instructions="" for a blank slate)

• ?groqFilter=<expression> — Override the content filter

The integration is simple: Connect to the MCP URL, get tools, use them. The reference implementation shows one way to do this—adapt to your stack and LLM provider.

Available MCP Tools

Tool

Purpose

initial_context

Get compressed schema overview (types, fields, document counts)

groq_query

Execute GROQ queries with optional semantic search

schema_explorer

Get detailed schema for a specific document type

For development and debugging: The general Sanity MCP provides broader access to your Sanity project (schema deployment, document management, etc.). Useful during development but not intended for customer-facing applications.

Before You Start: Understand the User's Situation

A complete integration has four distinct components that may live in different places:

Component

What it is

Examples

1. Studio Setup

Configure the context plugin and create agent context documents

Sanity Studio (separate repo or embedded)

2. Agent Implementation

Code that connects to Agent Context and handles LLM interactions

Next.js API route, Express server, Python service, or any MCP-compatible client

3. Frontend

UI for users to interact with the agent

Chat widget, search interface, CLI—or none for backend services

4. Functions

Scheduled classification via Sanity Blueprints

sanity.blueprint.ts + functions/ directory — has its own placement constraints (see [Sanity Blueprints & Functions](#sanity-blueprints--functions))

A deployed Studio (v5.1.0+) is always required. Not every integration needs the agent context plugin or document—the base MCP URL works without them, so users can start with just agent implementation and add document configuration later—or vice versa. Frontend depends on the use case (many agents run as backend services or integrate into existing UIs).

Before writing any code, inspect the project to understand:

• Project layout: Read the top-level package.json (check for workspaces or a pnpm-workspace.yaml), locate the lockfile, and map out the distinct apps/packages. This determines where sanity.blueprint.ts and functions/ will go — see [Sanity Blueprints & Functions](#sanity-blueprints--functions).

• Their stack: What framework/runtime? (Next.js, Remix, Node server, Python, etc.)

• Their AI library: Vercel AI SDK, LangChain, direct API calls, etc.

• Their domain: What will the agent help with? (Shopping, docs, support, search, etc.)

• Which components they need help with: They may only need one or two.

• Components in different repos (most common): You may only have access to one component. Complete what you can, then tell the user what steps remain for the other repos.

• Co-located components: All in the same project—work through them based on what the user wants to tackle first.

• No Studio in the codebase? Ask the user if Studio setup is done elsewhere, or if they want to skip the agent context plugin and document for now—the base URL works without them.

The reference patterns use Next.js + Vercel AI SDK, but adapt to whatever the user is working with.

Workflow

Always present the full workflow. Even if the user's request seems narrow, inform them of all four steps — you don't have to implement everything, but they should know what's available. A working chatbot without Insights is only half the value. Walk the user through all four steps, explaining what each unlocks:

• Build the Agent — Get a working chatbot connected to their content

• Studio Setup — Configure the plugin and create an Agent Context document

• Conversation Insights — Track and classify conversations (this is what makes the data useful)

• Tune the Agent — Refine instructions and system prompt using the tuning skills

After completing each step, proactively present the next one. Only stop when all steps are done or the user explicitly defers.

Quick Validation (Optional)

Before building the production agent, validate that the MCP endpoint is reachable. If the user doesn't have a read token yet, offer to create one from the terminal — detect the projectId from sanity.config.ts or sanity.cli.ts if available:

npx sanity tokens add "Agent Context" --role=viewer --yes --json

This outputs JSON with the token value. If not inside a Sanity project directory, pass --project-id=<id> explicitly.

Then test the endpoint:

curl -X POST https://api.sanity.io/v2026-03-03/agent-context/:projectId/:dataset \

  -H "Authorization: Bearer $SANITY_API_READ_TOKEN" \

  -H "Content-Type: application/json" \

  -d '{"jsonrpc": "2.0", "method": "tools/list", "id": 1}'

This confirms the token works and the endpoint is reachable. The base URL (no slug) works without an Agent Context document—add a slug to apply a document's configuration.

Step 1: Build the Agent (Adapt to user's stack)

The user already has an agent or MCP client? They just need to connect it to their Agent Context URL with a Bearer token. The tools will appear automatically.

Building from scratch? Help the user set up the MCP connection and LLM integration. The reference implementations use Vercel AI SDK with Anthropic, but the pattern works with any LLM provider (OpenAI, local models, etc.). Start with the basics and add advanced patterns as needed.

Framework-specific guides:

• Next.js: See references/nextjs-agent.md

• SvelteKit: See references/sveltekit-agent.md

• Other stacks (Express, Remix, Python, LangChain): See references/adapting-to-stacks.md

System prompts (applies to all frameworks): See references/system-prompts.md for structure and domain-specific examples (e-commerce, docs, support, content curation).

The framework guides cover:

• Core setup (required): MCP connection, authentication, basic chat route

• Frontend (optional): Chat component for the framework, including markdown rendering (LLM responses are markdown — a renderer like react-markdown or marked is needed to display formatted output)

• Advanced patterns (optional): Client-side tools, auto-continuation, custom directive rendering

Step 2: Set up Sanity Studio

Help the user configure the @sanity/agent-context/studio plugin in their Studio and create an Agent Context document. This document controls what the production agent can see (via groqFilter) and what guidance it receives (via instructions).

See references/studio-setup.md

Step 3: Conversation Insights (Recommended)

Recommend the user sets up Insights. Without tracking, there's no way to know if the agent is actually helping users or failing silently. Insights shows you what users ask, where the agent struggles, and what content is missing — data you need to improve the agent over time.

What this unlocks:

• See which conversations succeed and which fail

• Discover content gaps — topics users ask about that the agent can't answer well

• Debug specific conversations with full transcripts

• Compare performance across multiple agents

Setup is two parts — do both:

• Telemetry — Add one integration to your existing streamText call (saves conversations)

• Classification — Deploy a scheduled function that analyzes conversations with AI

Telemetry without classification just stores raw conversations. Classification is what extracts success scores, sentiment, and content gaps — the actual insights. Always set up both.

Follow references/conversation-classification.md to set this up. The guide covers both parts end-to-end. The dashboard appears in Studio automatically once deployed.

Step 4: Tune Your Agent (Recommended)

Once the production agent works:

-

Tune the Instructions field using the dial-your-context skill — an interactive session where you explore the user's dataset together, verify findings, and produce concise Instructions that teach the production agent what the schema alone doesn't make obvious: counter-intuitive field names, second-order reference chains, data quality issues, required filters, and query patterns. The skill can also help configure a groqFilter to scope what content the production agent sees.

-

Shape the system prompt (optional) using the shape-your-agent skill — if the user controls the production agent's system prompt, this helps define tone, boundaries, and guardrails. Skip this if the user doesn't control the system prompt.

Sanity Blueprints & Functions

Scheduled classification uses Sanity Blueprints to deploy Sanity Functions.

Placement principles

Before adding files, search the project for an existing sanity.blueprint.ts. If one exists with deployed functions, add the new function there — even if it's not next to the lockfile. An existing working setup takes precedence over the default placement rules below. Only follow these rules when creating a new blueprint from scratch.

Find the project's lockfile (yarn.lock, pnpm-lock.yaml, or package-lock.json). Two rules for new blueprints:

• **sanity.blueprint.ts must be in the same directory as the lockfile.** The CLI detects the package manager from the lockfile. If no lockfile is present, pass --fn-installer pnpm (or npm/yarn) to the deploy command.

• **Function src paths are resolved relative to the blueprint file.** By default a function named classify-conversations maps to functions/classify-conversations/ next to the blueprint. Use the src property in defineScheduledFunction to point to a different directory.

In a monorepo with no existing blueprint, the lockfile is at the workspace root — so sanity.blueprint.ts and functions/ go there too, alongside the root package.json. However, if a blueprint already exists in a subdirectory (e.g. apps/studio/) and functions are successfully deploying from there, use that location. The CLI can work from subdirectories when configured correctly (e.g. with --fn-installer pnpm).

Dependencies: Functions use the package.json next to the blueprint for dependencies by default (project-level). Each function can alternatively have its own package.json (function-level), but a function uses one or the other — never both. See Sanity Functions: Dependencies.

Commands

Run from the directory containing sanity.blueprint.ts:

Command

Purpose

npx sanity blueprints init

Initialize the blueprint stack (first time only)

npx sanity blueprints promote

Promote to org scope (required for scheduled functions)

npx sanity blueprints doctor

Check blueprint health and flag issues

npx sanity blueprints plan

Preview what deploy will change

npx sanity blueprints deploy

Deploy blueprint and functions

npx sanity functions env add <fn> <key> <value>

Set an env var (after deploy)

npx sanity functions logs <name>

View function logs

npx sanity functions test <name> --with-user-token

Test function locally

GROQ with Semantic Search

Agent Context supports text::semanticSimilarity() for semantic ranking:

*[_type == "article" && category == "guides"]

  | score(text::semanticSimilarity("getting started tutorial"))

  | order(_score desc)

  { _id, title, summary }[0...10]

Always use order(_score desc) when using score() to get best matches first.

Adapting to Different Stacks

The MCP connection pattern is framework and LLM-agnostic. Whether Next.js, Remix, Express, or Python FastAPI—the HTTP transport works the same. Any LLM provider that supports tool calling will work.

See references/adapting-to-stacks.md for:

• Framework-specific route patterns (Express, Remix, Python)

• AI library integrations (LangChain, direct API calls)

See references/system-prompts.md for domain-specific examples (e-commerce, docs, support, content curation).

Best Practices

• Start simple: Build the basic integration first, then add advanced patterns as needed

• Schema design: Use descriptive field names—agents rely on schema understanding

• GROQ queries: Always include _id in projections so agents can reference documents

• Content filters: Use groqFilter to scope what the production agent sees — start broad, then narrow based on what it actually needs. The filter is a full GROQ expression (e.g., _type in ["product", "article"])

• Instructions field: Keep it concise — only include what the auto-generated schema doesn't make obvious. Don't duplicate schema information. See the dial-your-context skill.

• System prompts: Be explicit about forbidden behaviors and formatting rules. Less is more — an over-engineered prompt can interfere with the Instructions content. See the shape-your-agent skill.

• Package versions: Always use the latest version of @sanity/agent-context — run npm info @sanity/agent-context version to get it. For other packages, check the reference package.json files or use npm info <package> version. AI SDK and Sanity packages update frequently, and using outdated versions will cause errors that are hard to debug.

Troubleshooting

Agent Context returns errors or no schema

Agent Context requires a deployed Studio. See Deploy Your Studio for instructions.

"401 Unauthorized" from MCP

The SANITY_API_READ_TOKEN is missing or invalid. Generate a new token from the terminal:

npx sanity tokens add "Agent Context" --role=viewer --yes --json

Or create one at sanity.io/manage → Project → API → Tokens with Viewer role.

"No documents found" / Empty results

Check the Agent Context document's content filter (groqFilter):

• Is the GROQ filter correct?

• Are the document types spelled correctly?

• Are there published documents matching the filter?

Tools not appearing

• Check that mcpClient.tools() returns tools (log it)

• Ensure the MCP URL is correct (project ID, dataset, and optionally slug)

• If using a slug-based URL, verify the agent context document is published