Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| TRANSPORT | No | The transport protocol to use. Options are streamable-http, stdio or sse. | stdio |
| GRAPHQL_API_KEY | Yes | The API key for the GraphQL endpoint. | |
| GRAPHQL_HEADERS | No | Additional headers to include in the GraphQL requests. | |
| GRAPHQL_SCHEMAS | Yes | The Sitecore schemas to use for the GraphQL API, comma-separated. | |
| GRAPHQL_ENDPOINT | Yes | The GraphQL endpoint URL for the Sitecore instance. | |
| POWERSHELL_DOMAIN | No | The domain for the Sitecore PowerShell Remoting API authentication. Default is sitecore. | sitecore |
| AUTORIZATION_HEADER | No | Optional. If set, it will be used as an authorization header for access to the server. MCP server will expect authorization header to be passed with the value of this environment variable. If environment variable is not set, the server will not check for the authorization header. | |
| ITEM_SERVICE_DOMAIN | No | The domain for the Item Service API authentication. Default is sitecore. | sitecore |
| POWERSHELL_PASSWORD | Yes | The password for the Sitecore PowerShell Remoting API authentication. | |
| POWERSHELL_USERNAME | Yes | The username for the Sitecore PowerShell Remoting API authentication. | |
| ITEM_SERVICE_PASSWORD | Yes | The password for the Item Service API authentication. | |
| ITEM_SERVICE_USERNAME | Yes | The username for the Item Service API authentication. | |
| POWERSHELL_SERVER_URL | Yes | The base URL for the Sitecore PowerShell Remoting API. | |
| ITEM_SERVICE_SERVER_URL | Yes | The base URL for the Item Service API. |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
| resources | {
"listChanged": true
} |
| completions | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| config | Prints the configuration of the Sitecore MCP server. |
| introspection-graphql-master | Introspection Sitecore GraphQL master schema, use this tool before doing a query to get the schema information if you do not have it available as a resource already. |
| query-graphql-master | Query a Sitecore GraphQL master endpoint with the given query and variables. |
| introspection-graphql-web | Introspection Sitecore GraphQL web schema, use this tool before doing a query to get the schema information if you do not have it available as a resource already. |
| query-graphql-web | Query a Sitecore GraphQL web endpoint with the given query and variables. |
| item-service-get-item | Get a Sitecore item by its ID. |
| item-service-get-item-children | Get children of a Sitecore item by its ID. |
| item-service-get-item-by-path | Get a Sitecore item by its path. |
| item-service-create-item | Create a new Sitecore item under parent path with name using template id. |
| item-service-edit-item | Edit a Sitecore item by its ID. |
| item-service-delete-item | Delete a Sitecore item by its ID. |
| item-service-search-items | Search Sitecore items using the ItemService RESTful API. |
| item-service-run-stored-query | Run a stored Sitecore query by its definition item ID. |
| item-service-run-stored-search | Run a stored Sitecore search by its definition item ID. |
| item-service-get-item-descendants | Get descendants of a Sitecore item by its ID. |
| item-service-get-languages | Get Sitecore languages. |
| get-powershell-documentation | Gets the documentation describing all Sitecore Powershell commands. |
| run-powershell-script | Runs a PowerShell script and returns the output. |
| security-get-user-by-identity | Get a Sitecore user by its name. |
| security-get-current-user | Get the current Sitecore user. |
| security-get-user-by-filter | Get a Sitecore users by filter. |
| security-new-user | Creates a new Sitecore user. |
| security-remove-user | Removes the Sitecore user. |
| security-disable-user | Disables the Sitecore user account. |
| security-enable-user | Enables the Sitecore user account. |
| security-unlock-user | Unlocks a Sitecore user account that has been locked out due to failed login attempts. |
| security-set-user | Updates properties of a Sitecore user account. |
| security-set-user-password | Sets a new password for a Sitecore user. |
| security-get-domain-by-name | Get a Sitecore domain by its name. |
| security-get-domain | Get all Sitecore domains. |
| security-get-role-by-identity | Get a Sitecore role by its identity. |
| security-get-role-by-filter | Get Sitecore roles by filter criteria. |
| security-get-role-member | Get members of a Sitecore role. |
| security-add-role-member | Adds a member to a Sitecore role. |
| security-remove-role-member | Removes members from a Sitecore role. |
| security-lock-item-by-id | Lock a Sitecore item by its ID. |
| security-lock-item-by-path | Lock a Sitecore item by its path. |
| security-unlock-item-by-id | Unlocks a Sitecore item by its ID. |
| security-unlock-item-by-path | Unlocks a Sitecore item by its path. |
| security-protect-item-by-path | Protect a Sitecore item by its path. |
| security-protect-item-by-id | Protect a Sitecore item by its ID. |
| security-unprotect-item-by-id | Unprotect a Sitecore item by its ID. |
| security-unprotect-item-by-path | Unprotect a Sitecore item by its path. |
| security-new-role | Creates a new Sitecore role. |
| security-remove-role | Removes a Sitecore role. |
| security-new-domain | Creates a new Sitecore domain. |
| security-remove-domain | Removes a Sitecore domain. |
| security-test-account | Tests if a Sitecore user exists and has specific properties. |
| security-get-item-acl-by-id | Gets the access control list (ACL) of a Sitecore item by its ID. |
| security-get-item-acl-by-path | Gets the access control list (ACL) of a Sitecore item by its path. |
| security-test-item-acl-by-id | Tests whether a user or role has specific access rights to a Sitecore item by its ID. |
| security-test-item-acl-by-path | Tests whether a user or role has specific access rights to a Sitecore item by its path. |
| security-add-item-acl-by-id | Adds an access control entry to a Sitecore item by its ID. |
| security-add-item-acl-by-path | Adds an access control entry to a Sitecore item by its path. |
| security-clear-item-acl-by-id | Clears all access rules from a Sitecore item by its ID. |
| security-clear-item-acl-by-path | Clears all access rules from a Sitecore item by its path. |
| security-set-item-acl-by-id | Sets an access control entry to a Sitecore item by its ID. |
| security-set-item-acl-by-path | Sets an access control entry to a Sitecore item by its path. |
| common-add-base-template-by-id | Adds a base template to a template item by its ID. |
| common-add-base-template-by-path | Adds a base template to a template item by its path. |
| common-add-item-version-by-id | Creates a version of the item (by its id) in a new language based on an existing language version. |
| common-add-item-version-by-path | Creates a version of the item (by its path) in a new language based on an existing language version. |
| common-convert-from-item-clone-by-id | Converts an item from a clone to a fully independent item by its ID. |
| common-convert-from-item-clone-by-path | Converts an item from a clone to a fully independent item by its path. |
| common-get-cache | Gets information about Sitecore caches. |
| common-get-database | Gets information about Sitecore databases. |
| common-get-item-clone-by-id | Returns all the clones for the specified item by its ID. |
| common-get-item-clone-by-path | Returns all the clones for the specified item by its path. |
| common-get-item-field-by-id | Gets item fields as either names or fields or template fields by its ID. |
| common-get-item-field-by-path | Gets item fields as either names or fields or template fields by its path. |
| common-get-item-reference-by-id | Gets item references for a Sitecore item by its ID, showing where it is used throughout the system. |
| common-get-item-reference-by-path | Gets item references for a Sitecore item by its path, showing where it is used throughout the system. |
| common-get-item-referrer-by-id | Gets items referring to a Sitecore item by its ID, showing which items reference it. |
| common-get-item-referrer-by-path | Gets items referring to a Sitecore item by its path, showing which items reference it. |
| common-get-item-template-by-id | Gets template information for a Sitecore item by its ID. |
| common-get-item-template-by-path | Gets template information for a Sitecore item by its path. |
| common-get-item-workflow-event-by-id | Gets entries from the workflow history for the specified item by its ID. |
| common-get-item-workflow-event-by-path | Gets entries from the workflow history for the specified item by its path. |
| common-get-sitecore-job | Gets list of the current Sitecore jobs. |
| common-invoke-workflow-by-id | Executes workflow action for a Sitecore item by its ID. |
| common-invoke-workflow-by-path | Executes workflow action for a Sitecore item by its path. |
| common-new-item-workflow-event-by-id | Creates a new entry in the workflow history for a Sitecore item by its ID. |
| common-new-item-workflow-event-by-path | Creates a new entry in the workflow history for a Sitecore item by its path. |
| common-publish-item-by-id | Publishes a Sitecore item by its ID. |
| common-publish-item-by-path | Publishes a Sitecore item by its path. |
| common-remove-base-template-by-id | Removes a base template from a template item by its ID. |
| common-remove-base-template-by-path | Removes a base template from a template item by its path. |
| common-remove-item-version-by-id | Removes a version of a Sitecore item by ID. |
| common-remove-item-version-by-path | Removes a version of a Sitecore item by path. |
| common-reset-item-field-by-id | Resets item fields, specified as either names, fields or template fields by ID. |
| common-reset-item-field-by-path | Resets item fields, specified as either names, fields or template fields by path. |
| common-restart-application | Restarts the Sitecore Application pool. |
| common-set-item-template-by-id | Sets the item template by the item's ID. |
| common-set-item-template-by-path | Sets the item template by the item's path. |
| common-test-base-template-by-id | Checks if the item inherits from the specified template by its ID. |
| common-test-base-template-by-path | Checks if the item inherits from the specified template by its path. |
| common-get-archive | Gets Sitecore database archives. |
| common-get-archive-item | Gets a list of items found in the specified archive. |
| common-new-item-clone-by-id | Creates a new item clone based on the item provided by its ID. |
| common-new-item-clone-by-path | Creates a new item clone based on the item provided by its path. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| config |