Borrowing it
Nothing to install: this file belongs to shift-editor/shift. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/shift-editor/shift/main/.agents/skills/jsdoc/SKILL.mdgit clone --depth 1 https://github.com/shift-editor/shiftWrote 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.
[](https://agentmods.dev/skills/shift-editor/shift/jsdoc)<a href="https://agentmods.dev/skills/shift-editor/shift/jsdoc"><img src="https://agentmods.dev/badge/skills/shift-editor/shift/jsdoc/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.
<a href="https://agentmods.dev/skills/shift-editor/shift/jsdoc"><img src="https://agentmods.dev/badge/skills/shift-editor/shift/jsdoc.svg" alt="Reviewed on agentmods" width="80" height="20"></a>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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.00064 | $0.03410 |
| Opus 5.5 | $0.00026 | $0.01364 |
| Sonnet 5.5 | $0.00013 | $0.00682 |
| Haiku 4.5 | $0.00006 | $0.00341 |
Grade A, and why
jsdoc 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 1mo 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.
How it starts
The opening of the file, as written. The whole thing — 344 lines — stays where its author put it; the contents beside it link to each section on GitHub.
/jsdoc — Source API Contracts
Write JSDoc as the stable public contract a caller needs without reading the implementation.
JSDoc comments must sit immediately before the documented symbol and use /** ... */ so tooling can parse them. Follow the standard tag vocabulary from https://jsdoc.app/about-getting-started, adapted for TypeScript source.
Why this matters
- VS Code hover renders the first line in bold and the rest as body. A one-sentence contract on line 1 is the single highest-leverage thing you can write.
- TypeScript already encodes shape. JSDoc is for what types can't say: ownership, lifetime, mutation, side effects, side-channel reactivity, nullability semantics, performance class, call ordering.
- Code review is the second reader. Reviewers should be able to judge a call site against the doc without opening the implementation.
Runbook
- Identify the audience: caller, implementer, renderer, tool author, or maintainer.
- State the stable contract in one short opening sentence.
- Add details only for ownership, lifetime, reactivity, mutation, side effects, nullability, performance, or call ordering. Put long detail under
@remarks. - Use tags for callable APIs:
- Add
@paramfor every public constructor, method, or function parameter, and make the text describe the parameter's role, constraint, ownership, or valid range. - Add
@returnswhen a method returns a value, nullable result, created object, snapshot, or read-only view. - Add
@throws {ErrorType} when …for every observable failure mode (custom error class, semantic Error). - Do not add
@returns void; describe the side effect in prose instead.
- Add
- Cross-reference siblings with
@see {@link OtherSymbol}(one tag per related symbol). - Add
@exampleonly when the intended call flow, ordering, or output is not obvious from the signature. - Re-read the comment and delete implementation trivia, current call-site anecdotes, and unstable examples.
Hard Style Rules
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.
- 1mo ago First seen · 344 lines · 64 tokens per session scan A c592e3adc834
jsdoc is a skill published in the GitHub repository shift-editor/shift (379 stars, last pushed today), licensed Apache-2.0. It adds 64 tokens to every session and 3,410 once invoked, about $0.0003 per session on Opus 5.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-09-01.
Other skills, from other repositories
ax-rust-signature
Use when writing Rust code with axllm for string signatures, field descriptors, JSON schema output, validation, and typed tool argument shapes.
dd-code-generation
Use pup CLI for immediate Datadog operations or generate code for integration into applications.
ax-rust-llm
Use when writing Rust code with axllm for using the generated Ax package, factory functions, package docs, examples, and API reference.
better-fullstack
Scaffold, plan, or extend Better Fullstack projects with the generator, CLI, or MCP server. Use when a user asks to create, generate, or scaffold a fullstack starter; choose a Better Fullstack stack; add Better Fullstack capabilities; compare agent scaffolding paths; or avoid hand-authoring boilerplate project files.
screenshot-studio
Regenerate the Pisper product screenshots under docs/shots/ against the current UI. Starts an isolated dev instance, seeds fictional demo data through the real runtime APIs, captures every referenced page at the exact 2558x1380 asset size, and replaces the files. Use only when the user asks to refresh product…
prompt-cache-optimizer
Audit and optimize Pisper system-prompt and tool-schema token overhead while preserving stable prompt-cache prefixes, permissions, and runtime behavior. Invoke only for explicit prompt or tool-context optimization work.