# API Contract Review

Use when auditing CloudBase cloud API wrappers, MCP tools, generated action metadata...

- Repository: https://github.com/TencentCloudBase/CloudBase-AI-Toolkit (1153 stars)
- Category: Testing
- License: MIT
- Last updated: 2026-11-01
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add TencentCloudBase/CloudBase-AI-Toolkit --skill api-contract-review -g -a claude-code -y`
Codex: `npx skills add TencentCloudBase/CloudBase-AI-Toolkit --skill api-contract-review -g -a codex -y`
Cursor: `npx skills add TencentCloudBase/CloudBase-AI-Toolkit --skill api-contract-review -g -a cursor -y`
Gemini CLI: `npx skills add TencentCloudBase/CloudBase-AI-Toolkit --skill api-contract-review -g -a gemini-cli -y`
Claude Code plugin marketplace: `/plugin marketplace add TencentCloudBase/CloudBase-AI-Toolkit`

## Description

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.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# 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

1. Read `references/review-checklist.md` first.
2. Identify the review surface:
   - `mcp/src/tools/*`
   - related tests
   - generated action metadata
   - user-facing docs that describe the same API behavior
3. 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:

The rest: https://github.com/TencentCloudBase/CloudBase-AI-Toolkit/blob/HEAD/skills/api-contract-review/SKILL.md
