Api Design Reviewer
Helps with API, design as part of developing backend services and APIs workflows.
Install on your platform
We auto-selected Claude Code based on this skill’s supported platforms.
Run in terminal (recommended)
claude mcp add api-design-reviewer npx -- -y @trustedskills/api-design-reviewer
Or manually add to ~/.claude/settings.json
{
"mcpServers": {
"api-design-reviewer": {
"command": "npx",
"args": [
"-y",
"@trustedskills/api-design-reviewer"
]
}
}
}Requires Claude Code (claude CLI). Run claude --version to verify your install.
About This Skill
What it does
This skill reviews API designs, identifying potential issues related to security, usability, and maintainability. It provides feedback on aspects like endpoint naming conventions, request/response formats (JSON Schema), and error handling strategies. The goal is to improve the quality and robustness of API specifications before implementation.
When to use it
- Early-stage API development: Get feedback on your initial design concepts before writing any code.
- API refactoring: Evaluate existing APIs for potential improvements in security or efficiency.
- Onboarding new developers: Ensure consistent API design standards across a team.
- Preparing for public release: Validate that your API is ready for external consumption and meets industry best practices.
Key capabilities
- Reviews API designs based on established principles.
- Identifies potential security vulnerabilities in API specifications.
- Evaluates usability aspects of API design.
- Provides feedback on maintainability considerations.
Example prompts
- "Review this OpenAPI specification for a user authentication API."
- "Can you analyze this API design and suggest improvements to its error handling?"
- “Assess the security implications of this REST endpoint design.”
Tips & gotchas
The skill requires an OpenAPI (Swagger) or similar API definition file as input. The quality of the review depends on the completeness and accuracy of the provided specification.
Tags
TrustedSkills Verification
Unlike other registries that point to live repositories, TrustedSkills pins every skill to a verified commit hash. This protects you from malicious updates — what you install today is exactly what was reviewed and verified.
Security Audits
| Gen Agent Trust Hub | Pass |
| Socket | Pass |
| Snyk | Pass |
🌐 Community
Passed automated security scans.