doc

A command for adding JSDoc comments to TypeScript and JavaScript code. JSDoc is a standard way to describe functions, classes, interfaces, parameters, return values, errors, and examples inside code.

In plain words
What is it for?
Use it to document a specified file, especially when its functions or APIs need explanations and examples.
Why use it?
It makes undocumented code easier to understand while skipping comments that already exist and avoiding descriptions that merely repeat names.

Command

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 commands/echovic/blade-code/doc
Clone the repo
git clone --depth 1 https://github.com/echoVic/blade-code
Per session 7 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 314 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.00007 $0.00314
Opus 5 $0.00003 $0.00157
Sonnet 5 $0.00001 $0.00063
Haiku 4.5 $0.00001 $0.00031

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

Security

Grade A, and why

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

.blade/commands/doc.md · 63 lines

What it actually says

请为以下代码添加文档注释。

目标文件

@$1

文档规范

TypeScript/JavaScript

使用 JSDoc 格式:

/**
 * 函数简要描述
 *
 * 详细描述(可选)
 *
 * @param paramName - 参数描述
 * @returns 返回值描述
 * @throws {ErrorType} 错误描述
 * @example
 * ```typescript
 * const result = myFunction('input');
 * console.log(result); // 'output'
 * ```
 */

类和接口

/**
 * 类/接口的简要描述
 *
 * 详细描述,包括:
 * - 主要职责
 * - 使用场景
 * - 重要注意事项
 */

要求

  1. 只添加缺失的文档:已有文档的跳过
  2. 保持简洁:一句话能说清就不用两句
  3. 有意义的描述:不要重复函数名
  4. 添加示例:对于复杂 API 添加 @example
  5. 标注参数类型:如果 TypeScript 类型不够清晰

输出

请使用 Edit 工具逐个添加文档注释,每次添加后简短说明添加了什么。

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 · 63 lines · 7 tokens per session scan A e635b85712d2

Subscribe to this mod's changes

doc is a command published in the GitHub repository echoVic/blade-code (177 stars, last pushed 2d ago), licensed MIT. It adds 7 tokens to every session and 314 once invoked, about $0.0000 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.