API Contract Review
Use when auditing CloudBase cloud API wrappers, MCP tools, generated action metadata...
Install
npx skills add TencentCloudBase/CloudBase-AI-Toolkit --skill api-contract-review -g -a claude-code -y- Repository
- TencentCloudBase/CloudBase-AI-Toolkit1.2k
- Category
- Testing
- Updated
- 3d ago
- License
- MIT
- Context cost
- Lightabout 1,451 tokens
- Runs scripts
- No, instructions only
What it does
Use when auditing CloudBase cloud API wrappers, MCP tools, generated action metadata, or related docs for outdated or incorrect action names, parameters, casing, request shapes, or missing contract tests, especially during periodic quality review or before preparing corrective PRs.
API Contract Review
Review CloudBase cloud API integrations for contract correctness before the repository ships stale, guessed, or undocumented behavior.
When to use this skill
Use this skill when you need to:
- Review CloudBase cloud API wrappers or MCP tools for outdated or incorrect action or interface names
- Check whether request parameters, casing, nesting, or request shape drifted away from documentation
- Audit whether a CloudBase API change is backed by the right contract tests
- Run a periodic API correctness review before opening corrective PRs
- Separate confirmed contract bugs from vague "maybe this API changed" speculation
Do NOT use for:
- General code smell review without a contract-correctness question
- Regular SDK usage that does not touch CloudBase control-plane or documented API contracts
- Guessing undocumented behavior from naming intuition
- Shipping a fix when the documentation still does not support the proposed action or parameter shape
Workflow
Phase 1, Scope and evidence
- Read
references/review-checklist.mdfirst. - Identify the review surface:
mcp/src/tools/*- related tests
- generated action metadata
- user-facing docs that describe the same API behavior
- Record the exact action, interface, or payload being reviewed before forming conclusions.
Phase 2, Documentation-first verification
Before judging any implementation, you must read the relevant official documentation first.
Required entry points:
- CloudBase API overview:
https://cloud.tencent.com/document/product/876/34809 - Dependency-resource API docs when relevant:
https://cloud.tencent.com/document/product/876/34808 - CloudBase Manager SDK docs before approving direct Cloud API usage:
https://docs.cloudbase.net/api-reference/manager/node/introduction
Verify the documented contract, not your memory:
