mcpField
W
writing-guidelines

writing-guidelines

github.com/vercel-labsDocuments33.2k110.2k installsUpdated 1d ago
Repository

About writing-guidelines

writing-guidelines is a skill for checking files against the latest Writing Guidelines. It fetches the rules before each review and reports findings in the format specified by those guidelines.

Key features

  1. 01Fetches current guideline rules
  2. 02Reviews specified files or patterns
  3. 03Reports findings in required format

Use cases

  1. 01Checking a named file for writing-rule compliance
  2. 02Reviewing files matching a supplied pattern

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/vercel-labs/agent-skills --skill writing-guidelines

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

Details

From the project README

Writing Guidelines

Review files for compliance with Writing Guidelines.

How It Works

  1. Fetch the latest guidelines from the source URL below
  2. Read the specified files (or prompt user for files/pattern)
  3. Check against all rules in the fetched guidelines
  4. Output findings in the terse file:line format

Guidelines Source

Fetch fresh guidelines before each review:

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

Use WebFetch to retrieve the latest rules. The fetched content contains all the rules and output format instructions.

Usage

When a user provides a file or pattern argument:

  1. Fetch guidelines from the source URL above
  2. Read the specified files
  3. Apply all rules from the fetched guidelines
  4. Output findings using the format specified in the guidelines

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

Comments

Markdown supported