api-doc-maintainer

api-doc-maintainer is a skill for Codex from Eliyce/paqad-ai. It costs 14 tokens per session (592 once invoked), scanned A, original, MIT.

A documentation helper that keeps each module’s API reference aligned with changed endpoints, data formats, permissions, and error behavior.

In plain words
What is it for?
Use it after adding, removing, or changing API endpoints, request or response data, authentication rules, permissions, or error behavior.
Why use it?
It prevents related API documentation from becoming inconsistent after a change. Developers can update the affected references together instead of missing connected details.

Skill for Codex

Written for Codex: agents/openai.yaml present.

Good fit Use it after adding, removing, or changing API endpoints, request or response data, authentication rules, permissions, or error behavior.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/eliyce/paqad-ai/api-doc-maintainer
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 Eliyce/paqad-ai --skill api-doc-maintainer
Clone the repo
git clone --depth 1 https://github.com/Eliyce/paqad-ai

Made for: Codex.

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-maintainer

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/eliyce/paqad-ai/api-doc-maintainer"><img src="https://agentmods.dev/badge/skills/eliyce/paqad-ai/api-doc-maintainer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 14 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 592 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.00014 $0.00592
Opus 5 $0.00007 $0.00296
Sonnet 5 $0.00003 $0.00118
Haiku 4.5 $0.00001 $0.00059

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

Security

Grade A, and why

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

The scan reads SKILL.md. This mod also ships 2 executable files (scripts/find-api-docs.sh, scripts/lint-output.sh), 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.

runtime/base/skills/api-doc-maintainer/SKILL.md · 69 lines

How it starts

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

What It Does

Keeps per-module API docs accurate after endpoint changes by updating routes, schemas, permissions, and error references together instead of as disconnected edits.

Use This When

Use this after any implementation or design change that adds, removes, or modifies endpoints, payloads, auth rules, or API error behavior.

Inputs

  • Read the module API docs first: api/endpoints.md, api/schemas.md, and api/error-codes.md when they exist.
  • Read the changed controllers, routes, handlers, or generated endpoint inventory for the module.
  • Read references/api-entry-requirements.md before editing the docs.

Procedure

  1. Run scripts/find-api-docs.sh to enumerate the canonical per-module API doc paths that already exist.
  2. Identify endpoints whose request, response, auth, permission, or error behavior changed.
  3. Update or add endpoint entries using assets/endpoint-entry.template.md — fill every required field; never ship a partial entry.
  4. Update schemas and error codes in the same pass; cross-link new errors to the module error catalog.
  5. Verify documented auth, versioning, and rate-limit statements still match implementation.
  6. Format the report per assets/output.template.md and validate with scripts/lint-output.sh.

Output Contract

  • Match assets/output.template.md: ## Updated API Docs (one bullet per file with backticked path) and ## Coverage Gaps.
  • Output must pass scripts/lint-output.sh (exit 0).
  • Required-but-missing endpoint details belong under Coverage Gaps, never as guessed entries.

Escalate / Stop Conditions

  • Ask when the implementation does not expose enough evidence to confirm auth, permissions, or payload shape.
  • Warn when code and existing docs disagree on a breaking API behavior.
  • Do not create placeholder endpoint entries with missing required fields.

Resources

  • references/api-entry-requirements.md
  • scripts/find-api-docs.sh
  • scripts/lint-output.sh
  • assets/output.template.md
  • assets/endpoint-entry.template.md
  • runtime/capabilities/coding/stacks/laravel/references/tools/testing.md
  • agents/openai.yaml

Read the full file on GitHub · 69 lines

Files

What ships with it

6 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. 9d ago First seen · 69 lines · 14 tokens per session scan A 6495c62221dd

Subscribe to this mod's changes

api-doc-maintainer is a skill published in the GitHub repository Eliyce/paqad-ai (8 stars, last pushed 2d ago), licensed MIT. It adds 14 tokens to every session and 592 once invoked, about $0.0001 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.