get-powershell-documentation

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

Annotations already declare readOnlyHint=true, so safety is covered. The description adds real behavioral context the annotations cannot: progressive disclosure, the ~510KB corpus size, the 129-command index shape, and that search returns names/summaries rather than full pages. It stops short of describing pagination or error behavior, so a 4 rather than 5.

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

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

Purpose is front-loaded and every sentence carries information about call sequencing or return shape. It is dense and slightly long, but nothing is padding; a marginally tighter phrasing would reach 5.

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

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

With no output schema, the description must describe returns, and it does: index of 129 commands with one-line summaries, full pages with syntax/parameters/examples, and search results as names and summaries. That is sufficient for an agent to call the tool correctly at each stage.

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

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

Schema coverage is 100%, so the baseline is 3. The description goes beyond the schema by explaining that calling with NO arguments returns an index, a cross-parameter usage workflow the schema cannot express, and reinforces what 'search' returns versus full pages. This adds genuine meaning over the field descriptions.

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

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

States a specific resource (Sitecore PowerShell Extensions command reference) and its concrete purpose (writing run-powershell-script scripts), which cleanly separates it from the run-powershell-script execution sibling. An agent can tell exactly what this returns without opening the schema.

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

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

Gives an explicit call sequence: no args first for the index, then 'command' for full pages, 'search' when you know the task but not the cmdlet, 'category' for one group. It even adds a when-not constraint ('Do not fetch pages you are not about to use'), leaving nothing to inference.

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