
Sanity MCP server

2025.04.15
34
TypeScript内容管理系统文档管理语义搜索内容生成
Sanity MCP Server 是一个基于 Model Context Protocol 的服务,用于标准化 AI 模型与 Sanity 内容管理系统之间的交互。它提供了文档管理、GROQ 查询、发布管理、数据集管理等功能,并支持模式检查和语义搜索。适用于需要高效、结构化内容操作的场景。
View on GitHub
Overview
基本能力
产品定位
Sanity MCP Server 是一个基于 Model Context Protocol 的服务,用于标准化 AI 模型与 Sanity 内容管理系统之间的交互。
核心功能
- 通用工具:
get_initial_context
:获取初始上下文和使用说明。get_sanity_config
:从环境变量中获取 Sanity 配置。get_projects
:获取用户可访问的项目信息。-
get_studios
:列出项目的所有工作室主机。 -
文档管理:
- 支持文档的创建、更新、删除、发布和取消发布。
-
支持批量操作和事务处理。
-
发布管理:
-
支持创建发布、添加文档到发布、取消发布等操作。
-
数据集管理:
-
支持数据集的创建、更新和删除。
-
GROQ 查询:
-
支持执行 GROQ 查询。
-
嵌入和搜索:
-
支持语义搜索和嵌入索引管理。
-
模式检查:
- 提供模式类型概述和详细模式信息。
适用场景
- 内容管理系统(CMS)的自动化操作。
- 需要高效、结构化内容操作的场景。
- 语义搜索和嵌入索引管理。
工具列表
- 通用工具:
get_initial_context
,get_sanity_config
,get_projects
,get_studios
- 文档管理:
get_document_by_id
,create_document
,patch_document
,delete_document
,publish_document
等。 - 发布管理:
create_release
,add_document_to_release
,unpublish_document_from_release
等。 - 数据集管理:
create_dataset
,update_dataset
,delete_dataset
等。 - GROQ 查询:
execute_groq_query
- 嵌入和搜索:
list_embeddings_indices
,semantic_search
- 模式检查:
get_schema_overview
,get_type_schema_details
常见问题解答
- 如何调试?可以使用 modelcontextprotocol inspector 进行调试。
使用教程
使用依赖
安装依赖:
pnpm install
安装教程
- 安装依赖:
pnpm install
- 构建服务器:
pnpm run build
- 运行服务器:
pnpm start
调试方式
使用 modelcontextprotocol inspector 进行调试:
npx @modelcontextprotocol/inspector -e SANITY_API_TOKEN=<token> -e SANITY_PROJECT_ID=<project_id> -e SANITY_DATASET=<ds> -e SANITY_API_VERSION=<v> -e SANITY_API_HOST=<host> -e SANITY_PERSPECTIVE=<perspective> node <ABSOLUTE_PATH_TO>/build/index.js