docgen

docgen is a cursor rule for Cursor from Ocean-Industries-Concept-Lab/openbridge-webcomponents. It costs 0 tokens per session (404 once invoked), scanned A, original, Apache-2.0.

A command-line tool that drafts JSDoc comments for a TypeScript source file, using the file's related story and CSS files for context. It saves the draft as a separate review copy.

In plain words
What is it for?
It helps document UI components, standalone function modules, and abstract base classes. It also applies the project's required JSDoc structure and tags.
Why use it?
It reduces the work of writing documentation while keeping the original source unchanged. Developers can compare and approve the draft before merging it.

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/ocean-industries-concept-lab/openbridge-webcomponents/docgen
Clone the repo
git clone --depth 1 https://github.com/Ocean-Industries-Concept-Lab/openbridge-webcomponents

Made for: Cursor.

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

agentmods badge for docgen

README.md
[![agentmods](https://agentmods.dev/badge/rules/ocean-industries-concept-lab/openbridge-webcomponents/docgen.svg)](https://agentmods.dev/rules/ocean-industries-concept-lab/openbridge-webcomponents/docgen)
Your own site
<a href="https://agentmods.dev/rules/ocean-industries-concept-lab/openbridge-webcomponents/docgen"><img src="https://agentmods.dev/badge/rules/ocean-industries-concept-lab/openbridge-webcomponents/docgen.svg" alt="Measured on agentmods" height="20"></a>
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 404 The whole file, excluding the scripts and references it only reads on demand.
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.00000 $0.00404
Opus 5 $0.00000 $0.00202
Sonnet 5 $0.00000 $0.00081
Haiku 4.5 $0.00000 $0.00040

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

Security

Grade A, and why

docgen 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 4d 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/docgen.mdc · 43 lines

What it actually says

Doc Generator CLI

script/docgen/ is a small CLI that drafts JSDoc for a source file using an OpenAI model.

File Role
docs-gen.ts The CLI itself
prompt-system.txt The shared system prompt
README.md Setup, dependencies and usage

It reads the .ts plus its sibling .stories.ts and .css, auto-detects which of the three documentation patterns applies (concrete component, pure function module, abstract base class), and writes a *.generated.ts review copy next to the original.

It never edits the original

The review-copy design is the point: output is a draft for a human to diff and merge, not a change. Do not wire this into a build step, a lint rule, or a pre-commit hook, and do not commit *.generated.ts files.

Keep the prompt aligned with the rules

prompt-system.txt encodes the same conventions as jsdoc.md — the section order, the tone rule that forbids domain qualifiers, the TODO(designer) placeholder, and the structured @slot / @fires tag block.

When the JSDoc rules change, update the prompt too. Nothing enforces the link, so a rule added to jsdoc.md alone will be silently contradicted by every subsequent draft. Generated output still has to pass npm run lint:slots like any hand-written 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. 4d ago First seen · 43 lines · 0 tokens per session scan A 9ca6992aa544

Subscribe to this mod's changes

docgen is a cursor rule published in the GitHub repository Ocean-Industries-Concept-Lab/openbridge-webcomponents (91 stars, last pushed today), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 404 tokens. 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.