Sanity MCP-Server
Transformieren Sie Ihre Content-Operationen mit KI-gestützten Tools für mehr Sicherheit. Erstellen, verwalten und erkunden Sie Ihre Inhalte mithilfe natürlicher Sprachkonversationen in Ihrem bevorzugten KI-fähigen Editor.
Sanity MCP Server implementiert das Model Context Protocol , um Ihre Sanity-Projekte mit KI-Tools wie Claude, Cursor und VS Code zu verbinden. Es ermöglicht KI-Modellen, Ihre Inhaltsstruktur zu verstehen und Operationen durch natürliche Sprachanweisungen auszuführen.
✨ Hauptmerkmale
- 🤖 Content Intelligence : Lassen Sie KI Ihre Inhaltsbibliothek erkunden und verstehen
- 🔄 Content Operations : Automatisieren Sie Aufgaben durch Anweisungen in natürlicher Sprache
- 📊 Schema-Aware : KI respektiert Ihre Inhaltsstruktur und Validierungsregeln
- 🚀 Release-Management : Planen und organisieren Sie Content-Releases mühelos
- 🔍 Semantische Suche : Finden Sie Inhalte basierend auf der Bedeutung, nicht nur anhand von Schlüsselwörtern
Inhaltsverzeichnis
🔌 Schnellstart
Voraussetzungen
Bevor Sie den MCP-Server verwenden können, müssen Sie:
- Stellen Sie Ihr Sanity Studio mit Schemamanifest bereitDer MCP-Server benötigt Zugriff auf Ihre Inhaltsstruktur, um effektiv zu funktionieren. Stellen Sie Ihr Schemamanifest mit einem der folgenden Ansätze bereit:
# Option A: If you have the CLI installed globally
npm install -g sanity
cd /path/to/studio
sanity schema deploy
# Option B: Update your Studio
cd /path/to/studio
npm update sanity
npx sanity schema deploy
SANITY_AUTH_TOKEN=<token> sanity schema deploy
[!NOTE] Für die Schemabereitstellung ist Sanity CLI Version 3.88.1 oder neuer erforderlich.
- Holen Sie sich Ihre API-Anmeldeinformationen
- Projekt-ID
- Datensatzname
- API-Token mit entsprechenden Berechtigungen
Dieser MCP-Server kann mit jeder Anwendung verwendet werden, die das Model Context Protocol unterstützt. Hier sind einige beliebte Beispiele:
Konfiguration für den Sanity MCP-Server hinzufügen
Um den Sanity MCP-Server zu verwenden, fügen Sie den MCP-Einstellungen Ihrer Anwendung die folgende Konfiguration hinzu:
{
"mcpServers": {
"sanity": {
"command": "npx",
"args": ["-y", "@sanity/mcp-server@latest"],
"env": {
"SANITY_PROJECT_ID": "your-project-id",
"SANITY_DATASET": "production",
"SANITY_API_TOKEN": "your-sanity-api-token",
"MCP_USER_ROLE": "developer"
}
}
}
}
Eine vollständige Liste aller erforderlichen und optionalen Umgebungsvariablen finden Sie im Abschnitt „Konfiguration“ .
Der genaue Speicherort dieser Konfiguration hängt von Ihrer Anwendung ab:
| Anwendung | Konfigurationsspeicherort |
|---|
| Claude Desktop | Claude Desktop-Konfigurationsdatei |
| Cursor | Arbeitsbereich oder globale Einstellungen |
| VS Code | Arbeitsbereichs- oder Benutzereinstellungen (abhängig von der Erweiterung) |
| Benutzerdefinierte Apps | Weitere Informationen finden Sie in den MCP-Integrationsdokumenten Ihrer App. |
Sie bekommen es nicht zum Laufen? Weitere Informationen finden Sie im Abschnitt zur Node.js-Konfiguration .
Kontext und Setup
- get_initial_context – WICHTIG: Muss vor der Verwendung anderer Tools aufgerufen werden, um den Kontext zu initialisieren und Verwendungsanweisungen zu erhalten.
- get_sanity_config – Ruft die aktuelle Sanity-Konfiguration ab (Projekt-ID, Datensatz, API-Version usw.)
Dokumentvorgänge
- create_document – Erstellen Sie ein neues Dokument mit KI-generiertem Inhalt basierend auf Anweisungen
- update_document – Aktualisieren Sie ein vorhandenes Dokument mit KI-generierten Inhalten basierend auf Anweisungen
- patch_document - Wenden Sie direkte Patch-Operationen an, um bestimmte Teile eines Dokuments zu ändern, ohne die KI-Generierung zu verwenden.
- transform_document – Transformieren Sie Dokumentinhalte unter Beibehaltung von Formatierung und Struktur, ideal für Textersetzungen und Stilkorrekturen
- translate_document – Übersetzen Sie Dokumentinhalte in eine andere Sprache, wobei Formatierung und Struktur erhalten bleiben
- query_documents – Führen Sie GROQ-Abfragen aus, um Inhalte zu suchen und abzurufen
- document_action – Führen Sie Dokumentaktionen wie das Veröffentlichen, Aufheben der Veröffentlichung oder das Löschen von Dokumenten aus.
Release-Verwaltung
- list_releases – Listet Inhaltsveröffentlichungen auf, optional gefiltert nach Status
- create_release – Erstellen Sie eine neue Inhaltsversion
- edit_release – Metadaten für eine vorhandene Version aktualisieren
- schedule_release – Planen Sie die Veröffentlichung einer Version zu einem bestimmten Zeitpunkt
- release_action – Aktionen für Releases ausführen (veröffentlichen, archivieren, Archivierung aufheben, Planung aufheben, löschen)
Versionsverwaltung
- create_version – Erstellen Sie eine Version eines Dokuments für eine bestimmte Version
- discard_version – Löschen Sie ein bestimmtes Versionsdokument aus einer Version
- mark_for_unpublish – Markieren Sie ein Dokument als unveröffentlicht, wenn eine bestimmte Version veröffentlicht wird
Datensatzverwaltung
- get_datasets – Listet alle Datensätze im Projekt auf
- create_dataset – Erstellen Sie einen neuen Datensatz
- update_dataset – Datensatzeinstellungen ändern
Schemainformationen
- get_schema – Schemadetails abrufen, entweder das vollständige Schema oder für einen bestimmten Typ
- list_workspace_schemas – Ruft eine Liste aller verfügbaren Arbeitsbereichsschemanamen ab
GROQ-Unterstützung
- get_groq_specification – Holen Sie sich die Zusammenfassung der GROQ-Sprachspezifikation
Einbettungen und semantische Suche
- list_embeddings_indices – Listet alle verfügbaren Einbettungsindizes auf
- semantic_search – Semantische Suche in einem Einbettungsindex durchführen
- list_projects – Listet alle Sanity-Projekte auf, die mit Ihrem Konto verknüpft sind
- get_project_studios – Holen Sie sich Studioanwendungen, die mit einem bestimmten Projekt verknüpft sind
⚙️ Konfiguration
Der Server verwendet die folgenden Umgebungsvariablen:
| Variable | Beschreibung | Erforderlich |
|---|
SANITY_API_TOKEN | Ihr Sanity API-Token | ✅ |
SANITY_PROJECT_ID | Ihre Sanity-Projekt-ID | ✅ |
SANITY_DATASET | Der zu verwendende Datensatz | ✅ |
MCP_USER_ROLE | Bestimmt die Zugriffsebene des Tools (Entwickler oder Editor) | ✅ |
SANITY_API_HOST | API-Host (standardmäßig https://api.sanity.io ) | ❌ |
[!WARNING] > KI mit Produktionsdatensätzen verwenden: Wenn Sie den MCP-Server mit einem Token konfigurieren, das Schreibzugriff auf einen Produktionsdatensatz hat, beachten Sie bitte, dass die KI destruktive Aktionen wie das Erstellen, Aktualisieren oder Löschen von Inhalten ausführen kann. Dies ist kein Problem, wenn Sie einen schreibgeschützten Token verwenden. Während wir aktiv Leitplanken entwickeln, sollten Sie vorsichtig sein und die Verwendung eines Entwicklungs-/Staging-Datensatzes zum Testen von KI-Operationen in Betracht ziehen, die Schreibzugriff erfordern.
🔑 API-Token und Berechtigungen
Der MCP-Server benötigt entsprechende API-Token und Berechtigungen, um ordnungsgemäß zu funktionieren. Folgendes müssen Sie wissen:
- Generieren Sie ein Roboter-Token :
- Gehen Sie zur Verwaltungskonsole Ihres Projekts: Einstellungen > API > Token
- Klicken Sie auf „Neues Token hinzufügen“.
- Erstellen Sie ein dediziertes Token für die Nutzung Ihres MCP-Servers
- Bewahren Sie den Token sicher auf – er wird nur einmal angezeigt!
- Erforderliche Berechtigungen :
- Das Token benötigt die entsprechenden Berechtigungen basierend auf Ihrer Nutzung
- Für grundlegende Lesevorgänge: Die Rolle
viewer ist ausreichend - Für die Inhaltsverwaltung:
editor oder developer empfohlen - Für erweiterte Vorgänge (wie das Verwalten von Datensätzen): Möglicherweise ist die
administrator erforderlich
- Datensatzzugriff :
- Öffentliche Datensätze: Inhalte sind für nicht authentifizierte Benutzer lesbar
- Private Datensätze: Erfordern eine ordnungsgemäße Token-Authentifizierung
- Entwurfs- und versionierter Inhalt: Nur für authentifizierte Benutzer mit entsprechenden Berechtigungen zugänglich
- Bewährte Sicherheitspraktiken :
- Verwenden Sie separate Token für unterschiedliche Umgebungen (Entwicklung, Staging, Produktion).
- Übergeben Sie Token niemals der Versionskontrolle
- Erwägen Sie die Verwendung von Umgebungsvariablen für die Tokenverwaltung
- Wechseln Sie die Token regelmäßig aus Sicherheitsgründen
👥 Benutzerrollen
Der Server unterstützt zwei Benutzerrollen:
- Entwickler : Zugriff auf alle Tools
- Editor : Inhaltsorientierte Tools ohne Projektverwaltung
📦 Einrichten der Node.js-Umgebung
Wichtig für Nutzer des Node Version Managers : Wenn Sie nvm , mise , fnm , nvm-windows oder ähnliche Tools verwenden, müssen Sie die folgenden Einrichtungsschritte befolgen, um sicherzustellen, dass MCP-Server auf Node.js zugreifen können. Dies ist eine einmalige Einrichtung, die Ihnen spätere Fehlerbehebungszeit erspart. Dies ist ein fortlaufendes Problem mit MCP-Servern.
🛠 Schnelleinrichtung für Benutzer des Node Version Managers
- Aktivieren Sie zunächst Ihre bevorzugte Node.js-Version:
# Using nvm
nvm use 20 # or your preferred version
# Using mise
mise use node@20
# Using fnm
fnm use 20
- Erstellen Sie dann die erforderlichen symbolischen Links (wählen Sie Ihr Betriebssystem aus):Unter macOS/Linux:
sudo ln -sf "$(which node)" /usr/local/bin/node && sudo ln -sf "$(which npx)" /usr/local/bin/npx
[!NOTE] Obwohl bei der Verwendung sudo im Allgemeinen Vorsicht geboten ist, ist es in diesem Kontext aus folgenden Gründen sicher:
- Wir erstellen nur symbolische Links zu Ihren vorhandenen Node.js-Binärdateien
- Das Zielverzeichnis (
/usr/local/bin ) ist ein Standardsystemspeicherort für vom Benutzer installierte Programme - Die symbolischen Links verweisen nur auf Binärdateien, die Sie bereits installiert haben und denen Sie vertrauen
- Sie können diese Symlinks später einfach mit
sudo rm entfernen
Unter Windows (PowerShell als Administrator):New-Item -ItemType SymbolicLink -Path "C:\Program Files\nodejs\node.exe" -Target (Get-Command node).Source -Force
New-Item -ItemType SymbolicLink -Path "C:\Program Files\nodejs\npx.cmd" -Target (Get-Command npx).Source -Force
- Überprüfen Sie das Setup:
# Should show your chosen Node version
/usr/local/bin/node --version # macOS/Linux
"C:\Program Files\nodejs\node.exe" --version # Windows
🤔 Warum ist das nötig?
MCP-Server werden durch den direkten Aufruf von node und npx Binärdateien gestartet. Bei Verwendung von Node-Versionsmanagern werden diese Binärdateien in isolierten Umgebungen verwaltet, auf die Systemanwendungen nicht automatisch zugreifen können. Die oben genannten symbolischen Links bilden eine Brücke zwischen Ihrem Versionsmanager und den von MCP-Servern verwendeten Systempfaden.
🔍 Fehlerbehebung
Wenn Sie häufig die Node-Version wechseln:
- Denken Sie daran, Ihre Symlinks zu aktualisieren, wenn Sie die Node-Versionen ändern
- Sie können einen Shell-Alias oder ein Skript erstellen, um dies zu automatisieren:
# Example alias for your .bashrc or .zshrc
alias update-node-symlinks='sudo ln -sf "$(which node)" /usr/local/bin/node && sudo ln -sf "$(which npx)" /usr/local/bin/npx'
So entfernen Sie die symbolischen Links später:
# macOS/Linux
sudo rm /usr/local/bin/node /usr/local/bin/npx
# Windows (PowerShell as Admin)
Remove-Item "C:\Program Files\nodejs\node.exe", "C:\Program Files\nodejs\npx.cmd"
💻 Entwicklung
Installieren Sie Abhängigkeiten:
Erstellen und Ausführen im Entwicklungsmodus:
Erstellen Sie den Server:
Führen Sie den erstellten Server aus:
Debuggen
Zum Debuggen können Sie den MCP-Inspektor verwenden:
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
Dadurch wird eine Weboberfläche zum Überprüfen und Testen der verfügbaren Tools bereitgestellt.