docs-syntax-help

docs-syntax-help is a skill for Claude Code, Codex from elastic/elastic-docs-skills. It costs 45 tokens per session (3,889 once invoked), scanned A, original, Apache-2.0.

A writing and troubleshooting guide for MyST Markdown, a Markdown format that supports structured blocks called directives, including Elastic-specific ones. It explains how to write, nest, and repair these blocks.

In plain words
What is it for?
Use it when writing or editing Elastic documentation with directives, tabs, notes, code blocks, or other extended Markdown structures.
Why use it?
It helps resolve markup mistakes that can cause documentation builds to fail or render incorrectly. It also reduces guesswork about directive syntax.

Skill for Claude CodeCodex

Part of the elastic-docs-skills plugin — 21 skills, 4 agents shipped together

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/elastic/elastic-docs-skills/docs-syntax-help
Any agent
npx skills add elastic/elastic-docs-skills --skill docs-syntax-help
Clone the repo
git clone --depth 1 https://github.com/elastic/elastic-docs-skills

Made for: Claude Code, Codex.

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

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-syntax-help

README.md
[![agentmods](https://agentmods.dev/badge/skills/elastic/elastic-docs-skills/docs-syntax-help.svg)](https://agentmods.dev/skills/elastic/elastic-docs-skills/docs-syntax-help)
Your own site
<a href="https://agentmods.dev/skills/elastic/elastic-docs-skills/docs-syntax-help"><img src="https://agentmods.dev/badge/skills/elastic/elastic-docs-skills/docs-syntax-help.svg" alt="Measured on agentmods" height="20"></a>
Per session 45 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,889 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. 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.00045 $0.03889
Opus 5 $0.00023 $0.01945
Sonnet 5 $0.00009 $0.00778
Haiku 4.5 $0.00005 $0.00389

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

Security

Grade A, and why

docs-syntax-help scanned grade A with 1 finding 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 4d 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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

wget elasticsearch-{{version}}-linux.tar.gz
skills/authoring/docs-syntax-help/SKILL.md · 592 lines

How it starts

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

You are an Elastic Docs syntax expert. Your job is to help users write correct MyST Markdown with Elastic-specific extensions, troubleshoot syntax errors, and fix malformed directives.

Directive syntax fundamentals

Directives use colon-fenced blocks with the directive name in curly braces:

:::{directive-name} [argument]
:option: value
Content here
:::
  • Opening: Three or more colons, directive name in {}
  • Argument: Optional, on the same line after the name
  • Options: One per line, colon-prefixed (:option: value)
  • Content: Markdown-processed body
  • Closing: Same number of colons as opening

Nesting directives

Outer directives need MORE colons than inner ones. Add one colon per nesting level:

::::{tab-set}
:::{tab-item} First
Content
:::
:::{tab-item} Second
Content
:::
::::

Three levels deep:

::::::{stepper}
:::::{step} Title
::::{tab-set}
:::{tab-item} Option A
Content
:::
::::
:::::
::::::

Literal blocks inside directives

Code blocks use backtick fences (not colons) to prevent Markdown processing:

:::{note}
```yaml
key: value
```
:::

Admonitions

Four standard types plus custom:

:::{note}
Supplemental information. No serious repercussions if ignored.
:::

:::{tip}
Advice to help users work more efficiently.
:::

:::{important}
Ignoring this could impact performance or stability.
:::

:::{warning}
Users could permanently lose data or leak sensitive information.
:::

:::{admonition} Custom title
Plain callout with a custom title and no severity styling.
:::

Read the full file on GitHub · 592 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. 4d ago First seen · 592 lines · 45 tokens per session scan A 4443a6fa0a3d

Subscribe to this mod's changes

docs-syntax-help is a skill published in the GitHub repository elastic/elastic-docs-skills (71 stars, last pushed 5d ago), licensed Apache-2.0. It adds 45 tokens to every session and 3,889 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.