annotate-source-files SKILL.md skillB
annotate-source-files from pjt222/agent-almanac is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add pjt222/agent-almanac/annotate-source-files@v1.0Pins v1.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- B, 16 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- pjt222/agent-almanac
- Path
i18n/caveman-lite/skills/annotate-source-files/SKILL.md- Versions recorded
- 4
- Latest version
- v1.0, committed Aug 17, 2026
- First version recorded
- Apr 19, 2026
- Size
- 12,279 bytes
- Repository stars
- 43
- License
- MIT
Add PUT workflow annotations to source files using the correct language-specific comment prefix. Covers annotation syntax, skeleton generation via put_generate(), multiline annotations, .internal variables, and validation. Supports 30+ languages with automatic comment prefix detection. Use after analyzing a codebase and having an annotation plan, when adding workflow documentation to new or existing source files, or when documenting data pipelines, ETL processes, or multi-step computations.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# Annotate Source Files
Add PUT workflow annotations to source files so putior can extract structured workflow data and generate Mermaid diagrams.
## When to Use
- After analyzing a codebase with `analyze-codebase-workflow` and having an annotation plan
- Adding workflow documentation to new or existing source files
- Enriching auto-detected workflows with manual labels and connections
- Documenting data pipelines, ETL processes, or multi-step computations
## Inputs
- **Required**: Source files to annotate
- **Required**: Annotation plan or knowledge of the workflow steps
- **Optional**: Style preference: single-line or multiline (default: single-line)
- **Optional**: Whether to use `put_generate()` for skeleton generation (default: yes)
## Procedure
### Step 1: Determine Comment Prefix
Each language has a specific comment prefix for PUT annotations. Use `get_comment_prefix()` to find the correct one.
```r
library(putior)
# Common prefixes
get_comment_prefix("R") # "#"
get_comment_prefix("py") # "#"
get_comment_prefix("sql") # "--"
get_comment_prefix("js") # "//"
get_comment_prefix("ts") # "//"
get_comment_prefix("go") # "//"
get_comment_prefix("rs") # "//"
…Read the whole file at its exact version.
How to install
mdr add pjt222/agent-almanac/annotate-source-files@sha256:29f770ab4d00be65The line at the top of this page pins the label v1.0, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_6gz7rwk74zu6jjb5)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 4 versions of this file, between Apr 19, 2026 and Aug 17, 2026, about one every 40 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.0 latest | 2026-08-17 | a784899 | 12,279 B | B | view · diff |
| v1.0 | 2026-06-05 | 33b561c | 12,250 B | B | view · diff |
| v1.0 | 2026-04-19 | a31852a | 12,246 B | B | view · diff |
| v1.0 | 2026-04-19 | e334ebd | 12,293 B | B | view |
Audit of the latest version
- fail: No script tag (matched: <script)
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (12279 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
Starting a new one? Use a template for SKILL.md on mdpantry, which passes every one of these checks and says what to change in it.
Source
pjt222/agent-almanac · 43 stars · license MIT · pushed 2026-11-06 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_6gz7rwk74zu6jjb5 GET https://markdownregistry.com/api/v1/resolve?ref=pjt222/agent-almanac/annotate-source-files GET https://markdownregistry.com/api/v1/blob/29f770ab4d00be650d89145ff0265e8b1b9f6c6b401cad22a1d77d9aa4cae549
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.