Stats
Actions
Tags
Help us improve
Share bugs, ideas, or general feedback.
From pensive
Evaluates public API surface design, consistency in naming/parameters/returns/errors, documentation completeness, and alignment with language exemplars like pandas/requests/tokio. Use before releases.
npx claudepluginhub athola/claude-night-market --plugin pensiveHow this skill is triggered — by the user, by Claude, or both
Slash command
/pensive:api-reviewThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
1. [Usage](#usage)
Reviews public interfaces for API design quality including naming, method signatures, parameters, type safety, and REST endpoints. Use when evaluating usability and readability of class APIs or endpoints.
Reviews API designs for best practices, consistency, and issues in REST, GraphQL, gRPC, OpenAPI specs, or code files.
Reviews documentation completeness, accuracy, and audience-appropriateness against inferred project norms. Evaluates APIs, READMEs, inline comments, and consistency.
Share bugs, ideas, or general feedback.
Use this skill to review public API changes, design new surfaces, audit consistency, and validate documentation completeness. Run it before any API release to confirm alignment with project guidelines.
api-review:surface-inventoryapi-review:exemplar-researchapi-review:consistency-auditapi-review:docs-governanceapi-review:evidence-logCatalog all public APIs by language. Record stability levels, feature flags, and versioning metadata. Use tools like rg to find public symbols (e.g., pub in Rust or non-underscored def in Python). Confirm the working tree state with git status before starting.
Identify at least two high-quality API references for the relevant language, such as pandas, requests, or tokio. Document their patterns for namespacing, pagination, error handling, and structure to serve as a baseline for the audit.
Compare the project's API against the identified exemplar patterns. Analyze naming conventions, parameter ordering, return types, and error semantics. Identify duplication, leaky abstractions, missing feature gates, and documentation gaps.
Validate that documentation includes entry points, quickstarts, and a complete API reference. Verify that changelogs and migration notes are maintained. Check for SemVer compliance, stability promises, and clear deprecation timelines. Confirm that documentation is generated automatically using tools like rustdoc, Sphinx, or OpenAPI.
Record all executed commands and findings. Summarize the final recommendation as Approve, Approve with actions, or Block. Include specific action items with assigned owners and due dates.
Confirm consistent conventions and descriptive names that follow language-specific idioms.
Verify consistent ordering and ensure optional parameters have explicit defaults. Check that type annotations are complete.
Analyze return patterns for consistency. Confirm that error cases are documented and that pagination follows a uniform structure.
Verify that all public APIs include usage examples and that the changelog reflects current changes.
The final report must include a summary of the API surface, a numerical inventory of endpoints and public types, and an alignment analysis against researched exemplars. Document consistency issues and documentation gaps with precise file and line references. Conclude with a clear decision and a timed action plan.
Use imbue:proof-of-work for reproducible command capture and imbue:structured-output for formatting findings. Reference imbue:diff-analysis/modules/risk-assessment-framework when assessing breaking changes.
modules/surface-inventory.md for API cataloging patternsmodules/exemplar-research.md for researching API standardsmodules/consistency-audit.md for cross-API consistency checksIf the audit command is missing, verify that dependencies are installed and accessible in the system PATH. Check file permissions if access errors occur. Use the --verbose flag to inspect execution logs if the tool behaves unexpectedly.