typescript-coding-rule

A TypeScript documentation rule that limits which JSDoc tags developers may use and sets conventions for comments and exported code.

In plain words
What is it for?
Use it when writing TypeScript comments, documenting module exports and non-obvious code, and checking that tags such as @param follow the required format.
Why use it?
It keeps code documentation consistent and makes public functions, properties, and modules easier for other developers to understand.

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/sotayamashita/openapi-mcp-server/typescript-coding-rule
Clone the repo
git clone --depth 1 https://github.com/sotayamashita/openapi-mcp-server

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 225 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.00225
Opus 5 $0.00000 $0.00112
Sonnet 5 $0.00000 $0.00045
Haiku 4.5 $0.00000 $0.00022

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

Security

Grade A, and why

typescript-coding-rule 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 3d 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/typescript-coding-rule.mdc · 29 lines

What it actually says

Common

  • Use English for all comments

Comments and documentation

JSDoc tags

It allows a subset of JSDoc tags. Most tags must occupy their own line, with the tag at the beginning of the line.

/**
 * The "param" tag must occupy its own line and may not be combined.
 * @param left A description of the left param.
 * @param right A description of the right param.
 */
function add(left: number, right: number) { ... }

Document all top-level exports of modules

Use /** JSDoc */ comments to communicate information to the users of your code. Avoid merely restating the property or parameter name. You should also document all properties and methods (exported/public or not) whose purpose is not immediately obvious from their name, as judged by your reviewer.

Exception: Symbols that are only exported to be consumed by tooling, such as @NgModule classes, do not require comments.

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. 3d ago First seen · 29 lines · 225 tokens per session scan A eb68cc1f04de

Subscribe to this mod's changes

typescript-coding-rule is a cursor rule published in the GitHub repository sotayamashita/openapi-mcp-server (7 stars, last pushed 4d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 225 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-31.