Credited skills

Skill 26 of 31

API Review

Reviews the specified code against the canonical API Design guidelines.

1 minute · 228 words · 2 sections

API review skill

This skill reviews code against the canonical API Design guidelines.

Instructions

Load Guidelines: Read the API design guidelines from references/canonical_api_design.md (opens in a new tab) to ensure they are fully available in the context.
Identify Target: Identify the code to review.
- If the user specified files (e.g., “review main.dart”), use those.
- If the user has an open file in their context, assume that is the target.
- If neither, ask the user to specify the target files.
Analyze: For each target file, perform a deep analysis against the “Foundations of Canonical API Design Principles” (loaded in step 1), specifically looking for:
- Contract-First: Is the interface clear and decoupled from implementation?
- KISS/YAGNI: Are there unnecessary parameters or over-generalized features?
- Ergonomics: Are names intent-revealing? Do they follow the Principle of Least Astonishment?
- CQS: Are commands and queries separated?
- Safety: Are types used strictly (Enums vs Strings)? Is validation visible?
- Explicit Configuration: Are dependencies explicitly injected rather than implicitly resolved via global state, registries, or environment variables?
Report: Generate a structured report:
- Score: Give a letter grade (A-F) based on alignment.
- Critical Issues: Violations that must be fixed (e.g., severe strictness or safety issues).
- Suggestions: Ergonomic improvements (renaming, rearranging).
- Code Examples: Provide before vs after code blocks for the suggested improvements.
- Save the report as a markdown artifact in the conversation artifacts directory (e.g., <appDataDir>/brain/<conversation-id>/api_review_results.md).

Credited

This skill is installed in flutter/agent-plugins — in use here rather than published from here — so there is no install command for it on this page.

About this skill

Trigger

Reviews the specified code against the canonical API Design guidelines. Use this skill when the user asks for an API review or to check code against API design principles.

The verbatim description from this skill’s front matter — the string an agent matches on to decide whether to load it.

Colophon for this issue

Colophon

How this issue was made

Source

github.com/flutter/agent-plugins, branch main, last pushed 17 September 2026.

Licence

BSD-3-Clause — the text of every skill is reproduced unmodified, frontmatter included, under the upstream licence.

Discovery

31 skills found by walking the repository tree for SKILL.md, not by matching a directory convention. 2 distinct layouts observed: .agents/agents/reidbaker-agent/skills/*/SKILL.md, skills/*/SKILL.md.

Authorship

6 of 31 skills are installed into the repository rather than published from it. They are shelved in the closing “Credited skills” part and remain the work of their own authors. A skill counts as credited when its only copy lives under one agent’s dot directory; visible directories, per-agent mirror sets, and skills installable from this repository on skills.sh all count as published.

Issue colours

Resolved from a curated brand profile — hue 257°, chroma 0.190. Two accent tones are generated per issue and each is proven against its own ground before it ships: a single accent that passes AA on both light and dark paper is arithmetically impossible.

Heading repairs

1 repair applied to this skill so the document has one h1 and no skipped levels:

Shifted “2 headings” from h1 to h2 so the skill title is the only h1.

Spec compliance

Every skill satisfies the Agent Skills specification’s frontmatter rules.

Images

Images inside a skill come from the upstream repository. Where the author gave no alternative text we mark the image decorative rather than inventing a description — a plausible caption we made up is worse than none for the reader who depends on it.

Marketplace

A plugin manifest is published at .claude-plugin/marketplace.json by Dart and Flutter Team, declaring 1 plugin. It is read for editorial metadata only — never as the skill index, which is always the repository tree.

Signal

This repository is unranked on skills.sh, which says nothing about it: the leaderboard covers a fraction of published skills.

Agent surfaces

The whole issue is available as one markdown document at /flutter/agent-plugins.md, and each skill at its own .md URL.

Publication

Set by Skills Docs from the source repository. Body text is Literata at the reader’s chosen size and measure; code is Geist Mono. Nothing on this page was written by us except this paragraph.

API review skill

This skill reviews code against the canonical API Design guidelines.

Load Guidelines: Read the API design guidelines from references/canonical_api_design.md to ensure they are fully available in the context.

Identify Target: Identify the code to review.

If the user specified files (e.g., “review main.dart”), use those.
If the user has an open file in their context, assume that is the target.
If neither, ask the user to specify the target files.

Analyze: For each target file, perform a deep analysis against the “Foundations of Canonical API Design Principles” (loaded in step 1), specifically looking for:

Contract-First: Is the interface clear and decoupled from implementation?
KISS/YAGNI: Are there unnecessary parameters or over-generalized features?
Ergonomics: Are names intent-revealing? Do they follow the Principle of Least Astonishment?
CQS: Are commands and queries separated?
Safety: Are types used strictly (Enums vs Strings)? Is validation visible?
Explicit Configuration: Are dependencies explicitly injected rather than implicitly resolved via global state, registries, or environment variables?

Report: Generate a structured report:

Score: Give a letter grade (A-F) based on alignment.
Critical Issues: Violations that must be fixed (e.g., severe strictness or safety issues).
Suggestions: Ergonomic improvements (renaming, rearranging).
Code Examples: Provide before vs after code blocks for the suggested improvements.
Save the report as a markdown artifact in the conversation artifacts directory (e.g., <appDataDir>/brain/<conversation-id>/api_review_results.md).

API Review

API review skill

Instructions

About this skill

Trigger

Colophon

API Review

API review skill

Instructions

Appendix 26.1

ReferencesMarkdown · 1 file

About this skill

Trigger

Colophon

Appendix 26.1

ReferencesMarkdown · 1 file