ovellum-docs

ovellum-docs is a skill for Claude Code from oinam/ovellum. It costs 79 tokens per session (716 once invoked), scanned A, original, MIT.

A documentation tool for TypeScript and JavaScript projects. It builds websites from documentation and combines generated API reference pages with hand-written explanations that can survive later rebuilds.

In plain words
What is it for?
Use it to start a documentation site, generate API reference pages, add explanations around generated content, build manual Markdown docs, validate documentation, and produce an llms.txt file for AI tools.
Why use it?
Generated documentation is normally overwritten when the source changes. Ovellum provides protected areas for manual text and moves text whose source symbol was removed into a folder for review.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin. Also seen: mentions AGENTS.md.

Part of the ovellum plugin — 1 skill, 1 MCP server shipped together

Good fit Use it to start a documentation site, generate API reference pages, add explanations around generated content, build manual Markdown docs, validate documentation, and produce an llms.txt file for AI tools.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/oinam/ovellum/ovellum-docs
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.

Any agent
npx skills add oinam/ovellum --skill ovellum-docs
Clone the repo
git clone --depth 1 https://github.com/oinam/ovellum

Made for: Claude Code.

Or install ovellum, the plugin that ships this one along with the rest of its 1 skill, 1 MCP server.

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 ovellum-docs

README.md
[![agentmods](https://agentmods.dev/badge/skills/oinam/ovellum/ovellum-docs/github.svg)](https://agentmods.dev/skills/oinam/ovellum/ovellum-docs)
Your own site
<a href="https://agentmods.dev/skills/oinam/ovellum/ovellum-docs"><img src="https://agentmods.dev/badge/skills/oinam/ovellum/ovellum-docs/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for ovellum-docs

Your own site · 80×15
<a href="https://agentmods.dev/skills/oinam/ovellum/ovellum-docs"><img src="https://agentmods.dev/badge/skills/oinam/ovellum/ovellum-docs.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 79 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 716 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00079 $0.00716
Opus 5 $0.00039 $0.00358
Sonnet 5 $0.00016 $0.00143
Haiku 4.5 $0.00008 $0.00072

Measured 9d ago against content hash a823e758268e, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-10, from the pricing page.

Security

Grade A, and why

ovellum-docs 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 9d 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.

plugins/ovellum/skills/ovellum-docs/SKILL.md · 66 lines

How it starts

The opening of the file, as written. The whole thing — 66 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Ovellum docs

Ovellum is a documentation tool for TypeScript and JavaScript: a merge engine that lets auto-generated API docs and hand-written prose live in the same files, plus a static-site builder for purely manual docs. Site: https://ovellum.oss.oinam.com.

Setup

  • Install (local to the project, so CI and npx resolve the same version): npm install -D ovellum
  • Scaffold: npx ovellum init. It writes a commented ovellum.config.ts, a starter page, an AGENTS.md, and .gitignore entries. Three modes:
    • manual — hand-written Markdown → static site.
    • auto — Markdown generated from source on every build.
    • hybrid — generated, then merged with hand-written zones (the default and the differentiator).

The hybrid contract (the rule to respect)

Generated files are regenerated on every build. Hand-written prose survives only inside a protected zone:

<!-- @manual:start id="why" -->
Prose that survives regeneration.
<!-- @manual:end -->

Anything outside a zone in a generated file is overwritten. When the symbol a zone was attached to disappears (a rename or refactor), its prose is moved to .ovellum/orphans/ rather than lost — review it with ovellum orphans, and use ovellum diff to spot likely renames.

Commands (all support --json; stable exit codes 0 / 1 / 3)

  • ovellum build — parse + generate + merge, or build the site.
  • ovellum check — validate internal links + flag unsafe URLs (exit 1 on issues).
  • ovellum diff — preview what a rebuild would change (added/removed/changed/ renamed symbols); --exit-code to gate CI.
  • ovellum orphans — list quarantined prose (--stale for old ones).

Driving Ovellum as an agent

Prefer the MCP server — it exposes the operations as tools, including the one no other docs tool offers: writing prose into a protected zone that survives regeneration.

claude mcp add ovellum -- npx ovellum mcp --cwd /path/to/project

Tools: ovellum_query_symbol, ovellum_diff, ovellum_check, ovellum_list_orphans, ovellum_get_page, ovellum_build, and ovellum_write_zone (write/update a @manual block under an anchor id; dryRun to preview).

Read the full file on GitHub · 66 lines

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. 9d ago First seen · 66 lines · 79 tokens per session scan A a823e758268e

Subscribe to this mod's changes

ovellum-docs is a skill published in the GitHub repository oinam/ovellum (1 stars, last pushed 1mo ago), licensed MIT. It adds 79 tokens to every session and 716 once invoked, about $0.0004 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.

Related

Other skills, from other repositories

init

Bootstrap docaudit for a repo, or add and refresh its optional local documentation harness. Use when the user asks to set up docaudit, initialize the doc-audit harness, or run docaudit on a repo that lacks /check-docs / /review-docs / doc-lint. Inventories the repo, proposes a doc-audit.json config for approval…

akira993/doc-audit-harness · 101 tokens

audit

Change-driven documentation audit. Use when the user asks to audit docs since the last audit, check documentation consistency after code/config changes, run a full doc consistency sweep, or verify nothing is stale before a release. Diffs since the anchor, maps changed files to impacted docs, runs the configured…

akira993/doc-audit-harness · 80 tokens

using-docshark

Use when installing, running, and troubleshooting DocShark as an MCP server, including client setup for STDIO mode and endpoint checks for HTTP mode.

Michael-Obele/docshark · 35 tokens

typo3-docs

Use when creating, editing, or reviewing TYPO3 extension documentation (Documentation/.rst, guides.xml, README.md, XLF translations), rendering docs with Docker, using TYPO3 RST directives, adding screenshots, deploying to docs.typo3.org, improve docs, fix documentation, or XLIFF 2-space indentation (TYPO3 v14+).

netresearch/typo3-docs-skill · 77 tokens

docshark

Use when answering framework, library, SDK, or API documentation questions with DocShark MCP tools, especially for indexed-doc search, full-page retrieval, and library lifecycle tasks.

Michael-Obele/docshark · 39 tokens

keep-the-why

Extract and preserve the reasoning code cannot explain - decisions, rejected alternatives, workarounds, incidents, constraints - plus project setup and maintainer interviews. Not for what changed (see Keep a Changelog) - only why.

oliver-zehentleitner/keep-the-why · 50 tokens