sync-api-spec

sync-api-spec is a skill for Claude Code, Codex from jamesyang124/agent-skills. It costs 90 tokens per session (3,304 once invoked), scanned A, original, MIT.

A tool that scans project API routes and maintains a machine-readable reference file at docs/agents/api-spec.md. An API is the set of endpoints that software uses to communicate with other software.

In plain words
What is it for?
Use it for a full API documentation sync or to update selected routes. It rescans only new or changed handlers and can optionally publish the result to Confluence.
Why use it?
It keeps the API documentation aligned with the code as routes change. Coding agents, frontend developers, and product teams can use one compact reference to understand available endpoints.

Skill for Claude CodeCodex

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 skills/jamesyang124/agent-skills/sync-api-spec
Any agent
npx skills add jamesyang124/agent-skills --skill sync-api-spec
Clone the repo
git clone --depth 1 https://github.com/jamesyang124/agent-skills

Made for: Claude Code, 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 sync-api-spec

README.md
[![agentmods](https://agentmods.dev/badge/skills/jamesyang124/agent-skills/sync-api-spec.svg)](https://agentmods.dev/skills/jamesyang124/agent-skills/sync-api-spec)
Your own site
<a href="https://agentmods.dev/skills/jamesyang124/agent-skills/sync-api-spec"><img src="https://agentmods.dev/badge/skills/jamesyang124/agent-skills/sync-api-spec.svg" alt="Measured on agentmods" height="20"></a>
Per session 90 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,304 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.00090 $0.03304
Opus 5 $0.00045 $0.01652
Sonnet 5 $0.00018 $0.00661
Haiku 4.5 $0.00009 $0.00330

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

Security

Grade A, and why

sync-api-spec 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 3d 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.

.agent-settings/skills/tools/sync-api-spec/SKILL.md · 260 lines

How it starts

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

Sync API Spec

Install this skill globally

Install once — available in all projects.

# Claude
mkdir -p ~/.claude/skills/sync-api-spec
cp <agent-settings-repo>/.agent-settings/skills/tools/sync-api-spec/SKILL.md \
   ~/.claude/skills/sync-api-spec/SKILL.md
# Add to ~/.claude/CLAUDE.md: - **sync-api-spec** (`~/.claude/skills/sync-api-spec/SKILL.md`)

# Copilot
mkdir -p ~/.copilot/skills/sync-api-spec
cp <agent-settings-repo>/.agent-settings/skills/tools/sync-api-spec/SKILL.md \
   ~/.copilot/skills/sync-api-spec/SKILL.md

This skill maintains docs/agents/api-spec.md — a compact, machine-readable API reference for the consuming project. It scans the router for all routes, diffs against the existing spec file to find new or changed routes, re-scans only those handlers, and writes an updated file. An optional Confluence publish step is offered after the local file is written.

Arguments

All optional.

Token Meaning
one or more route paths (e.g. /v1/users) restrict the scan to those routes; default is a full sync of every route

Contract mode is not an argument — it is asked in step 0b of the process below.


Output File

Target: docs/agents/api-spec.md (relative to the consuming project root, not this repo).

Format is defined in references/api-spec-format.md.

Process

  1. Load project configuration: Read .agent-settings/project-config.md.
    • If the file is missing: tell the user to run setup-project-config first ("set up project config"), then stop.
    • If the file uses the legacy schema (has a top-level ## Confluence / ## Jira instead of ## MCP: atlassian): warn that it predates the per-MCP schema and tell the user to re-run setup-project-config to migrate — otherwise the Confluence publish step below cannot find the space/parent config.
    • Use framework, router file path, handler directory, DTO/model directory, and service directory from config throughout.

0b. Contract mode check: Ask the user: Generate in contract mode? (y/n) - Blank input: re-prompt — must type y or n. - Contract mode (y): the spec describes a planned / agreed-upon API that has not been implemented yet. The agent documents based on user-provided descriptions, not scanned code. Set CONTRACT_MODE=true. Skip steps 2–4 (no router scan, no handler scan). - Normal mode (n): scan existing code as usual. Set CONTRACT_MODE=false.

Read the full file on GitHub · 260 lines

Files

What ships with it

4 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. 3d ago First seen · 260 lines · 0 tokens per session scan A 3594b0107ca8

Subscribe to this mod's changes

sync-api-spec is a skill published in the GitHub repository jamesyang124/agent-skills (2 stars, last pushed 1mo ago), licensed MIT. It adds 90 tokens to every session and 3,304 once invoked, about $0.0005 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

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens