jsdoc

A documentation rule for JSDoc, the comment format commonly used to document JavaScript and TypeScript code. It is intended for a framework-independent developer-tools panel supporting TanStack libraries and custom plugins.

In plain words
What is it for?
Use it when writing or reviewing JSDoc for the devtools panel, especially its TanStack-library integrations and custom devtool plugins.
Why use it?
It keeps the source comments suitable for conversion into website documentation and avoids unsupported annotation tags.

Cursor rule for Cursor

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 rules/tanstack/devtools/jsdoc
Clone the repo
git clone --depth 1 https://github.com/TanStack/devtools

Made for: Cursor.

Per session 72 This file is loaded in full into every session.
When invoked 72 The same file — it is already loaded in full.
Security scan A 0 findings. 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.00072 $0.00072
Opus 5 $0.00036 $0.00036
Sonnet 5 $0.00014 $0.00014
Haiku 4.5 $0.00007 $0.00007

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

Security

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 2d 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.

.cursor/rules/jsdoc.mdc · 10 lines

What it actually says

Your rule content

  • The JSDoc in this repo is important as it gets converted to markdown docs for the website, so it should read like documentation.
  • Don't include @params, @args, @template, or @returns in our jsdoc
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. 2d ago First seen · 10 lines · 72 tokens per session scan A 49f4d9bb9f86

Subscribe to this mod's changes

jsdoc is a cursor rule published in the GitHub repository TanStack/devtools (493 stars, last pushed 2d ago), licensed MIT. It adds 72 tokens to every session, about $0.0004 per session on Opus 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-08-30.