docs-check-style

docs-check-style is a skill for Claude Code from elastic/elastic-docs-skills. It costs 46 tokens per session (4,015 once invoked), scanned A, original, Apache-2.0.

A documentation style checker for Elastic content that uses Vale and the Elastic style guide.

In plain words
What is it for?
It is for reviewing Markdown files or documentation directories and reporting style issues without changing the files.
Why use it?
It catches problems with wording, grammar, tone, accessibility, and formatting before documentation is published.

Skill for Claude Code ✓ vendor

Written for Claude Code: allowed-tools in frontmatter.

Part of the elastic-docs-skills plugin — 21 skills, 1 agent shipped together

Good fit It is for reviewing Markdown files or documentation directories and reporting style issues without changing the files.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/elastic/elastic-docs-skills/docs-check-style
About the project

Elastic Docs Skills is a collection of Claude Code skills for creating and maintaining Elastic documentation. It is for developers and documentation contributors who use coding agents such as Claude Code, Cursor, or Codex. The catalogue entries are the project's reusable documentation workflows, agents, plugin, and instruction.

elastic/elastic-docs-skills · 71 stars · on GitHub · elastic.github.io

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.

Any agent
npx skills add elastic/elastic-docs-skills --skill docs-check-style
Clone the repo
git clone --depth 1 https://github.com/elastic/elastic-docs-skills

Made for: Claude Code.

Or install elastic-docs-skills, the plugin that ships this one along with the rest of its 21 skills, 1 agent.

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 docs-check-style

README.md
[![agentmods](https://agentmods.dev/badge/skills/elastic/elastic-docs-skills/docs-check-style/github.svg)](https://agentmods.dev/skills/elastic/elastic-docs-skills/docs-check-style)
Your own site
<a href="https://agentmods.dev/skills/elastic/elastic-docs-skills/docs-check-style"><img src="https://agentmods.dev/badge/skills/elastic/elastic-docs-skills/docs-check-style/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for docs-check-style

Your own site · 80×15
<a href="https://agentmods.dev/skills/elastic/elastic-docs-skills/docs-check-style"><img src="https://agentmods.dev/badge/skills/elastic/elastic-docs-skills/docs-check-style.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 46 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 4,015 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe. Third-party audits
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
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.1 $0.00046 $0.04015
Opus 5 $0.00023 $0.02008
Sonnet 5 $0.00009 $0.00803
Haiku 4.5 $0.00005 $0.00402

Measured 9d ago against content hash 2548c37026cd, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-08, from the pricing page.

Security

Grade A, and why

docs-check-style 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 9d 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/review/docs-check-style/SKILL.md · 239 lines

How it starts

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

You are a style reviewer for Elastic documentation. Your job is to check docs against the Elastic style guide and report issues — never auto-fix.

Inputs

$ARGUMENTS is the file or directory to check. If empty, ask the user what to review.

Step 1: Refresh style guidance

Use the Elastic docs MCP get_document_by_url tool with includeBody: true to fetch the style guide pages listed in sources. If the MCP is unavailable, fetch the .md page URLs directly. Prefer the fetched guidance over the embedded checklist when they conflict, and mention any source conflict in the report.

Step 2: Run Vale

Run the Vale CLI:

vale --output=line $ARGUMENTS

If Vale is not installed, skip this step and note it in your report. Proceed with manual review.

Step 3: Read the document(s)

Glob for .md files in $ARGUMENTS (or read the single file). Read each file fully.

Step 4: Review against style rules

Check every document against the rules below. Categorize each issue by area.


Voice and tone

  • Active voice: Prefer active over passive. Passive is acceptable only when active sounds awkward.
  • Present tense: Write in present tense. Avoid "will," "would," "should," "could," "currently," "now."
  • Second person: Use "you/your/yours." Never use "I/me/my." Use "we" sparingly ("we recommend" is OK).
  • No "please": Remove "please" from instructions. Exception: when users must wait or face inconvenience.
  • Contractions: Use them for conversational tone. Don't mix contractions with spelled-out equivalents in the same context. Avoid ambiguous contractions ("there'd," "it'll," "they'd").
  • Concise sentences: Limit conjunctions to two per sentence. Prefer simple present over gerunds in prose.
  • Informational tone: Most docs should be direct, neutral, and scannable. Reserve friendly/stimulating tones for tutorials and release highlights.

Read the full file on GitHub · 239 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. 9d ago First seen · 239 lines · 46 tokens per session scan A 2548c37026cd

Subscribe to this mod's changes

docs-check-style is a skill published in the GitHub repository elastic/elastic-docs-skills (71 stars, last pushed yesterday), licensed Apache-2.0. It adds 46 tokens to every session and 4,015 once invoked, about $0.0002 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-30.