Official agent skill

Kotlin KDoc Generator

by modelcontextprotocol in modelcontextprotocol/kotlin-sdk

Adds accurate KDoc comments to all public Kotlin declarations, with the right tags for constructor properties and parameters and examples where they help.

OfficialCustom licenceAuto-check passedDevelopment

Install Kotlin KDoc Generator

skills CLI
$ npx skills add modelcontextprotocol/kotlin-sdk --skill kdoc -a claude-code

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

GitHub CLI
$ gh skill install modelcontextprotocol/kotlin-sdk kdoc --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/modelcontextprotocol/kotlin-sdk.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/kdoc .claude/skills/kdoc && 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
kdoc
GitHub stars
1.5k
Token cost
~793 tokens
SKILL.md length
163 words
Files
1
Skills in repo
2
Repo updated
First seen
Licence
Custom licence

At a glance

Adds accurate KDoc comments to all public Kotlin declarations, with the right tags for constructor properties and parameters and examples where they help.

  • Documenting a Kotlin module's undocumented public API
  • SKILL.md covers Tag placement, Style and Examples
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Improving incomplete or low-quality KDoc comments

What it does

Every public Kotlin declaration gets a comment: classes, interfaces, objects, functions, properties, enums, type aliases and annotations, including deprecated ones. The agent reads the implementation, not only the signature, so descriptions are accurate. A table fixes tag placement: `@property` for constructor `val` or `var` parameters, `@param` for plain or private constructor parameters in the class comment, inline comments for body members, and `@param` and `@return` on functions.

Style rules ask for a single-sentence summary starting with a third-person verb, longer only for complex declarations. Example blocks are required for DSL builders and added for complex or non-obvious extension functions, and skipped for one-liners and simple getters. Links are used sparingly, no `@throws` or suspend notes are written, and incomplete or weak existing KDoc is rewritten.

When your agent uses it

  • Documenting a Kotlin module's undocumented public API
  • Improving incomplete or low-quality KDoc comments
  • Adding usage examples to DSL builders

Example prompts

  • “Add KDoc to every public class in the client package.”
  • “Document this file, and add an example block to the builder function.”
  • “Find public declarations without KDoc in ./src/commonMain and write the missing comments.”

Requirements

  • A Kotlin project

What it can do on your machine

Read from SKILL.md and the folder at commit 32e6483. 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 kotlin).

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

  • Network

    No URLs in SKILL.md.

    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.

Context cost

Kotlin KDoc Generator loads about 793 tokens when it runs. Until then it costs about 91 tokens; SKILL.md has 163 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~91
When it runs · the whole SKILL.md, loaded when a task matches
~793

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

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 163 words (~793 tokens).

“Add KDoc to all public Kotlin declarations (classes, interfaces, objects, functions, properties, enums, type aliases, annotations — including @Deprecated). Read the implementation, not just the signature, to write accurate descriptions.”

— opening of SKILL.md by modelcontextprotocol, Custom licence
name
kdoc

Read the full SKILL.md on GitHub

Files

Just SKILL.md in .claude/skills/kdoc of modelcontextprotocol/kotlin-sdk.

Open the folder on GitHubat commit 32e6483

Compare with similar skills

Kotlin KDoc Generator 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.

Kotlin KDoc Generator compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Kotlin KDoc Generator this skillmodelcontextprotocol/kotlin-sdk1.5k—~793Automated safety check: PassCustom licence
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mkdocsjeka-dev/jeka176—~2kAutomated safety check: PassApache-2.0
Releasesol4k/sol4k135—~949Automated safety check: PassApache-2.0
Composewebview Documentationparkwoocheol/compose-webview103—~1.5kAutomated safety check: PassMIT
Project Devengine ImplementationafkT/DevUtils1.6k—~561Automated safety check: PassApache-2.0

Similar skills

  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed
  • Mkdocs

    jeka-dev/jeka

    MkDocs documentation project reference covering CLI commands, mkdocs.yml configuration, Material theme setup, and plugin integration.

    176 GitHub stars~2k tokensUpdated 2 mo ago
    DevelopmentAuto-check passed
  • Release

    sol4k/sol4k

    Bump the sol4k library version everywhere, open a release PR, and draft GitHub release notes.

    135 GitHub stars~949 tokensUpdated 9 days ago
    DevelopmentAuto-check passed
  • Composewebview Documentation

    parkwoocheol/compose-webview

    Manages MkDocs documentation site and API references for ComposeWebView.

    103 GitHub stars~1.5k tokensUpdated 1 mo ago
    MobileAuto-check passed
  • 新增或修改 DevUtils DevEngine 第三方框架解耦实现:读取 DevAssist Engine 接口、DevEngine core 实现、 extensions 调用入口、默认初始化和 README,实现 JSON、Log、Image、Permission、Toast 等 Engine; 在用户要求创建某个功能 Engine、新增 Engine 实现、替换第三方库或扩展…

    1.6k GitHub stars~561 tokensUpdated 1 mo ago
    MobileAuto-check passed
  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    44k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed

More from modelcontextprotocol/kotlin-sdk

  • MCP Spec Docs Lookup

    modelcontextprotocol/kotlin-sdk

    Official

    Fetches live Model Context Protocol specification and docs from modelcontextprotocol.io whenever work touches MCP behavior, SEPs or conformance.

    1.5k GitHub stars~879 tokensUpdated 2 days ago
    Auto-check passed

Works with

Categories

Questions about Kotlin KDoc Generator

What does Kotlin KDoc Generator do?

Adds accurate KDoc comments to all public Kotlin declarations, with the right tags for constructor properties and parameters and examples where they help. Every public Kotlin declaration gets a comment: classes, interfaces, objects, functions, properties, enums, type aliases and annotations, including deprecated ones. The agent reads the implementation, not only the signature, so descriptions are accurate.

When should I use Kotlin KDoc Generator?

Kotlin KDoc Generator fits situations like: documenting a Kotlin module's undocumented public API; improving incomplete or low-quality KDoc comments; adding usage examples to DSL builders.

How do I install Kotlin KDoc Generator in Claude Code?

Run `npx skills add modelcontextprotocol/kotlin-sdk --skill kdoc -a claude-code`. Or copy the skill folder (.claude/skills/kdoc in modelcontextprotocol/kotlin-sdk) into .claude/skills/kdoc in your project. Claude Code loads it when a task matches its description.

How do I install Kotlin KDoc Generator in Codex?

Run `npx skills add modelcontextprotocol/kotlin-sdk --skill kdoc -a codex`. Or copy the skill folder (.claude/skills/kdoc in modelcontextprotocol/kotlin-sdk) into .agents/skills/kdoc in your project. Codex loads it when a task matches its description.

Can I use Kotlin KDoc Generator 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 modelcontextprotocol/kotlin-sdk --skill kdoc -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/kdoc, .gemini/skills/kdoc, .github/skills/kdoc and .opencode/skills/kdoc in your project.

What does Kotlin KDoc Generator need to run?

SKILL.md names no scripts, command-line tools or credentials: Kotlin KDoc Generator is instructions for the agent only. Our summary lists: A Kotlin project.

Does Kotlin KDoc Generator access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Kotlin KDoc Generator 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 Kotlin KDoc Generator use?

Kotlin KDoc Generator has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Kotlin KDoc Generator use?

About 793 tokens (SKILL.md is roughly 3.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Kotlin KDoc Generator?

Skills that share tags, products or a category with Kotlin KDoc Generator: Doc Sync (JetBrains/ideavim, 10k stars), Mkdocs (jeka-dev/jeka, 176 stars), Release (sol4k/sol4k, 135 stars) and Composewebview Documentation (parkwoocheol/compose-webview, 103 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Kotlin KDoc Generator?

modelcontextprotocol (a GitHub organization, an official publisher) maintains it in modelcontextprotocol/kotlin-sdk, which has 1,464 GitHub stars. The repository holds 2 skills in this directory. The repository was last updated on October 5, 2026.

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