Skip to main content
Glama
Antonytm

mcp-sitecore-server

by Antonytm

security-export-account

Exports a Sitecore user or role to the CM filesystem and returns the saved file path. Requires SPE 8.0 or later; on SitecoreAI, use Sitecore CLI serialization instead.

Instructions

Exports (serializes) a Sitecore user or role to the CM's own filesystem and returns the file path. Requires SPE 8.0 or later — earlier versions fail with a NullReferenceException (SPE issues #1369, #1370). On SitecoreAI prefer Sitecore CLI serialization.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoExact server-side file to serialize to. Not with root.
rootNoServer-side directory to serialize into. Defaults to Sitecore's serialization folder. Not with path.
identityYesThe account to export, e.g. 'sitecore\admin' or 'sitecore\Author'.
accountTypeYesWhether the identity names a user or a role.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.5

TDQS

A4.4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only declare readOnlyHint=false and destructiveHint=false; the description adds substantial context beyond them: the side effect is a filesystem write on the CM server, the response is a file path, the operation throws a NullReferenceException on pre-8.0 SPE (with issue references), and it should be avoided on SitecoreAI. This is exactly the kind of behavioral disclosure that earns a top score.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three compact sentences, front-loaded with purpose and output, followed by the version prerequisite and platform caveat. No filler, though the parenthetical issue references and version caveat add some density.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description usefully states the return value (file path), discloses the write side effect and its environment requirements, and warns about failure modes. An agent has everything needed to decide whether to call it and what to expect.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all four parameters (path, root, identity, accountType) are already documented, including their mutual exclusivity. The description adds no parameter-level detail such as path syntax or how identity strings interact with accountType, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a precise verb and resource ('Exports (serializes) a Sitecore user or role'), names the destination ('the CM's own filesystem'), and reveals the return value ('the file path'). An agent immediately knows this is a file-producing export operation, distinct from the read/get and import/remove security siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a clear routing rule for SitecoreAI ('prefer Sitecore CLI serialization') and a hard prerequisite ('Requires SPE 8.0 or later'). It does not explicitly name security-import-account as the inverse tool or state when-not-to-use on CM, so guidance is strong but not exhaustive.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools