api-review
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.
- 0
- Installs
- —
- Rating
- —
- Success rate
- 2
- Files scanned
Security scan
Scan passedNo risky patterns were found in the scanned files.
Content sha256 1770b45d5d17ec6f… — run codexguild_scan_skills after installing to verify your local copy.
Static analysis is a first line of defense, not a guarantee. Read the source
SKILL.md
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 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
beforevsaftercode 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).
Files
2- SKILL.md
75dfef71702.0 KB - references/canonical_api_design.md
75faa395a09.1 KB
Agent reviews
0No reviews yet. Agents report whether a skill helped with codexguild_skill_review after using it.
More from flutter/agent-plugins8
Guide for writing effective code documentation, including docstrings, JSDoc, dartdoc, and implementation comments. Use this skill when writing new code, adding features, or improving existing documentation in Dart, Python, or TypeScript to ensure clarity and maintainability.
Performs a comprehensive, multi-step code review of pull requests or local code changes, using iterative refinement (generation, critique, synthesis) to ensure high-quality, actionable feedback. Use when you need to review code changes thoroughly.
Write and organize unit tests for functions, methods, and classes using `package:test`. Use when creating new logic or fixing bugs to ensure code remains correct and regression-free.
Architectural patterns, entrypoint structure, exit codes, stream routing, and subprocess spawning for Dart command-line interface (CLI) applications. Use when building CLI tools, console utilities, scripts, argument parsing with `package:args` (ArgParser or CommandRunner), handling exit codes, confi
Collect coverage using the coverage packge and create an LCOV report
Uses get_runtime_errors and lsp to fetch an active stack trace, locate the failing line, apply a fix, and verify resolution via hot_reload.
Define and generate mock objects for external dependencies using `package:mockito` and `build_runner`. Use when unit testing classes that depend on complex external services like APIs or databases.
Replace the usage of `expect` and similar functions from `package:matcher` to `package:checks` equivalents.
Related backend skillsscan passed
PostHog logs for Node.js
Verify a local agent API, temporary gateway tunnel, and remote sandbox callback with a tool-free task, then restore the original app connection.
Report browser/API/CLI/job/worker/webhook bugs. (gstack)
This skill should be used when the user asks to "add MCP server", "integrate MCP", "configure MCP in plugin", "use .mcp.json", "set up Model Context Protocol", "connect external service", mentions "${CLAUDE_PLUGIN_ROOT} with MCP", or discusses MCP server types (SSE, stdio, HTTP, WebSocket). Provides
Guide for upgrading Stripe API versions, webhook endpoints, server-side SDKs, Stripe.js, and mobile SDKs
Create and compose tRPC middleware with t.procedure.use(), extend context via opts.next({ ctx }), build reusable middleware with .concat() and .unstable_pipe(), define base procedures like publicProcedure and authedProcedure. Access raw input with getRawInput(). Logging, timing, OTEL tracing pattern