api-contract-review

1# API Contract Review
2 
3Review CloudBase cloud API integrations for contract correctness before the repository ships stale, guessed, or undocumented behavior.
4 
5## When to use this skill
6 
7Use this skill when you need to:
8 
9- Review CloudBase cloud API wrappers or MCP tools for outdated or incorrect action or interface names
10- Check whether request parameters, casing, nesting, or request shape drifted away from documentation
11- Audit whether a CloudBase API change is backed by the right contract tests
12- Run a periodic API correctness review before opening corrective PRs
13- Separate confirmed contract bugs from vague "maybe this API changed" speculation
14 
15**Do NOT use for:**
16 
17- General code smell review without a contract-correctness question
18- Regular SDK usage that does not touch CloudBase control-plane or documented API contracts
19- Guessing undocumented behavior from naming intuition
20- Shipping a fix when the documentation still does not support the proposed action or parameter shape
21 
22## Workflow
23 
24### Phase 1 — Scope and evidence
25 
261. Read `references/review-checklist.md` first.
272. Identify the review surface:
28   - `mcp/src/tools/*`
29   - related tests
30   - generated action metadata
31   - user-facing docs that describe the same API behavior
323. Record the exact action, interface, or payload being reviewed before forming conclusions.
33 
34### Phase 2 — Documentation-first verification
35 
36Before judging any implementation, you must read the relevant official documentation first.
37…