mcpField
P
proofread

proofread

github.com/pedrohcgsDocuments1.7k65 installsUpdated 5w ago
Repository

About proofread

A lecture-file proofreading skill that reports language, layout, consistency, and academic-style issues without changing source files. It saves findings as reviewable reports for later corrections.

Key features

  1. 01Grammar and typo checks
  2. 02Slide overflow checks
  3. 03Citation and notation consistency checks
  4. 04Issue locations, severity, and fixes
  5. 05Reports saved under quality_reports/

Use cases

  1. 01Reviewing a specific lecture file
  2. 02Checking all files in Slides/ and Quarto/
  3. 03Preparing a correction list without editing sources

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/pedrohcgs/claude-code-my-workflow --skill proofread

After installing, type/proofreadin Claude Code to confirm it loaded.

Details

From the project README

Proofread Lecture Files

Run the proofreading protocol on lecture files. This produces a report of all issues found WITHOUT editing any source files.

Steps

  1. Identify files to review:

    • If $ARGUMENTS is a specific filename: review that file only
    • If $ARGUMENTS is "all": review all lecture files in Slides/ and Quarto/

  2. For each file, launch the proofreader agent that checks for:

    GRAMMAR: Subject-verb agreement, articles (a/an/the), prepositions, tense consistency TYPOS: Misspellings, search-and-replace artifacts, duplicated words OVERFLOW: Overfull hbox (LaTeX), content exceeding slide boundaries (Quarto) CONSISTENCY: Citation format, notation, terminology ACADEMIC QUALITY: Informal language, missing words, awkward constructions

  3. Produce a detailed report for each file listing every finding with:

    • Location (line number or slide title)
    • Current text (what's wrong)
    • Proposed fix (what it should be)
    • Category and severity

  4. Save each report to quality_reports/:

    • For .tex files: quality_reports/FILENAME_report.md
    • For .qmd files: quality_reports/FILENAME_qmd_report.md

  5. Leave source files unchanged — fixes are applied after the user reviews the report. Only produce the report. Fixes are applied separately after user review.

  6. Present summary to the user:

    • Total issues found per file
    • Breakdown by category
    • Most critical issues highlighted

Comments

Markdown supported