api-doc-authoring

api-doc-authoring is a skill for Claude Code from rjmurillo/ai-agents. It costs 55 tokens per session (1,708 once invoked), scanned A, original, MIT.

A method for writing API documentation around a developer's task. An API is a defined way for software to communicate; the method uses working examples and explains how to recover from common failures.

In plain words
What is it for?
Use it to write guides for calling an API, including setup, successful requests, and recovery when requests fail.
Why use it?
It prevents documentation from becoming a list of endpoints that leaves developers to work out the intended sequence themselves. Examples are checked so the main path is usable.

Skill for Claude Code

Written for Claude Code: user-invocable in frontmatter.

Runs only inside its plugin — its command needs a path that Claude Code sets for a plugin’s own hooks and for nothing else. Install the plugin, not this.

Part of the project-toolkit plugin — 125 skills, 25 commands, 33 agents, 5 hooks shipped together

Good fit Use it to write guides for calling an API, including setup, successful requests, and recovery when requests fail.

Compare 6 skills from other repositories ↓
Install

Getting it into your agent

This one installs as part of its plugin. Adding the marketplace and installing the plugin brings it with everything else the plugin ships.

Claude Code
/plugin marketplace add rjmurillo/ai-agents
Claude Code
/plugin install project-toolkit

Made for: Claude Code.

Or install project-toolkit, the plugin that ships this one along with the rest of its 125 skills, 25 commands, 33 agents, 5 hooks.

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 api-doc-authoring

README.md
[![agentmods](https://agentmods.dev/badge/skills/rjmurillo/ai-agents/api-doc-authoring/github.svg)](https://agentmods.dev/skills/rjmurillo/ai-agents/api-doc-authoring)
Your own site
<a href="https://agentmods.dev/skills/rjmurillo/ai-agents/api-doc-authoring"><img src="https://agentmods.dev/badge/skills/rjmurillo/ai-agents/api-doc-authoring/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 api-doc-authoring

Your own site · 80×15
<a href="https://agentmods.dev/skills/rjmurillo/ai-agents/api-doc-authoring"><img src="https://agentmods.dev/badge/skills/rjmurillo/ai-agents/api-doc-authoring.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 55 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,708 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.00055 $0.01708
Opus 5.5 $0.00022 $0.00683
Sonnet 5.5 $0.00011 $0.00342
Haiku 4.5 $0.00006 $0.00171

Measured 4d ago against content hash 1f0fef1a668d, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

api-doc-authoring 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 4d ago.

The scan reads SKILL.md. This mod also ships 2 executable files (scripts/api_examples.py, scripts/doc_examples.py), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

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.

.claude/skills/api-doc-authoring/SKILL.md · 160 lines

How it starts

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

API Doc Authoring

Document the task developers are trying to complete, prove the examples run, and make failure recovery first-class.

API documentation is entered through a developer use case, not through the implementation's endpoint inventory. A tired developer should reach a working path and recover from common failures without reverse-engineering the API.

This skill owns how API documentation is structured and validated for use. It does not own claim checking, prose style, or API design:

Concern Owner How this skill uses it
Behavioral and cross-document claims doc-accuracy Runs through the existing lifecycle gates. No second accuracy gate here.
DRY, YAGNI, derived mutable facts code-qualities-assessment Link to the canonical fact. Do not restate it in each example.
Voice, banned words, dashes voice.md and universal.md Consumed as written. This skill adds no style guide.
API and schema design the business-behavior-first design owner (#5411) Describe the resulting contract. Never redefine it.
Capability graph check_capability_graph.py (#5396) This skill's owns and depends-on metadata. doc-accuracy declares no capability block, so it is cited, not declared.

Triggers

document this API, write the API guide, quickstart for this endpoint, add examples to the API docs, document the error responses

When It Applies

Apply when a developer will call the API to finish a task and the docs are new, rewritten, or touched by an API contract change.

Skip the narrative when the artifact is a true reference listing, such as a generated schema page, or the API is trivial or internal with one obvious call. Write the reference, mark it as reference, and stop. Do not invent a use case to fill space.

Process

developer goal -> minimum working request -> expected response
  -> common failures + remediation -> advanced options
  -> execute examples, then doc-accuracy through the lifecycle

Read the full file on GitHub · 160 lines

Files

What ships with it

5 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 4d ago First seen · 160 lines · 55 tokens per session scan A 1f0fef1a668d

Subscribe to this mod's changes

api-doc-authoring is a skill published in the GitHub repository rjmurillo/ai-agents (48 stars, last pushed today), licensed MIT. It adds 55 tokens to every session and 1,708 once invoked, about $0.0002 per session on Opus 5.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-10-14.