api-docs
Skill0 starsChanged 3 months agoMITView on GitHub
Use when the user wants endpoint documentation, an API reference, or docs for a public module.
16 other projects use a version of this.
Adopted by
Most recently taken up by
- ainurdev/mystical-assistanttheir own version, first seen Nov 8, 2026
- Zwin-ux/kittheir own version, first seen Oct 11, 2026
- shenjingnan/xiaozhi-clienttheir own version, first seen Oct 8, 2026
- mono/SkiaSharptheir own version, first seen Oct 8, 2026
- JeffreyFerreiras/ai-skillstheir own version, first seen Oct 5, 2026
- neronain/ClaudeSkills-Neronaintheir own version, first seen Aug 9, 2026
Used with
Projects with it also use changelog and frontend-design.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
HashiCorpSkillchangelog
Add a `.changelog/<PR_NUMBER>.txt` entry for a GitHub Pull Request, commit, and push.
Also in 4 projects that use this
BlockSkillfrontend-design
Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, or applications. Generates creative, polished code that avoids generic AI aesthetics.
Also in 3 projects that use this
Other versions16 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 16
- mono/SkiaSharp★ 5.6ksame name
- shenjingnan/xiaozhi-client★ 341same name
- langchain-ai/skills-benchmarks★ 116same name
- ainurdev/mystical-assistant★ 7same name
- marttp/my_agent_skills_I_use★ 4same name
- francogalfre/skills★ 3same name
- neronain/ClaudeSkills-Neronain★ 3same name
- peopleforrester/claude-dotfiles★ 3same name
- Pradnyeshp/Claude-Skills★ 2same name
- AstyanM/claude-am-plugin★ 1same name
6 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository11 other files it gives its agents.
- code-reviewSkill
- commit-messageSkill
- debug-loopSkill
- explain-this-fileSkill
- onboarding-mapSkill
- perf-passSkill
- pr-descriptionSkill
- refactor-safelySkill
- security-passSkill
- sql-reviewSkill
- write-testsSkill
The file
We split this skill into the rules it gives an agent
8 rules. 0 are common, 8 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 15 edited versions we read keep these.
8
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
Document the contract a caller has to satisfy, and what they get back.
- Distinctive: line 14
Document each parameter: name, type, required or optional, default, and constraints.
- Distinctive: line 15
Document the success response with a real example body, not a type name.
- Distinctive: line 16
Document every error the caller can actually receive, with the status code and when it happens.
- Distinctive: line 18
Verify every example against the code.
- Distinctive: line 23
No prose that repeats the field name back to the reader.
- Distinctive: line 24
No invented fields. If you cannot confirm it, leave it out and flag it.
- Distinctive: line 25
Keep examples copy pasteable.
“Common” is measured: kept by at least 6 in 10 of the 15 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
API docs
Document the contract a caller has to satisfy, and what they get back.
Procedure
- Find the real surface in code: route definitions, exported functions, or the schema files.
- For every endpoint or function, record method, path or signature, and one line of purpose.
- Document each parameter: name, type, required or optional, default, and constraints.
- Document the success response with a real example body, not a type name.
- Document every error the caller can actually receive, with the status code and when it happens.
- Note auth requirements, rate limits and pagination once at the top, not repeated per route.
- Verify every example against the code. An example that does not match is worse than no example.
- Mark anything deprecated and say what replaces it.
Rules
- No prose that repeats the field name back to the reader.
- No invented fields. If you cannot confirm it, leave it out and flag it.
- Keep examples copy pasteable.
Output format
Per endpoint:
### POST /v1/things
Creates a thing.
Auth: bearer token
Body:
name string required, 1 to 64 chars
tags array optional, defaults to []
200 -> { "id": "thg_01", "name": "example", "tags": [] }
400 -> name missing or too long
409 -> a thing with that name existsDoes it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.