SitecoreMCP MCP服务器

使用说明(Markdown 格式)

项目简介

  • SitecoreMCP 是一个基于 MCP 的后端服务器,旨在将 Sitecore CMS 的内容、模板、字段等上下文信息暴露给 AI 助手或其他 MCP 客户端,通过 JSON-RPC 的方式提供统一的访问入口。

主要功能点

  • Prompt 与 Tools 支持:提供站点专用的 prompts(如 sitecore)与一组工具(如 sitecore_get_item、sitecore_get_children、sitecore_search 等),便于 LLM 调用外部功能来获取 Sitecore 数据。
  • Sitecore 集成能力:通过 Sitecore 的 GraphQL API 实现内容查询、字段读取、模板与字段信息获取、布局信息、站点配置等多种能力。
  • 智能语言默认与容错:对语言选择提供智能默认与自动尝试语言的能力,支持版本查询、字段及字段模板的获取等。
  • 全量发现与进阶特性:内置对模板继承、渲染渲染信息、解析/发现依赖项等的支持,便于 AI 获取完整上下文。

安装与运行步骤

  • 先确保系统上已安装 Node.js(推荐版本尽量新一些)。
  • 将代码获取到本地后,安装依赖并编译/运行服务(一般包含安装依赖、编译为可执行 JS、并通过 MCP 客户端所需的传输通道启动)。运行时需确保以下环境变量可用:
    • SITECORE_HOST:Sitecore 服务器地址
    • SITECORE_ENDPOINT:Sitecore GraphQL 端点(默认为 /sitecore/api/graph/items/master)
    • SITECORE_API_KEY:Sitecore API Key,必要的认证钥
    • SITECORE_USERNAME、SITECORE_PASSWORD:可选的基础认证信息
  • 启动服务器后,服务器将通过标准输出/输入的 MCP 传输接收请求,提供 prompts 和工具集供 MCP 客户端使用。

服务器配置(MCP 客户端配置示例说明) MCP 客户端不需要运行细节,但需要通过配置知晓服务器要如何连接。以下字段用于描述 MCP 服务器在客户端配置中的信息,便于不同环境下的接入与管理:

  • serverName: sitecore-mcp-server
  • command: node
  • args: ["dist/index.js"] // 这是常见的运行入口路径,实际路径需按项目编译结果或打包输出确定

注释与说明

  • command 与 args 表示在 MCP 客户端启动时应执行的命令以及传递的参数,用以启动该 MCP 服务器。具体执行路径可能随打包/构建方式不同而变化,请按实际部署输出调整。
  • 环境变量用于对 Sitecore 的连接与认证,确保在运行时已按需要设置。

基本使用方法

  • 启动后,你的 MCP 客户端(如支持 MCP 的对话系统)即可通过 JSON-RPC 调用站点的工具与 prompts,获取 Sitecore 的上下文信息与执行外部操作的能力。
  • 常见的操作包括:
    • 调用 sitecore_get_item、sitecore_get_children、sitecore_search 等工具来检索内容。
    • 使用 sitecore_command、sitecore_prompt 等 Prompts,通过对话引导获提供的上下文与指令。
    • 通过站点的 GraphQL 接口查询模板、字段、布局等元信息以构建更丰富的上下文。
  • 连接流程简述:MCP 客户端通过 JSON-RPC 向服务器发送请求,Server 响应标准的 MCP Tool/Prompt 结构,或返回带有 content 的 MCPToolResponse。

注意事项

  • 确保 Sitecore GraphQL API 的可用性以及正确的 API Key/认证方式。
  • 根据实际运行环境对 dist/index.js 的路径进行确认和调整,以确保 MCP 服务能够正确启动。

关键词 Sitecore, GraphQL, JSON-RPC, AI 集成, 后端服务

分类ID 6

服务器信息