readability-analysis

readability-analysis is a skill for Claude Code, Codex from ghchinoy/docstats. It costs 85 tokens per session (1,434 once invoked), scanned A, original, Apache-2.0.

A tool for checking how readable technical writing is and whether it follows defined house-style rules. It reports reading difficulty and flags patterns such as filler openings, contrast formulas, and other writing habits.

In plain words
What is it for?
Use it to analyze documents, calculate readability scores, and lint technical text before publishing or merging it.
Why use it?
It provides consistent checks for prose quality instead of relying only on subjective review.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/ghchinoy/docstats/readability-analysis
Any agent
npx skills add ghchinoy/docstats --skill readability-analysis
Clone the repo
git clone --depth 1 https://github.com/ghchinoy/docstats

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for readability-analysis

README.md
[![agentmods](https://agentmods.dev/badge/skills/ghchinoy/docstats/readability-analysis.svg)](https://agentmods.dev/skills/ghchinoy/docstats/readability-analysis)
Your own site
<a href="https://agentmods.dev/skills/ghchinoy/docstats/readability-analysis"><img src="https://agentmods.dev/badge/skills/ghchinoy/docstats/readability-analysis.svg" alt="Measured on agentmods" height="20"></a>
Per session 85 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,434 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00085 $0.01434
Opus 5 $0.00043 $0.00717
Sonnet 5 $0.00017 $0.00287
Haiku 4.5 $0.00009 $0.00143

Measured 2d ago against content hash d57b661f5b3d, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

readability-analysis scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/readability-analysis/SKILL.md · 104 lines

How it starts

The opening of the file, as written. The whole thing — 104 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Readability & Technical Editorial Analysis

This skill provides multi-dimensional analysis of text complexity and house-style linting, converting raw statistical metrics into actionable editorial guidance. It is backed by the docstats multi-protocol engine.

Design Role: docstats is designed as a post-hoc acceptance gate (for CI/CD pipelines, PR reviews, and pre-publish QA) rather than an in-loop generative dial. Empirical evaluations show that injecting live numeric metrics during generation does not improve prose quality over clear textual guidance and risks artificial metric gaming.

Available MCP Tools (Server readability-docstats)

1. analyze_document (Preferred)

Performs comprehensive two-axis assessment:

  • Axis A (Readability): 10 grade-level and reading ease formulas + consensus standard.
  • Axis B (House-Style Linting): Deterministic counts and rates of throat-clearing openers, binary contrast frames, non-technical filler adverbs, prose em dashes, and rhythm variation hints. Computes ai_tell_score (0.0–10.0 scale, floor ≥ 7.0).

2. get_readability_scores

Calculates Axis A readability scores and raw text statistics (syllables, words, sentences).

3. get_ai_pattern_scores

Calculates Axis B house-style lint counts, rates, diagnostic flags, and ai_tell_score.


How to Run It

Recommended Workflow: Post-Hoc Acceptance Gate

Use docstats asynchronously after drafting or during automated review:

  1. Generate or edit the draft using qualitative editorial guidelines.
  2. Run analyze_document as a quality gate.
  3. If Axis B or Axis A fails, apply targeted edits to resolve diagnostic flags.

MCP Invocation

Pass exactly one source parameter:

  • text: Plain text or markdown string.
  • web_url: Publicly reachable HTML page or online PDF URL.
  • gcs_pdf_uri: gs://... URI in Google Cloud Storage.
// Example MCP Tool Call
{
  "name": "analyze_document",
  "arguments": {
    "text": "Your draft content here..."
  }
}

Read the full file on GitHub · 104 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 104 lines · 85 tokens per session scan A d57b661f5b3d

Subscribe to this mod's changes

readability-analysis is a skill published in the GitHub repository ghchinoy/docstats (0 stars, last pushed 12d ago), licensed Apache-2.0. It adds 85 tokens to every session and 1,434 once invoked, about $0.0004 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens