snek.doc.function

A function-documentation helper that reads one function and drafts comments or a docstring in the style used by its programming language.

In plain words
What is it for?
Use it to document a named function or a function at a given line in Rust, Python, JavaScript, TypeScript, or Go.
Why use it?
It reduces the time spent explaining parameters, return values, examples, and important details by hand.

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/4tyone/snek/snek.doc.function
Clone the repo
git clone --depth 1 https://github.com/4tyone/snek
Per session 5 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 195 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.00005 $0.00195
Opus 5 $0.00003 $0.00097
Sonnet 5 $0.00001 $0.00039
Haiku 4.5 $0.00001 $0.00019

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

Security

Grade A, and why

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

templates/commands/snek.doc.function.md · 40 lines

What it actually says

Document Function

Generate documentation for a specific function.

Usage

User provides:

  • File path
  • Function name or line number

Steps

  1. Get file outline to locate function:
.snek/scripts/get-file-outline.sh "/path/to/file"
  1. Read the function code.

  2. Generate documentation including:

    • Brief description of what the function does
    • Parameters with types and descriptions
    • Return value description
    • Example usage (if applicable)
    • Any important notes or caveats
  3. Format documentation in the appropriate style for the language:

    • Rust: /// doc comments
    • Python: docstring with Google/NumPy style
    • JavaScript/TypeScript: JSDoc
    • Go: godoc style
  4. Present the documentation for user to apply.

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 · 40 lines · 5 tokens per session scan A 22ed949f7303

Subscribe to this mod's changes

snek.doc.function is a command published in the GitHub repository 4tyone/snek (10 stars, last pushed 8mo ago), licensed Apache-2.0. It adds 5 tokens to every session and 195 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-31.