Sanity MCP Server

🚀 項目規範

本項目規範涵蓋了項目的安裝、啟動、調試、工具使用等多方面內容，為開發者提供了清晰的操作指引，確保項目的順利開發與部署。

🚀 快速開始

安裝依賴

pnpm install

開發環境啟動

pnpm run dev

構建服務

pnpm run build

啟動構建後的服務

pnpm start

📦 安裝指南

快速安裝

npm install -g @modelcontextprotocol/servers

創建新項目

mcp init

按照提示回答問題，然後運行：

cd your_project_name && pnpm install

啟動項目

pnpm run dev

💻 使用示例

調試工具

使用MCP inspector進行調試：

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

此命令提供一個Web界面，用於 inspect 和測試可用工具。

工具使用

基礎用法

在項目根目錄運行：

npx mcp

輸入 help 查看可用命令。

高級用法

• 獲取所有數據：

  npx mcp get-all-data
  

• 搜索內容：

  npx mcp search --query "apple"
  

• 創建新文檔：

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

📚 詳細文檔

環境配置

創建一個 .env 文件，並添加以下內容：

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

配置文件示例

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

環境變量參考

安全指南

環境變量管理

• 使用 .env 文件存儲敏感信息。
• 避免將環境變量直接寫入代碼。
• 在版本控制中忽略 .env 文件。

密鑰安全

• 生成短且隨機的API密鑰。
• 定期更換密鑰。
• 使用 HTTPS 傳輸數據。

權限管理

• 根據需要設置數據集權限。
• 定期審查項目權限。
• 使用最小權限原則。

其他資源

• 官方文檔
• 示例項目
• 社區支持