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 了解详细信息。