mcpField
W
writing-guidelines

writing-guidelines

github.com/nexu-ioDocuments104.6k930 installsUpdated 1d ago
Repository

About writing-guidelines

writing-guidelines is a skill for checking files against a pinned set of writing rules. It reports findings in a concise file-and-line format and can optionally compare the rules with their upstream source.

Key features

  1. 01Pinned, reproducible guideline snapshot
  2. 02Optional upstream guideline comparison
  3. 03File and pattern review
  4. 04Terse file-and-line findings

Use cases

  1. 01Checking documents against a consistent writing standard
  2. 02Reviewing selected files or matching patterns

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/nexu-io/open-design --skill writing-guidelines

After installing, type/writing-guidelinesin Claude Code to confirm it loaded.

Bundled filesLICENSEreferences/guidelines.md

Details

From the project README

Writing Guidelines

Review files for compliance with Writing Guidelines.

How It Works

  1. Load the pinned guidelines from references/guidelines.md — this is the default, reproducible execution path
  2. Optionally, fetch the latest guidelines from the upstream URL below and diff against the pinned snapshot to see if anything has changed
  3. Read the specified files (or prompt user for files/pattern)
  4. Check against all rules in the guidelines
  5. Output findings in the terse file:line format

Guidelines Source

Default (pinned): The vendored copy at references/guidelines.md is the default execution path. It is a pinned snapshot of the upstream guidelines and guarantees the skill produces reproducible results in any runtime environment.

Upstream (live): For users who want the very latest rules, the live source is available at:

https://raw.githubusercontent.com/vercel-labs/writing-guidelines/main/command.md

Fetching the live version is optional — the pinned snapshot is always the baseline.

Usage

When a user provides a file or pattern argument:

  1. Load references/guidelines.md as the default source
  2. Optionally fetch the upstream URL to check for updates
  3. Read the specified files
  4. Apply all rules from the guidelines
  5. Output findings using the format specified in the guidelines

If no files specified, ask the user which files to review.

Comments

Markdown supported