agentleFS
MicrosoftKnown publishermicrosoft/frontier-ghcp-ttt-rvas/sessions/session-m3-05-agent-skills-ecosystem/lab/solution/skills-project/.github/skills/api-design/SKILL.md

api-design

Skill3 starsChanged 54 days agoMITView on GitHub

Use for creating or reviewing REST routes under src/api/ when acceptance criteria, a reviewer, and a verified focused test command are available. Do not use for documentation, UI, deployment, or generated clients.

We split this skill into the rules it gives an agent

7 rules. 0 are common, 6 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 164 edited versions we read keep these.

  • 6

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If any precondition is missing, stop and report the missing item.

    line 15
  2. Distinctive:

    Read the target route and adjacent tests.

    line 20
  3. Distinctive:

    Run the checked focused test command.

    line 25
  4. Very specific:

    Stop when the task is outside src/api/.

    line 37
  5. Distinctive:

    Stop when acceptance criteria, a reviewer, or the test command is missing.

    line 38
  6. Distinctive:

    Do not add a dependency, call a network service, or change deployment files.

    line 39
  7. Distinctive:

    Do not replace a failed command with a manual success claim.

    line 40

“Common” is measured: kept by at least 6 in 10 of the 164 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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

API design

Preconditions

  • The task names one REST route under src/api/.
  • Acceptance criteria define success and failure behavior.
  • A human reviewer is assigned.
  • The repository has a focused test command that has been checked.

If any precondition is missing, stop and report the missing item. Do not infer a repository convention or claim that validation ran.

Procedure

  1. Read the target route and adjacent tests.
  2. Map each acceptance criterion to a result that shows success or failure.
  3. Preserve the repository's current response and error shapes.
  4. Validate input at the route boundary.
  5. Make the smallest route and focused-test change.
  6. Run the checked focused test command.
  7. Report changed files, test output, and unresolved gaps.
  8. Request human review.

Validation

The run is complete only when the focused test command passes and the reviewer can trace every assertion to an acceptance criterion. If the command fails, show the failure and do not report success.

Failure behavior

  • Stop when the task is outside src/api/.
  • Stop when acceptance criteria, a reviewer, or the test command is missing.
  • Do not add a dependency, call a network service, or change deployment files.
  • Do not replace a failed command with a manual success claim.

Maintenance

Owner: training-maintainers

Review this skill when route conventions, test commands, or supported skill frontmatter change. Use the same procedure as a manual checklist when a client approved for use cannot load the skill.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.