docs-sync

docs-sync is a command for Claude Code from ShouZhengAI/CS146S_CN. It costs 0 tokens per session (203 once invoked), scanned A, original, MIT.

A command that keeps an API guide in sync with a FastAPI application's OpenAPI document, which is a machine-readable description of its endpoints and data.

In plain words
What is it for?
It fetches the OpenAPI document, compares paths, methods, parameters, requests, responses, and errors, then updates docs/API.md and reports remaining differences.
Why use it?
It removes the need to compare the application and API documentation by hand and helps prevent the guide from describing outdated endpoints or fields.

Command for Claude Code

Written for Claude Code: $ARGUMENTS substitution.

Good fit It fetches the OpenAPI document, compares paths, methods, parameters, requests, responses, and errors, then updates docs/API.md and reports remaining differences.

Compare 6 commands from other repositories ↓
Install with agentmods
npx agentmods add commands/shouzhengai/cs146s_cn/docs-sync
About the project

CS146S_CN is a Chinese-language, hands-on course about developing software with coding agents, including agent skills, MCP, specification-driven development, testing, deployment, and software-factory practices. It is for programmers learning how to design and use agent-assisted development workflows. The catalogue entries are commands associated with the course.

ShouZhengAI/CS146S_CN · 1,545 stars · on GitHub · themodernsoftware.dev

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.

Clone the repo
git clone --depth 1 https://github.com/ShouZhengAI/CS146S_CN

Made for: Claude Code.

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

README.md
[![agentmods](https://agentmods.dev/badge/commands/shouzhengai/cs146s_cn/docs-sync.svg)](https://agentmods.dev/commands/shouzhengai/cs146s_cn/docs-sync)
Your own site
<a href="https://agentmods.dev/commands/shouzhengai/cs146s_cn/docs-sync"><img src="https://agentmods.dev/badge/commands/shouzhengai/cs146s_cn/docs-sync.svg" alt="Measured on agentmods" height="20"></a>
Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 203 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.00000 $0.00203
Opus 5 $0.00000 $0.00102
Sonnet 5 $0.00000 $0.00041
Haiku 4.5 $0.00000 $0.00020

Measured 7d ago against content hash 5fe279429f44, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

docs-sync 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 7d 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.

assignments/week4/.claude/commands/docs-sync.md · 11 lines

What it actually says

Synchronize API documentation

Synchronize docs/API.md with the FastAPI OpenAPI document. $ARGUMENTS may contain a server base URL; default to http://127.0.0.1:8000.

  1. Read the routers and schemas under backend/app/ and the current docs/API.md.
  2. Fetch $ARGUMENTS/openapi.json (or the default URL). If the server is unavailable, ask the user to run make run; do not invent schema fields.
  3. Compare every OpenAPI path, method, status code, parameter, request body, and response model with the documentation.
  4. Update only docs/API.md, preserving its concise endpoint-table format and adding validation/error behavior.
  5. Fetch OpenAPI once more and report a diff-style summary: added, changed, removed, and remaining drift.

The operation must be idempotent. Never edit generated OpenAPI JSON, application code, or delete hand-written safety notes.

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. 7d ago First seen · 11 lines · 0 tokens per session scan A 5fe279429f44

Subscribe to this mod's changes

docs-sync is a command published in the GitHub repository ShouZhengAI/CS146S_CN (1,545 stars, last pushed 6d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 203 tokens. 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-30.