Agent skill

Jsdocs

by foldkit in foldkit/foldkit

Public API JSDoc. An agent skill from foldkit/foldkit.

MITAuto-check passedDevelopment

Install Jsdocs

skills CLI
$ npx skills add foldkit/foldkit --skill jsdocs -a claude-code

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

GitHub CLI
$ gh skill install foldkit/foldkit jsdocs --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/foldkit/foldkit.git skills-src && mkdir -p .claude/skills && cp -r skills-src/repos/effect/.agents/skills/jsdocs .claude/skills/jsdocs && 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
jsdocs
GitHub stars
935
Token cost
~445 tokens
SKILL.md length
207 words
Files
4
Skills in repo
18
Repo updated
First seen
Licence
MIT

At a glance

Public API JSDoc. An agent skill from foldkit/foldkit.

  • Works in 5 steps: Inspect the declaration, implementation,… → Select every applicable branch and load… → Make a focused API fix or module… → …
  • Reviewing Effect API documentation
  • Calls pnpm
  • Refining a modules documentation

What it does

Jsdocs is an agent skill from foldkit/foldkit. Public API JSDoc. Use when authoring or reviewing Effect API documentation, refining a module's documentation, or fixing documentation related diagnostics.

Its SKILL.md is about 450 tokens, which your agent loads only when the skill is triggered. The skill folder holds 3 other files (for example `categories.md`, `declarations.md` and `examples.md`).

It sits in Development, covering Technical documentation. The licence is MIT.

When your agent uses it

  • Reviewing Effect API documentation
  • Refining a modules documentation
  • Fixing documentation related diagnostics

Example prompts

  • “/jsdocs”

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

  1. Inspect the declaration, implementation, nearby JSDoc, tests, and call sites.
  2. Select every applicable branch and load its reference before editing
  3. Make a focused API fix or module refinement. Preserve verified facts and
  4. For module refinement or APIs with close alternatives, audit @see links
  5. Run pnpm jsdocs --check and every applicable root validation command.

What it can do on your machine

Read from SKILL.md and the folder at commit 49dc36e. 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

    Shell commands in SKILL.md call:

    • pnpm

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

  • Network

    No URLs in SKILL.md. Its commands use pnpm, which can reach the network depending on how they are called.

    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

Jsdocs loads about 445 tokens when it runs. Until then it costs about 41 tokens; SKILL.md has 207 words of instructions outside code blocks.

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

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 foldkit/foldkit at commit 49dc36e, republished under its MIT licence (© foldkit). 207 words, ~445 tokens.

Download SKILL.mdSave it as .claude/skills/jsdocs/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.
name
jsdocs
description
Public API JSDoc. Use when authoring or reviewing Effect API documentation, refining a module's documentation, or fixing documentation related diagnostics.

Workflow

  1. Inspect the declaration, implementation, nearby JSDoc, tests, and call sites.
  2. Select every applicable branch and load its reference before editing:
  3. Make a focused API fix or module refinement. Preserve verified facts and valuable examples rather than rewriting mechanically.
  4. For module refinement or APIs with close alternatives, audit @see links and inspect implementation and tests for concrete **Gotchas**.
  5. Run pnpm jsdocs --check and every applicable root validation command.

@internal declarations and default exports are outside public JSDoc authoring. Checked files do not support exported enums or empty export declarations.

Public declarations use a multiline block with one self-contained practical description paragraph. Start functions and methods with a present-tense action; match nearby noun-family phrasing for values. Optional non-empty sections appear once in this order: **When to use**, **Details**, **Gotchas**. Separate descriptions, sections, examples, and tags with one blank line. **When to use** states a positive use case distinct from the description; reserve **Gotchas** for concrete caveats and failure modes.

The task is complete when every changed public declaration satisfies each applicable reference, the checker passes, runnable examples pass their targeted doctest, and all other applicable root checks pass or are reported as not run.

© foldkit, MIT. 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 3 other files in repos/effect/.agents/skills/jsdocs of foldkit/foldkit.

  • SKILL.md
  • categories.md
  • declarations.md
  • examples.md

Open the folder on GitHubat commit 49dc36e

Compare with similar skills

Jsdocs 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.

Jsdocs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Jsdocs this skillfoldkit/foldkit935—~445Automated safety check: PassMIT
Diagram Designcathrynlavery/diagram-design47k1 repos~7.5kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.5kAutomated safety check: PassGPL-3.0
Draw.io Diagram StudioAgents365-ai/drawio-skill10k—~2.4kAutomated safety check: NotesMIT

Similar skills

  • 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.

    47k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed
  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed
  • 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
  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.5k tokensUpdated today
    DevelopmentAuto-check passed
  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 7 days ago
    DevelopmentAuto-check: notes
  • Dark Architecture Diagram Builder

    Cocoon-AI/architecture-diagram-generator

    Creates dark-themed system, cloud, security and network architecture diagrams as self-contained HTML files with inline SVG and CSS.

    7.4k GitHub starsUsed in 1 repo~2.1k tokens
    DevelopmentAuto-check passed

More from foldkit/foldkit

All 18 skills in this repo
  • Commit Changes

    foldkit/foldkit

    Create a git commit in the Foldkit monorepo with changeset enforcement and formatting.

    935 GitHub stars~1.2k tokensUpdated today
    Auto-check passed
  • Foldkit

    foldkit/foldkit

    A skill your agent uses whenever working with Foldkit. An agent skill from foldkit/foldkit.

    935 GitHub stars~1.5k tokensUpdated today
    Auto-check passed
  • Outline, draft, or revise a Foldkit version release blog post using the repository's announcement style and editorial preferences.

    935 GitHub stars~1k tokensUpdated today
    Auto-check passed
  • Audit Program

    foldkit/foldkit

    Audit an existing Foldkit program against the architecture, conventions, and quality bar.

    935 GitHub stars~7.2k tokensUpdated today
    Auto-check passed
  • Generate Program

    foldkit/foldkit

    Generate a complete, idiomatic Foldkit program from a natural language description.

    935 GitHub stars~20k tokensUpdated today
    Auto-check passed
  • Changesets

    foldkit/foldkit

    Concise PR finalization changesets. An agent skill from foldkit/foldkit.

    935 GitHub stars~923 tokensUpdated today
    Auto-check passed

Categories

Questions about Jsdocs

What does Jsdocs do?

Public API JSDoc. An agent skill from foldkit/foldkit. Jsdocs is an agent skill from foldkit/foldkit. Public API JSDoc.

When should I use Jsdocs?

Jsdocs fits situations like: reviewing Effect API documentation; refining a modules documentation; fixing documentation related diagnostics.

How do I install Jsdocs in Claude Code?

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

How do I install Jsdocs in Codex?

Run `npx skills add foldkit/foldkit --skill jsdocs -a codex`. Or copy the skill folder (repos/effect/.agents/skills/jsdocs in foldkit/foldkit) into .agents/skills/jsdocs in your project. Codex loads it when a task matches its description.

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

What does Jsdocs need to run?

Going by SKILL.md and its folder, Jsdocs needs the command-line tools its instructions call (pnpm).

Does Jsdocs 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 Jsdocs 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 Jsdocs use?

Jsdocs is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Jsdocs use?

About 445 tokens (SKILL.md is roughly 1.8k 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 Jsdocs?

Skills that share tags, products or a category with Jsdocs: Diagram Design (cathrynlavery/diagram-design, 47k stars), Simple English (moeru-ai/airi, 50k stars), Doc Sync (JetBrains/ideavim, 10k stars) and Mailspring App Screenshots (Foundry376/Mailspring, 18k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Jsdocs?

foldkit (a GitHub organization) maintains it in foldkit/foldkit, which has 935 GitHub stars. The repository holds 18 skills in this directory. The repository was last updated on October 9, 2026.

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