mcp-sitecore-server

🚀 Sitecore 的模型上下文协议服务器

本项目为 Sitecore 提供了模型上下文协议服务器，实现了多种实用的 API 工具，方便用户对 Sitecore 进行操作，如执行 GraphQL 查询、管理项目等。

🚀 快速开始

将以下模型上下文协议服务器添加到您的 Cursor、VS Code、Claud 中：

    "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/"
        }
    }

环境变量描述

• TRANSPORT: 所使用的传输协议。选项为 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。

✨ 主要特性

已实现的工具

• [x] GraphQL API

  • [x] introspection-grahpql-{schema}: 返回 GraphQL 模式
  • [x] query-graphql-{schema}: 执行 GraphQL 查询

• [x] 项服务 API

  • [x] item-service-get-item: 根据 ID 返回一个项目
  • [x] item-service-get-item-children: 根据 ID 返回项目的子项
  • [x] item-service-get-item-by-path: 根据路径返回一个项目
  • [x] item-service-create-item: 通过提供模板 ID 和父路径创建一个项目。
  • [x] item-service-edit-item: 编辑根据 ID 的项目
  • [x] item-service-delete-item: 根据 ID 删除项目
  • [x] item-service-search-items: 搜索项目
  • [x] item-service-run-stored-query: 执行存储的查询
  • [x] item-service-run-stored-search: 执行存储的搜索
  • [x] 组合项服务 API
    • [x] item-service-get-languages: 返回实例中的 Sitecore 语言
    • [x] item-service-get-item-descendants: 根据 ID 返回项目的后代

• [ ] Sitecore PowerShell

• [ ] Sitecore CLI

资源列表

• [x] config: 返回服务器的配置。用于检查是否正确配置了所有内容。

📦 安装指南

本地安装 / 开发

1. 克隆仓库
2. 运行 npm install 安装依赖项
3. 运行 npm run build 构建项目
4. 运行 npm start 启动服务器

构建与贡献状态