mcp-sitecore

This MCP server exposes a GraphQL API and a set of Sitecore item/manipulation services. When running, it provides endpoints to introspect the GraphQL schema, execute GraphQL queries, and manage Sitecore items via the Item Service API (create, read, update, delete, search, and run stored queries). It also includes a composite API surface for languages, descendants, and related presentation/presentation-layout operations. To interact with the server, start it through your chosen packaging method (npx, npm, or your deployment method) and then send GraphQL requests or invoke the Item Service endpoints as documented in the server's API surface. Typical usage includes querying the GraphQL schema, performing item lookups by ID or path, creating items from templates, running stored queries or searches, and leveraging presentation/layout related commands for rendering configurations.

Prerequisites:

• Node.js and npm installed on your system
• Access to the npm package registry hosting the MCP server (public or private)

Installation options:

1. Quick start with npx (no local install):

• Ensure you have Node.js installed
• Run: npm install -g npm (optional, to update npm)
• Run the server with: npx -y mcp-sitecore-server

2. Install as a global package (local installation):

• npm i -g mcp-sitecore-server
• Start the server (example): mcp-sitecore-server --config ./path/to/mcp-config.json

3. Local project installation (recommended for development):

• mkdir my-mcp-project && cd my-mcp-project
• npm init -y
• npm install mcp-sitecore-server
• Add a run script in package.json to start the server with your config, e.g., "start": "node node_modules/mcp-sitecore-server/dist/index.js --config ./config.json"

Configuration:

• Create a configuration file or use environment variables as described in the mcp_config section.
• Ensure SITECORE_BASE_URL and SITECORE_API_KEY (or appropriate credentials) are available to the server.

Tips and common issues:

• Ensure your Sitecore instance is accessible from the MCP server host and that the API key or credentials have sufficient permissions.
• When using npx, ensure network access to fetch the package; for offline environments, prefer a local install.
• If GraphQL introspection or queries fail, verify the base URL configuration and that the GraphQL endpoint is enabled in Sitecore.
• Use environment variable MCP_LOG_LEVEL to adjust logging verbosity during debugging.
• For security, avoid exposing API keys in logs; use secret management in your deployment environment.
• If you plan to run multiple MCP servers, maintain distinct configuration per server and avoid sharing credentials across instances.