Write and maintain Micronaut Framework module guides for micronaut-projects repositories.

Apache-2.0Auto-check passedBackend & APIs

Install Docs

skills CLI
$ npx skills add micronaut-projects/micronaut-openapi --skill docs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install micronaut-projects/micronaut-openapi docs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/micronaut-projects/micronaut-openapi.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/docs .claude/skills/docs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
docs
GitHub stars
114
Token cost
~1.4k tokens
SKILL.md length
564 words
Files
3 (incl. references)
Skills in repo
7
Repo updated
First seen
Licence
Apache-2.0

At a glance

Write and maintain Micronaut Framework module guides for micronaut-projects repositories.

  • Works in 5 steps: Confirm docs layout and build tasks → Keep toc.yml and files in lockstep → Apply Micronaut docs macro conventions → …
  • Users ask to add
  • SKILL.md covers Goal, Procedure, Maintainer Delivery Contract and Validation Checklist, plus 1 more section
  • Reaches github.com

What it does

Docs is an agent skill from micronaut-projects/micronaut-openapi. Write and maintain Micronaut Framework module guides for micronaut-projects repositories. Use when users ask to add or update AsciiDoc guide sections, edit guide toc.yml, apply Micronaut docs macros, or fix docs build/publishing tasks.

Its SKILL.md is about 1.4k tokens, which your agent loads only when the skill is triggered. The skill folder holds 3 other files, including reference files (for example `references/control-panel-patterns.md` and `references/micronaut-docs-providers.md`). Compatibility notes: Micronaut framework repositories in micronaut-projects generated from micronaut-project-template

It sits in Backend & APIs, covering OpenAPI specifications. It works with OpenAPI. The repository describes itself as: Generates OpenAPI / Swagger Documentation for Micronaut projects. The licence is Apache-2.0.

When your agent uses it

  • Users ask to add
  • Update AsciiDoc guide sections
  • Edit guide toc.yml
  • Apply Micronaut docs macros

Example prompts

  • “/docs”

Requirements

  • Compatibility (from SKILL.md): Micronaut framework repositories in micronaut-projects generated from micronaut-project-template

Workflow steps

5 steps, taken from the step headings in SKILL.md.

  1. Confirm docs layout and build tasks
  2. Keep toc.yml and files in lockstep
  3. Apply Micronaut docs macro conventions
  4. Use generated configuration property references correctly
  5. Build and validate documentation

What it can do on your machine

Read from SKILL.md and the folder at commit 4877fd7. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are yaml and bash).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • github.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

  • Compatibility

    Micronaut framework repositories in micronaut-projects generated from micronaut-project-template

    From compatibility in the SKILL.md frontmatter.

Context cost

Docs loads about 1.4k tokens when it runs, and up to ~3k if it reads all its reference files. Until then it costs about 60 tokens; SKILL.md has 564 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~60
When it runs · the whole SKILL.md, loaded when a task matches
~1.4k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~3k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from micronaut-projects/micronaut-openapi at commit 4877fd7, republished under its Apache-2.0 licence (© micronaut-projects). 564 words, ~1,438 tokens.

Download SKILL.mdSave it as .claude/skills/docs/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.
name
docs
description
Write and maintain Micronaut Framework module guides for micronaut-projects repositories. Use when users ask to add or update AsciiDoc guide sections, edit guide toc.yml, apply Micronaut docs macros, or fix docs build/publishing tasks.
compatibility
Micronaut framework repositories in micronaut-projects generated from micronaut-project-template
license
Apache-2.0
metadata.author
Álvaro Sánchez-Mariscal
metadata.version
1.0.0

Docs (Micronaut Maintainer)

Use this skill for maintainer-facing guide work in Micronaut framework repositories. Do not default to end-user application documentation advice.

Goal

Implement source-backed documentation changes in src/main/docs/guide, keep toc.yml and content in sync, and validate with the Gradle docs pipeline used across micronaut-projects modules.

Procedure

  1. Confirm repository docs layout and build tasks.
  2. Plan toc.yml and .adoc updates in lockstep.
  3. Apply Micronaut docs macro conventions used by maintainers.
  4. Prefer generated configuration property references over manual tables.
  5. Build and validate publishGuide and docs outputs.
1) Confirm docs layout and build tasks
  • Check src/main/docs/guide/toc.yml first.
  • List relevant guide files under src/main/docs/guide/**/*.adoc.
  • If examples are involved, inspect doc-examples/ (if present) and plan snippet tags from executable sources.
  • If assets are involved, keep images in src/main/docs/resources/img/.
  • Confirm standard commands from CONTRIBUTING.md:
    • ./gradlew publishGuide (or ./gradlew pG) for guide assembly.
    • ./gradlew docs for guide + API docs assembly.
  • If repository layout diverges from template conventions, follow local conventions and explicitly report the divergence.
2) Keep toc.yml and files in lockstep

Treat src/main/docs/guide/toc.yml as navigation source of truth.

Rules:

  1. Every visible section must exist in toc.yml.
  2. Every toc.yml entry must resolve to a real .adoc path.
  3. Preserve section order unless the request explicitly changes navigation.
  4. Use nested sections for grouped topics when needed.

Example nested pattern:

yaml
controlPanels:
  title: Available Control Panels
  builtIn: Built-in
  management: Management

This maps to:

  • src/main/docs/guide/controlPanels.adoc
  • src/main/docs/guide/controlPanels/builtIn.adoc
  • src/main/docs/guide/controlPanels/management.adoc
3) Apply Micronaut docs macro conventions

Use docs macros registered by micronaut-build (DocsExtensionRegistry) and maintained for framework guides.

Preferred mapping:

NeedPreferred pattern
Dependency instructionsdependency:group:artifact[scope=...]
Source sample synchronized with test suitessnippet::path/to/File.ext[tags=...]
Multi-format configuration snippets[configuration] listing blocks
Configuration properties referenceinclude::{includedir}configurationProperties/<fqcn>.adoc[]
Shell commands[source,bash] blocks
Repository/release linkshttps://github.com/{githubSlug} and /releases links

Guardrails:

  • Do not handwrite separate Maven/Gradle dependency blocks when dependency: is suitable.
  • Do not replace Micronaut snippet:: macros with direct Asciidoctor [source] includes or pasted code blocks just because the current examples have one language. The macro is the multi-language, source-backed contract for generated module docs.
  • Do not remove snippet callouts when touching examples. Preserve existing callout tags and callout explanations unless the underlying executable source no longer has that behavior.
  • Do not duplicate configuration property tables manually when generated references exist.
  • Keep environment-sensitive instructions explicit (for example MICRONAUT_ENVIRONMENTS=dev).
  • Prefer stable links to official Micronaut docs for endpoint semantics.
Show full SKILL.md (187 more words)Show less
4) Use generated configuration property references correctly
  • micronaut-docs provides AsciiDocPropertyReferenceWriter, which generates AsciiDoc property fragments from configuration metadata.
  • Micronaut docs build wiring consumes those fragments via {includedir}configurationProperties/... includes.
  • Prefer includes over hand-maintained property tables.

See references/micronaut-docs-providers.md for confirmed provider/macro details and source locations.

5) Build and validate documentation

From repository root, run:

bash
./gradlew publishGuide
./gradlew docs

Validation checklist:

  1. Commands exit with code 0.
  2. Output exists under build/docs/.
  3. Updated sections appear in navigation and render without missing includes.
  4. Added images/links resolve.

If publishGuide passes but docs fails, fix the failing stage and rerun both commands.

Maintainer Delivery Contract

When finishing docs work, report:

  1. Exact changed files (.adoc, toc.yml, docs resources).
  2. Which conventions were applied (dependency:, snippet::, [configuration], generated property includes).
  3. Build commands run and outcomes.
  4. Any repo-specific divergences or follow-ups.

Validation Checklist

  • toc.yml and .adoc changes are consistent.
  • Macros and includes follow Micronaut maintainer conventions.
  • Existing snippet:: macros and callouts are preserved unless executable source changes require a different tagged snippet.
  • publishGuide and docs executed successfully.
  • Output and navigation verified under build/docs/.
  • Guidance remains maintainer-focused (not generic app docs).

References

  • references/micronaut-docs-providers.md
  • references/control-panel-patterns.md
  • CONTRIBUTING.md
  • src/main/docs/guide/toc.yml

© micronaut-projects, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 2 other files (references) in .agents/skills/docs of micronaut-projects/micronaut-openapi.

  • SKILL.md
  • references/control-panel-patterns.md
  • references/micronaut-docs-providers.md

Open the folder on GitHubat commit 4877fd7

Used in 2 other repositories

We found 2 copies of this SKILL.md (exact, near-identical or edited) in other folders. This page covers the copy in micronaut-projects/micronaut-openapi, which our catalogue first saw on October 7, 2026.

Compare with similar skills

Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs this skillmicronaut-projects/micronaut-openapi114—~1.4kAutomated safety check: PassApache-2.0
ToolJet Marketplace Plugin BuilderToolJet/ToolJet41k—~2.1kAutomated safety check: PassAGPL-3.0
Step Partsearthtojake/text-to-cad18k1 repos~1.5kAutomated safety check: PassMIT
API DesignerJeffallan/claude-skills12k2 repos~2kAutomated safety check: PassMIT
OpenAPI to MCP Servermcp-use/mcp-use11k—~5.2kAutomated safety check: PassApache-2.0
Use Yaakmountain-loop/yaak19k—~1.9kAutomated safety check: PassMIT

Similar skills

  • Turns an API description, such as an OpenAPI file or a Postman collection, into a connector plugin for ToolJet's marketplace and checks it with the repo's validator.

    41k GitHub stars~2.1k tokensUpdated today
    Backend & APIsAuto-check passed
  • Step Parts

    earthtojake/text-to-cad

    Find, evaluate, and download common purchasable CAD parts from step.parts, including named off-the-shelf actuators, servos, motors, electronics boards, connectors, screws, bolts, nuts, washers…

    18k GitHub starsUsed in 1 repo~1.5k tokens
    Backend & APIsAuto-check passed
  • API Designer

    Jeffallan/claude-skills

    Designs REST and GraphQL APIs from resource modeling to an OpenAPI 3.1 contract, with versioning, pagination and RFC 7807 error handling.

    12k GitHub starsUsed in 2 repos~2k tokens
    Backend & APIsAuto-check passed
  • OpenAPI to MCP Server

    mcp-use/mcp-use

    Turns an OpenAPI or Swagger spec into an MCP server with the mcp-use TypeScript SDK, mapping each operation to a tool, wiring auth, testing and deploying.

    11k GitHub stars~5.2k tokensUpdated today
    Backend & APIsAuto-check passed
  • Use Yaak

    mountain-loop/yaak

    A skill your agent uses when the user mentions Yaak, a Yaak workspace, or the yaak command, or asks to call, hit, or smoke test HTTP/REST endpoints, save or organize API requests for reuse or manual…

    19k GitHub stars~1.9k tokensUpdated yesterday
    Backend & APIsAuto-check passed
  • Old Coder API Design

    AmazingAng/old-coder

    Reviews or designs an HTTP/JSON API's endpoints, auth, pagination, versioning and deprecations, guarding against inventing a bespoke interface or silently breaking consumers.

    749 GitHub starsUsed in 1 repo~3.4k tokens
    Backend & APIsAuto-check passed

More from micronaut-projects/micronaut-openapi

  • Agent Md Refactor

    micronaut-projects/micronaut-openapi

    Refactor oversized agent instruction files into a progressive-disclosure structure.

    114 GitHub stars~766 tokensUpdated today
    Auto-check passed
  • Gradle

    micronaut-projects/micronaut-openapi

    Execute Gradle maintainer operations for Micronaut repositories using micronaut-build internals and modern Gradle best practices.

    114 GitHub stars~1.6k tokensUpdated today
    Auto-check passed
  • Guides

    micronaut-projects/micronaut-openapi

    Create or update standalone Micronaut Guides in micronaut-projects/micronaut-guides, including topic discovery, guide authoring, validation, PDF export, and pull request handoff.

    114 GitHub stars~1.9k tokensUpdated today
    Auto-check: notes
  • Skill Creator

    micronaut-projects/micronaut-openapi

    Create new Agent Skills or improve existing ones in an agent-agnostic way.

    114 GitHub stars~1.2k tokensUpdated today
    Auto-check passed
  • Coding

    micronaut-projects/micronaut-openapi

    Implement and review Java code changes for Micronaut framework repositories using maintainer standards, including JSpecify null-safety conventions.

    114 GitHub stars~2.6k tokensUpdated today
    Auto-check passed
  • Micronaut Sourcegen

    micronaut-projects/micronaut-openapi

    Add, integrate, or review Micronaut Sourcegen usage in modules that generate Java source, Kotlin source, Groovy-compatible source, or bytecode from ObjectDef, TypeDef, MethodDef, ExpressionDef…

    114 GitHub stars~3.3k tokensUpdated today
    Auto-check passed

Works with

Categories

Questions about Docs

What does Docs do?

Write and maintain Micronaut Framework module guides for micronaut-projects repositories. Docs is an agent skill from micronaut-projects/micronaut-openapi. Write and maintain Micronaut Framework module guides for micronaut-projects repositories.

When should I use Docs?

Docs fits situations like: users ask to add; update AsciiDoc guide sections; edit guide toc.yml; apply Micronaut docs macros.

How do I install Docs in Claude Code?

Run `npx skills add micronaut-projects/micronaut-openapi --skill docs -a claude-code`. Or copy the skill folder (.agents/skills/docs in micronaut-projects/micronaut-openapi) into .claude/skills/docs in your project. Claude Code loads it when a task matches its description.

How do I install Docs in Codex?

Run `npx skills add micronaut-projects/micronaut-openapi --skill docs -a codex`. Or copy the skill folder (.agents/skills/docs in micronaut-projects/micronaut-openapi) into .agents/skills/docs in your project. Codex loads it when a task matches its description.

Can I use Docs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add micronaut-projects/micronaut-openapi --skill docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs, .gemini/skills/docs, .github/skills/docs and .opencode/skills/docs in your project.

What does Docs need to run?

SKILL.md names no scripts, command-line tools or credentials: Docs is instructions for the agent only. Compatibility (from SKILL.md): Micronaut framework repositories in micronaut-projects generated from micronaut-project-template.

Does Docs access the network?

SKILL.md names 1 domain. In commands or code: github.com; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.

Is Docs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Docs use?

Docs is published under the Apache-2.0 licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Docs use?

About 1.4k tokens (SKILL.md is roughly 5.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 1.6k tokens, read only when the agent opens those files.

What are the alternatives to Docs?

Skills that share tags, products or a category with Docs: ToolJet Marketplace Plugin Builder (ToolJet/ToolJet, 41k stars), Step Parts (earthtojake/text-to-cad, 18k stars), API Designer (Jeffallan/claude-skills, 12k stars) and OpenAPI to MCP Server (mcp-use/mcp-use, 11k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs?

micronaut-projects (a GitHub organization) maintains it in micronaut-projects/micronaut-openapi, which has 114 GitHub stars. The repository holds 7 skills in this directory. The repository was last updated on October 8, 2026.

Source: micronaut-projects/micronaut-openapi on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.