MCP Sitecore Server

🚀 Sitecore's Model Context Protocol Server

This project provides a Model Context Protocol Server for Sitecore, enabling various API services for Sitecore operations.

✨ Features

Implemented Tools

• [x] GraphQL API

  • [x] introspection-grahpql-{schema}: Returns the GraphQL schema.
  • [x] query-graphql-{schema}: Executes a GraphQL query.

• [x] Item Service API

  • [x] item-service-get-item: Returns an item by ID.
  • [x] item-service-get-item-children: Returns the children of an item by ID.
  • [x] item-service-get-item-by-path: Returns an item by path.
  • [x] item-service-create-item: Creates an item by providing a template ID and a parent path.
  • [x] item-service-edit-item: Edits an item by ID.
  • [x] item-service-delete-item: Deletes an item by ID.
  • [x] item-service-search-items: Searches for items.
  • [x] item-service-run-stored-query: Executes a stored query.
  • [x] item-service-run-stored-search: Executes a stored search.
  • [x] Combined Item Service API
    • [x] item-service-get-languages: Returns the Sitecore languages in the instance.
    • [x] item-service-get-item-descendants: Returns the descendants of an item by ID.

• [ ] Sitecore PowerShell

• [ ] Sitecore CLI

📦 Installation

Add the following Model Context Protocol Server to your Cursor, VS Code, or 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/"
        }
    }

Environment Variable Descriptions

• TRANSPORT: The transport protocol to use. Options are stdio or sse.
• GRAPHQL_ENDPOINT: The GraphQL endpoint URL of the Sitecore instance.
• GRAPHQL_SCHEMAS: The Sitecore schemas for the GraphQL API, comma-separated.
• GRAPHQL_API_KEY: The API key for the GraphQL endpoint.
• GRAPHQL_HEADERS: Additional headers to include in GraphQL requests.
• ITEM_SERVICE_DOMAIN: The domain for item service API login. Default is sitecore.
• ITEM_SERVICE_USERNAME: The username for item service API login.
• ITEM_SERVICE_PASSWORD: The password for item service API login.
• ITEM_SERVICE_SERVER_URL: The base URL for the item service API.

📚 Resource List

• [x] config: Returns the server configuration. Used to check if everything is configured correctly.

💻 Local Installation / Development

1. Clone the repository.
2. Run npm install to install dependencies.
3. Run npm run build to build the project.
4. Run npm start to start the server.