Sanity MCP Server

🚀 Project Specification

This project specification provides a comprehensive guide on how to install, configure, and use the project, as well as security guidelines and other useful resources.

🚀 Quick Start

Install Dependencies

pnpm install

Start the Development Environment

pnpm run dev

Build the Service

pnpm run build

Start the Built Service

pnpm start

Debugging Tools

Use the MCP inspector for debugging:

npx @modelcontextprotocol/inspector -e SANITY_API_TOKEN=<token> -e SANITY_PROJECT_ID=<project_id> -e SANITY_DATASET=<ds> -e MCP_USER_ROLE=developer node path/to/build/index.js

This command provides a web interface for inspecting and testing available tools.

📦 Installation Guide

Quick Installation

npm install -g @modelcontextprotocol/servers

Create a New Project

mcp init

Answer the prompts and then run:

cd your_project_name && pnpm install

Start the Project

pnpm run dev

Install Dependencies

pnpm install

📚 Documentation

Environment Configuration

Create a .env file and add the following content:

SANITY_PROJECT_ID=your_project_id
SANITY_API_TOKEN=your_api_token
SANITY_DATASET=your_dataset_name
MCP_USER_ROLE=developer  # or editor

Configuration File Example

# .env
SANITY_PROJECT_ID=abc123
SANITY_API_TOKEN=sk-xyz789
SANITY_DATASET=MyProjectDataset
MCP_USER_ROLE=developer

Tool Guide

Using Tools

Run the following command in the project root directory:

npx mcp

Enter help to view available commands.

Common Commands

• Get all data:

  npx mcp get-all-data
  

• Search for content:

  npx mcp search --query "apple"
  

• Create a new document:

  npx mcp create-document --collection blog_posts --title "My First Blog Post" 
  

Environment Variable Reference

Security Guide

Environment Variable Management

• Use the .env file to store sensitive information.
• Avoid writing environment variables directly into the code.
• Ignore the .env file in version control.

Key Security

• Generate short and random API keys.
• Change keys regularly.
• Use HTTPS to transmit data.

Permission Management

• Set dataset permissions as needed.
• Review project permissions regularly.
• Apply the principle of least privilege.

Other Resources

• Official Documentation
• Example Projects
• Community Support