api-contract-writer
Skill1 starsChanged 8 months agoMITView on GitHub
1 other project uses a version of this.
Adopted by
Most recently taken up by
- Igorsolop0/qa-claude-skillstheir own version, first seen Oct 8, 2026
Other versions1 project uses a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 1
- Igorsolop0/qa-claude-skills★ 3same name
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 repository27 other files it gives its agents.
- api-contract-writerSkill
- api-error-model-designerSkill
- crud-surface-reviewerSkill
- dao-pattern-builderSkill
- data-migration-plannerSkill
- entity-model-designerSkill
- index-suggestion-writerSkill
- jdbc-vs-jpa-selectorSkill
- orm-mapping-reviewerSkill
- persistence-test-plannerSkill
- query-complexity-reviewerSkill
- repository-layer-designerSkill
- schema-normalizerSkill
- transaction-boundary-checkerSkill
- api-error-model-designerSkill
- crud-surface-reviewerSkill
- dao-pattern-builderSkill
- data-migration-plannerSkill
- entity-model-designerSkill
- index-suggestion-writerSkill
- jdbc-vs-jpa-selectorSkill
- orm-mapping-reviewerSkill
- persistence-test-plannerSkill
- query-complexity-reviewerSkill
- repository-layer-designerSkill
- schema-normalizerSkill
- transaction-boundary-checkerSkill
The file
We split this skill into the rules it gives an agent
8 rules. About 0 are common, 8 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈8
Distinctive · estimate
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 12
Write backend API contracts covering endpoints or operations, payloads, validation, errors, idempotency, and state transitions.
- Distinctive: line 34
Prefer concrete operational behavior over abstract framework enthusiasm.
- Distinctive: line 47
Prefer explicit tradeoffs over single-answer absolutism.
- Distinctive: line 48
Use severity or priority where useful.
- Distinctive: line 51
Do not blur domain logic, persistence logic, and transport concerns.
- Distinctive: line 52
Do not describe happy-path behavior only.
- Distinctive: line 53
Do not hide uncertainty behind ORM or framework jargon.
- Distinctive: line 54
Do not recommend migrations or transactions without discussing rollback and compatibility.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
api-contract-writer
Purpose
Write backend API contracts covering endpoints or operations, payloads, validation, errors, idempotency, and state transitions.
Expected inputs
- current backend or persistence context
- data model or schema details
- constraints or stack context
- known risks or unresolved decisions
Deliverables
- structured recommendation
- design notes
- risks or gaps
- recommended next artifact
Trigger this skill when
- You are designing or reviewing backend behavior, persistence, or API structure rather than only UI flow.
- Data modeling, transactions, migration, or access-layer choices materially affect correctness or maintainability.
- A team needs sharper boundaries between domain logic, persistence logic, and API contracts.
Operating procedure
- Clarify the domain, data lifecycle, and current or intended persistence approach.
- Separate facts, assumptions, constraints, and unresolved backend-specific risks.
- Prefer concrete operational behavior over abstract framework enthusiasm.
- Explicitly handle invalid, missing, conflict, and rollback cases where relevant.
- Recommend the next most useful backend, persistence, or testing skill.
Quality gates
- The recommendation respects real data lifecycle and consistency needs.
- Failure and conflict cases are not ignored.
- Assumptions and unresolved decisions are visible.
- Output is specific enough to influence implementation, schema, or testing.
Output style
- Be concrete and structured.
- Separate findings, assumptions, and recommendations.
- Prefer explicit tradeoffs over single-answer absolutism.
- Use severity or priority where useful.
Failure modes to avoid
- Do not blur domain logic, persistence logic, and transport concerns.
- Do not describe happy-path behavior only.
- Do not hide uncertainty behind ORM or framework jargon.
- Do not recommend migrations or transactions without discussing rollback and compatibility.
Minimum output skeleton
## Summary
## Findings or proposal
## Evidence vs assumptions
## Risks or tradeoffs
## Recommended next skillHandoff targets
- api-error-model-designer
- crud-surface-reviewer
- persistence-test-planner
Does 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.