Agent skill

Docs Sync

by pnp in pnp/powershell

Check PnP PowerShell cmdlet parameter surfaces in C against their documentation/.md platyPS metadata - types, parameter sets, mandatory, position, pipeline binding, aliases - plus missing or…

MITAuto-check passedAgent Workflows

Install Docs Sync

skills CLI
$ npx skills add pnp/powershell --skill docs-sync -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install pnp/powershell docs-sync --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/pnp/powershell.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/docs-sync .claude/skills/docs-sync && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
docs-sync
GitHub stars
905
Token cost
~1.5k tokens
SKILL.md length
698 words
Files
1
Skills in repo
9
Repo updated
First seen
Licence
MIT

At a glance

Check PnP PowerShell cmdlet parameter surfaces in C against their documentation/.md platyPS metadata - types, parameter sets, mandatory, position, pipeline binding, aliases - plus missing or…

  • Works in 4 steps: Take a scope: changed files, one folder… → Build the cmdlet → doc pairing. Report… → For each pair, extract both parameter… → …
  • Agent Workflows work in your project
  • SKILL.md covers Why this is a defect, not…, The two surfaces being compared, What to check and Finding the pair, plus 2 more sections
  • Reaches pnp.github.io

What it does

Docs Sync is an agent skill from pnp/powershell. Check PnP PowerShell cmdlet parameter surfaces in C against their documentation/.md platyPS metadata - types, parameter sets, mandatory, position, pipeline binding, aliases - plus missing or orphaned pages. Use after changing cmdlet parameters, or to sweep src/Commands/ for documentation drift.

Its SKILL.md is about 1.5k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Agent Workflows. It works with PowerShell, C# and Microsoft 365. The licence is MIT.

When your agent uses it

  • Agent Workflows work in your project

Example prompts

  • “/docs-sync”

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. Take a scope: changed files, one folder under src/Commands/, or the whole repository.
  2. Build the cmdlet → doc pairing. Report unpaired items on both sides first.
  3. For each pair, extract both parameter tables and diff them field by field.
  4. Report drift. Do not fix silently unless asked — the correct side is not always the code. A

What it can do on your machine

Read from SKILL.md and the folder at commit 04d819a. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are csharp and yaml).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • pnp.github.io

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Docs Sync loads about 1.5k tokens when it runs. Until then it costs about 77 tokens; SKILL.md has 698 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~77
When it runs · the whole SKILL.md, loaded when a task matches
~1.5k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from pnp/powershell at commit 04d819a, republished under its MIT licence (© pnp). 698 words, ~1,485 tokens.

Download SKILL.mdSave it as .claude/skills/docs-sync/SKILL.md (or your agent's skills folder).
name
docs-sync
description
Check PnP PowerShell cmdlet parameter surfaces in C# against their documentation/*.md platyPS metadata - types, parameter sets, mandatory, position, pipeline binding, aliases - plus missing or orphaned pages. Use after changing cmdlet parameters, or to sweep src/Commands/ for documentation drift.

Playbook: docs-sync

Verify that every cmdlet's parameter surface in C# matches its documentation/<Verb-PnPNoun>.md.

Why this is a defect, not hygiene

documentation/*.md is the shipped product. It builds the published site at https://pnp.github.io/powershell/ and the external help file (PnP.PowerShell.dll-Help.xml) that backs Get-Help in the user's console. A parameter documented as optional but declared mandatory sends the user into an error they cannot explain from the docs. Drift here is user-facing.

There are ~849 documentation files and ~850 cmdlets. This is a fan-out job: mechanical, exact, and far too large to do by hand.

Report drift in the session. Never open an issue or PR for it — see Human in the loop. A sweep across 850 cmdlets could otherwise produce a great many of them.

The two surfaces being compared

C# side — attributes on each public property/field of the cmdlet class:

csharp
[Parameter(Mandatory = true, ValueFromPipeline = true, Position = 0, ParameterSetName = "ByName")]
[Alias("Name")]
[ValidateNotNull]
public ListPipeBind Identity { get; set; }

Markdown side — a platyPS YAML block per parameter under ## PARAMETERS:

yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Field mapping
YAML keyC# sourceNotes
TypeProperty/field typeUse the PowerShell-facing name: String[], SwitchParameter, PnPConnection, the PipeBind type.
Parameter SetsParameterSetName(All) when the parameter appears in every set or none is named. Otherwise the exact set names, comma separated.
Aliases[Alias]Empty when absent.
RequiredMandatoryPer parameter set — a parameter mandatory in one set only must not read True for (All).
PositionPositionNamed when unset; otherwise the integer.
Accept pipeline inputValueFromPipeline / ValueFromPipelineByPropertyNameTrue (ByValue), True (ByPropertyName), True (ByValue, ByPropertyName), or False.
Accept wildcard characters[SupportsWildcards]False unless declared.
Default valueInitialiserNone when there is no meaningful default.

What to check

Per parameter

  • Present in both. A parameter in code but not in the doc is invisible to users; a parameter in the doc but not in code is a promise the module does not keep.
  • Every YAML field agrees with the attributes, per the mapping above.
  • Multiple parameter sets: ## SYNTAX has one fenced powershell block per set, and the sets named there match ParameterSetName values in the class. A restructured parameter set that ## SYNTAX still describes the old way is a common and confusing drift.

Per file

  • Parameter subsections under ## PARAMETERS are listed alphabetically.
  • The boilerplate -Connection and -Verbose sections are present for connected cmdlets, with the standard wording used by sibling files.
  • Front matter is intact and consistent:
    Module Name: PnP.PowerShell
    title: <Verb-PnPNoun>
    schema: 2.0.0
    applicable: <workloads>
    external help file: PnP.PowerShell.dll-Help.xml
    online version: https://pnp.github.io/powershell/cmdlets/<Verb-PnPNoun>.html
    title and the online version slug must both equal the real cmdlet name.
  • **## PARAMETERS contains only ```yaml fenced blocks.** Any other fenced block there risks the external help build. Examples belong under ## EXAMPLES with ```powershell fences. This is a build-breaking rule, so report it as high severity.
  • ## RELATED LINKS present.

Per repository

  • A documentation file for every cmdlet, and a cmdlet for every documentation file. Removed cmdlets leaving orphan pages is a recurring drift.
  • Filename equals the cmdlet name exactly, including case.
  • Cmdlets carrying [Alias("Old-PnPName")] — the alias should be discoverable from the page, and no separate stale page should exist for the old name.
Show full SKILL.md (219 more words)Show less

Finding the pair

The class filename does not reliably match the cmdlet name. Resolve through the attribute — search for the pattern \[Cmdlet\( across src/Commands/**/*.cs with your search tool. This sweep needs no shell; the agent profiles for it deliberately grant only read and search tools.

[Cmdlet(VerbsCommon.Get, "PnPList")] → Get-PnPList → documentation/Get-PnPList.md. Map the Verbs* constant to its verb (VerbsCommon.Get → Get, VerbsLifecycle.Request → Request, and so on) rather than assuming the class name carries it.

Procedure

  1. Take a scope: changed files, one folder under src/Commands/, or the whole repository.
  2. Build the cmdlet → doc pairing. Report unpaired items on both sides first.
  3. For each pair, extract both parameter tables and diff them field by field.
  4. Report drift. Do not fix silently unless asked — the correct side is not always the code. A doc describing behaviour the code lost may be evidence of a regression.

Reporting

Group by cmdlet, then by parameter. For each: the field, the C# value, the markdown value, and which side you believe is wrong with a reason. Finish with counts — cmdlets checked, clean, drifted, unpaired — so a partial run cannot be mistaken for a full one.

When asked to fix, change only what you can justify from the code, keep the surrounding prose and wording style of the file, and never reformat an untouched YAML block.

© pnp, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/docs-sync of pnp/powershell.

Open the folder on GitHubat commit 04d819a

Compare with similar skills

Docs Sync next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Docs Sync compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Sync this skillpnp/powershell905—~1.5kAutomated safety check: PassMIT
Windows Chat VerificationEvotecIT/DesktopManager107—~1.5kAutomated safety check: PassNone
Locus Unity BridgeMisaka-Mikoto-Tech/agent-skills275—~4kAutomated safety check: PassMIT
Entra Agent Idmicrosoft/GitHub-Copilot-for-Azure2553 repos~4kAutomated safety check: PassMIT
CLI Microsoft365 Scriptpnp/cli-microsoft365-mcp-server131—~3.3kAutomated safety check: PassMIT
Entra Agent Usergithub/awesome-copilot40k1 repos~2.3kAutomated safety check: PassMIT

Similar skills

  • Windows Chat Verification

    EvotecIT/DesktopManager

    Verify real Windows chat-app workflows through DesktopManager MCP.

    107 GitHub stars~1.5k tokensUpdated 2 days ago
    Agent WorkflowsAuto-check passed
  • Locus Unity Bridge

    Misaka-Mikoto-Tech/agent-skills

    A skill your agent uses when an agent needs to inspect or control a real Unity Editor through Locus, especially when Unity MCP is unavailable, named-pipe discovery is needed, C must be executed, or…

    275 GitHub stars~4k tokensUpdated 16 days ago
    Game DevelopmentAuto-check passed
  • Entra Agent Id

    microsoft/GitHub-Copilot-for-Azure

    Official

    Provision Microsoft Entra Agent Identity Blueprints, BlueprintPrincipals, and per-instance Agent Identities via Microsoft Graph, and configure OAuth 2.0 token exchange (fmipath, OBO, cross-tenant)…

    255 GitHub starsUsed in 3 repos~4k tokens
    Backend & APIsAuto-check passed
  • CLI Microsoft365 Script

    pnp/cli-microsoft365-mcp-server

    Write PowerShell scripts using CLI for Microsoft 365 commands to automate Microsoft 365 management tasks.

    131 GitHub stars~3.3k tokensUpdated 2 days ago
    Documents & OfficeAuto-check passed
  • Entra Agent User

    github/awesome-copilot

    Official

    Create Agent Users in Microsoft Entra ID from Agent Identities, enabling AI agents to act as digital workers with user identity capabilities in Microsoft 365 and Azure environments.

    40k GitHub starsUsed in 1 repo~2.3k tokens
    Documents & OfficeAuto-check passed
  • Auditing Azure Active Directory Configuration

    mukul975/Anthropic-Cybersecurity-Skills

    Auditing Microsoft Entra ID (Azure Active Directory) configuration to identify risky authentication policies, overly permissive role assignments, stale accounts, conditional access gaps, and guest…

    34k GitHub stars~3k tokensUpdated 1 mo ago
    Backend & APIsAuto-check passed

More from pnp/powershell

All 9 skills in this repo
  • Cmdlet Scaffolder

    pnp/powershell

    Generate a new PnP PowerShell cmdlet modelled on an existing sibling - class with the right base class and permission attributes, the documentation page, and the changelog entry.

    905 GitHub stars~1.3k tokensUpdated yesterday
    Auto-check passed
  • Dotnet Standards

    pnp/powershell

    C 12 / .NET 8 and PowerShell cmdlet design rules for this repository - naming, output and error channels, parameter validation, ShouldProcess, async, culture, cross-platform and ALC constraints.

    905 GitHub stars~2.1k tokensUpdated yesterday
    Auto-check passed
  • Issue Triage

    pnp/powershell

    Take a PnP PowerShell GitHub issue, find the cmdlet that owns it, trace the code path, and decide whether the cause is in this repo or in PnP Framework, PnP Core SDK or the service.

    905 GitHub stars~1.8k tokensUpdated yesterday
    Auto-check passed
  • New Cmdlet

    pnp/powershell

    The conventions a PnP PowerShell cmdlet must satisfy - base class selection, permission attributes, PipeBinds, parameter validation, Graph and CSOM call patterns, and the documentation plus…

    905 GitHub stars~1.6k tokensUpdated yesterday
    Auto-check passed
  • Permissions Auditor

    pnp/powershell

    Audit PnP PowerShell permission attributes against the APIs a cmdlet actually calls and against its documentation.

    905 GitHub stars~2.1k tokensUpdated yesterday
    Auto-check passed
  • API Surface Diff

    pnp/powershell

    Compare the public cmdlet surface of the current branch against dev - names, aliases, parameters, types, mandatory flags, parameter sets, output types, permissions - and classify each change as…

    905 GitHub stars~1.1k tokensUpdated yesterday
    Auto-check passed

Categories

Questions about Docs Sync

What does Docs Sync do?

Check PnP PowerShell cmdlet parameter surfaces in C against their documentation/.md platyPS metadata - types, parameter sets, mandatory, position, pipeline binding, aliases - plus missing or…. Docs Sync is an agent skill from pnp/powershell.md platyPS metadata - types, parameter sets, mandatory, position, pipeline binding, aliases - plus missing or orphaned pages.

When should I use Docs Sync?

Docs Sync fits situations like: agent Workflows work in your project.

How do I install Docs Sync in Claude Code?

Run `npx skills add pnp/powershell --skill docs-sync -a claude-code`. Or copy the skill folder (.agents/skills/docs-sync in pnp/powershell) into .claude/skills/docs-sync in your project. Claude Code loads it when a task matches its description.

How do I install Docs Sync in Codex?

Run `npx skills add pnp/powershell --skill docs-sync -a codex`. Or copy the skill folder (.agents/skills/docs-sync in pnp/powershell) into .agents/skills/docs-sync in your project. Codex loads it when a task matches its description.

Can I use Docs Sync in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add pnp/powershell --skill docs-sync -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-sync, .gemini/skills/docs-sync, .github/skills/docs-sync and .opencode/skills/docs-sync in your project.

What does Docs Sync need to run?

SKILL.md names no scripts, command-line tools or credentials: Docs Sync is instructions for the agent only.

Does Docs Sync access the network?

SKILL.md names 1 domain. In commands or code: pnp.github.io; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.

Is Docs Sync safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Docs Sync use?

Docs Sync is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Docs Sync use?

About 1.5k tokens (SKILL.md is roughly 5.9k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Docs Sync?

Skills that share tags, products or a category with Docs Sync: Windows Chat Verification (EvotecIT/DesktopManager, 107 stars), Locus Unity Bridge (Misaka-Mikoto-Tech/agent-skills, 275 stars), Entra Agent Id (microsoft/GitHub-Copilot-for-Azure, 255 stars) and CLI Microsoft365 Script (pnp/cli-microsoft365-mcp-server, 131 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Sync?

pnp (a GitHub organization) maintains it in pnp/powershell, which has 905 GitHub stars. The repository holds 9 skills in this directory. The repository was last updated on October 6, 2026.

Source: pnp/powershell on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.