MCP Sitecore Server

🚀 Sitecore的模型上下文協議服務器

本項目是一個用於Sitecore的模型上下文協議服務器，提供了豐富的API工具，可用於處理GraphQL、項目服務、安全、索引等多個方面的操作，幫助開發者更高效地與Sitecore進行交互。

✨ 主要特性

已實現的工具

• GraphQL API

  • introspection-grahpql-{schema}：返回GraphQL模式
  • query-graphql-{schema}：執行GraphQL查詢

• 項目服務API

  • item-service-get-item：按ID返回項目
  • item-service-get-item-children：按ID返回項目的子項
  • item-service-get-item-by-path：按路徑返回項目
  • item-service-create-item：通過提供模板ID和父路徑創建項目
  • item-service-edit-item：按ID編輯項目
  • item-service-delete-item：按ID刪除項目
  • item-service-search-items：搜索項目
  • item-service-run-stored-query：運行存儲的查詢
  • item-service-run-stored-search：運行存儲的搜索
  • 複合項目服務API
    • item-service-get-languages：返回實例中的Sitecore語言
    • item-service-get-item-descendants：按ID返回項目的後代

• Sitecore Powershell（部分實現）

  • get-powershell-documentation：返回描述所有Sitecore Powershell命令的文檔
  • run-powershell-script：運行PowerShell腳本並返回輸出
  • 安全
    • security-get-current-user：返回當前用戶
    • security-get-user-by-identity：按名稱返回用戶
    • security-get-user-by-filter：按過濾器返回用戶
    • security-new-domain：創建新域
    • security-new-user：創建新用戶
    • security-new-role：創建新角色
    • security-remove-domain：刪除域
    • security-remove-user：刪除用戶
    • security-remove-role：刪除角色
    • security-get-domain：返回域
    • security-get-domain-by-name：按名稱返回域
    • security-get-role-by-identity：按名稱返回角色
    • security-get-role-by-filter：按過濾器返回角色
    • security-get-role-member：返回角色的成員
    • security-enable-user：啟用用戶
    • security-disable-user：禁用用戶
    • security-set-user-password：更改用戶密碼
    • security-lock-item-by-id：按ID鎖定項目
    • security-unlock-item-by-id：按ID解鎖項目
    • security-lock-item-by-path：按路徑鎖定項目
    • security-unlock-item-by-path：按路徑解鎖項目
    • security-protect-item-by-id：按ID保護項目
    • security-protect-item-by-path：按路徑保護項目
    • security-unprotect-item-by-id：按ID取消保護項目
    • security-unprotect-item-by-path：按路徑取消保護項目
    • security-test-acccount：測試賬戶
    • security-unlock-user：解鎖用戶
    • security-add-role-member：向角色添加成員
    • security-remove-role-member：從角色中移除成員
    • security-test-item-acl-by-id：按ID測試項目的ACL
    • security-test-item-acl-by-path：按路徑測試項目的ACL
    • security-add-item-acl-by-id：按ID添加項目的ACL
    • security-add-item-acl-by-path：按路徑添加項目的ACL
    • security-clear-item-acl-by-id：按ID清除項目的ACL
    • security-clear-item-acl-by-path：按路徑清除項目的ACL
    • security-set-item-acl-by-id：按ID設置項目的ACL
    • security-set-item-acl-by-path：按路徑設置項目的ACL
  • 提供者
    • provider-get-item-by-id：按ID返回項目
    • provider-get-item-by-path：按路徑返回項目
    • provider-get-item-by-query：按查詢返回項目
  • 展示
    • presentation-get-layout-by-id：按ID返回項目展示佈局
    • presentation-get-layout-by-path：按路徑返回項目展示佈局
    • presentation-set-layout-by-id：按ID設置項目展示佈局
    • presentation-set-layout-by-path：按路徑設置項目展示佈局
    • presentation-reset-layout-by-id：按ID重置項目展示佈局
    • presentation-reset-layout-by-path：按路徑重置項目展示佈局
    • presentation-merge-layout-by-id：按項目ID合併最終和共享佈局
    • presentation-merge-layout-by-path：按項目路徑合併最終和共享佈局
    • presentation-get-layout-device：獲取指定設備的佈局
    • presentation-get-default-layout-device：獲取默認佈局
    • presentation-get-rendering-by-id：按項目ID獲取渲染定義
    • presentation-get-rendering-by-path：按項目路徑獲取渲染定義
    • presentation-remove-rendering-by-path：按所有者項目路徑從項目中移除渲染
    • presentation-remove-rendering-by-id：按所有者項目ID從項目中移除渲染
    • presentation-add-rendering-by-path：按路徑向指定項目的展示中添加渲染
    • presentation-add-rendering-by-id：按項目ID向指定項目的展示中添加渲染
    • presentation-set-rendering-by-path：用新值更新按項目路徑指定的渲染
    • presentation-set-rendering-by-id：用新值更新按項目ID指定的渲染
    • presentation-switch-rendering-by-id：用備用渲染替換按項目ID指定的現有渲染
    • presentation-switch-rendering-by-path：用備用渲染替換按路徑指定的現有渲染
    • presentation-switch-rendering-by-unique-id：用備用渲染替換按唯一ID指定的現有渲染
    • presentation-get-placeholder-setting-by-id：獲取按ID指定的項目上分配的佔位符設置
    • presentation-get-placeholder-setting-by-path：獲取按路徑指定的項目上分配的佔位符設置
    • presentation-add-placeholder-setting-by-id：向按ID指定的項目添加佔位符設置
    • presentation-add-placeholder-setting-by-path：向按路徑指定的項目添加佔位符設置
    • presentation-remove-placeholder-setting-by-id：從按ID指定的項目中移除佔位符設置
    • presentation-remove-placeholder-setting-by-path：從按路徑指定的項目中移除佔位符設置
    • presentation-get-rendering-parameter-by-id：獲取按ID指定的項目的渲染參數
    • presentation-get-rendering-parameter-by-path：獲取按路徑指定的項目的渲染參數
    • presentation-remove-rendering-parameter-by-id：從按ID指定的項目上的渲染中移除指定的渲染參數
    • presentation-remove-rendering-parameter-by-path：從按路徑指定的項目上的渲染中移除指定的渲染參數
    • presentation-set-rendering-parameter-by-id：向按ID指定的項目上的渲染添加並更新指定的渲染參數
    • presentation-set-rendering-parameter-by-path：向按路徑指定的項目上的渲染添加並更新指定的渲染參數
  • 索引
    • indexing-initialize-search-index：初始化一個或多個搜索索引
    • indexing-get-search-index：返回搜索索引
    • indexing-find-item：在搜索索引中查找項目
    • indexing-suspend-search-index：暫停一個或多個正在運行的搜索索引
    • indexing-stop-search-index：停止一個或多個正在運行的搜索索引
    • indexing-resume-search-index：恢復一個或多個暫停的搜索索引
    • indexing-initialize-search-index-item-by-id：按ID和索引名稱為指定根項目的給定樹重建索引
    • indexing-initialize-search-index-item-by-path：按路徑和索引名稱為指定根項目的給定樹重建索引
    • indexing-remove-search-index-item-by-id：從搜索索引中移除具有指定ID的項目
    • indexing-remove-search-index-item-by-path：從搜索索引中移除具有指定路徑的項目
  • 通用
    • common-add-base-template-by-id：按ID向模板項目添加基礎模板
    • common-add-base-template-by-path：按路徑向模板項目添加基礎模板
    • common-add-item-version-by-id：根據現有語言版本在新語言中為項目（按ID）創建版本
    • common-add-item-version-by-path：根據現有語言版本在新語言中為項目（按路徑）創建版本
    • common-convert-from-item-clone-by-id：按ID將項目從克隆轉換為完全獨立的項目
    • common-convert-from-item-clone-by-path：按路徑將項目從克隆轉換為完全獨立的項目
    • common-get-archive：獲取Sitecore數據庫存檔
    • common-get-archive-item：獲取指定存檔中找到的項目列表
    • common-get-cache：獲取有關Sitecore緩存的信息
    • common-get-database：獲取有關Sitecore數據庫的信息
    • common-get-item-field-by-id：按ID將項目字段作為名稱、字段或模板字段獲取
    • common-get-item-field-by-path：按路徑將項目字段作為名稱、字段或模板字段獲取
    • common-get-item-clone-by-id：按ID獲取指定項目的所有克隆
    • common-get-item-clone-by-path：按路徑獲取指定項目的所有克隆
    • common-get-item-reference-by-id：按ID獲取Sitecore項目的項目引用（其使用位置）
    • common-get-item-reference-by-path：按路徑獲取Sitecore項目的項目引用（其使用位置）
    • common-get-item-referrer-by-id：按ID獲取引用Sitecore項目的項目（哪些項目引用它）
    • common-get-item-referrer-by-path：按路徑獲取引用Sitecore項目的項目（哪些項目引用它）
    • common-get-item-template-by-id：按ID獲取Sitecore項目的模板信息
    • common-get-item-template-by-path：按路徑獲取Sitecore項目的模板信息
    • common-get-item-workflow-event-by-id：按ID獲取指定項目的工作流歷史記錄條目
    • common-get-item-workflow-event-by-path：按路徑獲取指定項目的工作流歷史記錄條目
    • common-get-sitecore-job：獲取當前Sitecore作業列表
    • common-invoke-workflow-by-id：按ID為Sitecore項目執行工作流操作
    • common-invoke-workflow-by-path：按路徑為Sitecore項目執行工作流操作
    • common-new-item-clone-by-id：根據按ID提供的項目創建新的項目克隆
    • common-new-item-clone-by-path：根據按路徑提供的項目創建新的項目克隆
    • common-new-item-workflow-event-by-id：按ID為Sitecore項目的工作流歷史記錄創建新條目
    • common-new-item-workflow-event-by-path：按路徑為Sitecore項目的工作流歷史記錄創建新條目
    • common-publish-item-by-id：按ID發佈Sitecore項目
    • common-publish-item-by-path：按路徑發佈Sitecore項目
    • common-remove-archive-item：從指定存檔中永久移除項目
    • common-remove-base-template-by-id：按ID從模板項目中移除基礎模板
    • common-remove-base-template-by-path：按路徑從模板項目中移除基礎模板
    • common-remove-item-version-by-id：按ID移除Sitecore項目的版本
    • common-remove-item-version-by-path：按路徑移除Sitecore項目的版本
    • common-reset-item-field-by-id：按ID重置項目字段，指定為名稱、字段或模板字段
    • common-reset-item-field-by-path：按路徑重置項目字段，指定為名稱、字段或模板字段
    • common-restart-application：重啟Sitecore應用程序池
    • common-restore-archive-item：將項目從指定存檔恢復到原始數據庫
    • common-set-item-template-by-id：按ID設置項目模板
    • common-set-item-template-by-path：按路徑設置項目模板
    • common-test-base-template-by-id：按ID檢查項目是否繼承自指定模板
    • common-test-base-template-by-path：按路徑檢查項目是否繼承自指定模板
    • common-update-item-referrer-by-id：更新對指定項目（按ID）的所有引用，使其指向 -NewTarget 中提供的新目標，或移除對該項目的鏈接
    • common-update-item-referrer-by-path：更新對指定項目（按路徑）的所有引用，使其指向 -NewTarget 中提供的新目標，或移除對該項目的鏈接
  • 日誌記錄
    • logging-get-logs：從日誌目錄中檢索Sitecore日誌，並提供過濾選項

• Sitecore CLI（部分實現）

  • sitecore-cli-documentation：獲取Sitecore CLI文檔，為大語言模型提供更多上下文

工具選擇

AI代理在使用工具的數量上可能有限制。請確保禁用不需要的工具，這將使您的代理更快、更便宜且更高效。

📦 安裝指南

將以下模型上下文協議服務器添加到您的Cursor、VS Code、Claude中：

{
    "Sitecore": {
        "type": "stdio",
        "command": "npx",
        "args": ["@antonytm/mcp-sitecore-server@latest"],
        "env": {
            "TRANSPORT": "stdio",
            "GRAPHQL_ENDPOINT": "https://xmcloudcm.localhost/sitecore/api/graph/",
            "GRAPHQL_SCHEMAS": "edge,master,core",
            "GRAPHQL_API_KEY": "{6D3F291E-66A5-4703-887A-D549AF83D859}",
            "GRAPHQL_HEADERS": "",
            "ITEM_SERVICE_DOMAIN": "sitecore",
            "ITEM_SERVICE_USERNAME": "admin",
            "ITEM_SERVICE_PASSWORD": "b",
            "ITEM_SERVICE_SERVER_URL": "https://xmcloudcm.localhost/",
            "POWERSHELL_DOMAIN": "sitecore",
            "POWERSHELL_USERNAME": "admin",
            "POWERSHELL_PASSWORD": "b",
            "POWERSHELL_SERVER_URL": "https://xmcloudcm.localhost/"
        }
    }
}

環境變量說明

• TRANSPORT：要使用的傳輸協議。選項包括 streamable-http、stdio 或 sse。
• GRAPHQL_ENDPOINT：Sitecore實例的GraphQL端點URL。
• GRAPHQL_SCHEMAS：用於GraphQL API的Sitecore模式，用逗號分隔。
• GRAPHQL_API_KEY：GraphQL端點的API密鑰。
• GRAPHQL_HEADERS：GraphQL請求中要包含的其他標頭。
• ITEM_SERVICE_DOMAIN：項目服務API身份驗證的域。默認為 sitecore。
• ITEM_SERVICE_USERNAME：項目服務API身份驗證的用戶名。
• ITEM_SERVICE_PASSWORD：項目服務API身份驗證的密碼。
• ITEM_SERVICE_SERVER_URL：項目服務API的基本URL。
• POWERSHELL_DOMAIN：Sitecore PowerShell遠程API身份驗證的域。默認為 sitecore。
• POWERSHELL_USERNAME：Sitecore PowerShell遠程API身份驗證的用戶名。
• POWERSHELL_PASSWORD：Sitecore PowerShell遠程API身份驗證的密碼。
• POWERSHELL_SERVER_URL：Sitecore PowerShell遠程API的基本URL。
• AUTORIZATION_HEADER：可選。如果設置，它將用作訪問服務器的授權標頭。MCP服務器將期望傳遞具有此環境變量值的 authorization 標頭。如果未設置環境變量，服務器將不檢查授權標頭。

Docker鏡像

• antonytm/mcp-sitecore-linux：MCP Sitecore服務器的Linux版本。
• antonytm/mcp-sitecore-windows：MCP Sitecore服務器的Windows版本。

資源列表

• config：返回服務器的配置。使用它來檢查是否一切都已正確配置。

本地安裝/開發

1. 克隆倉庫
2. 運行 npm install 安裝依賴項
3. 運行 npm run build 構建項目
4. 運行 npm start 啟動服務器

🤝 貢獻指南

請閱讀 CONTRIBUTING.md 瞭解詳細信息。