skills.rest
TencentCloudBase
TencentCloudBaseOFFICIAL
Explore all skills by this author →
Website𝕏@TencentCloudTCBGitHub

api-contract-review

Validate CloudBase API wrappers and MCP tools against official documentation.

1.1k|133|Updated May 23, 2025
Search Tags:#api#audit#compliance#mcp#contract#cloudbase
One-click install
npx skills add https://github.com/TencentCloudBase/CloudBase-AI-Toolkit --skill api-contract-review-tencentcloudbase
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract-review
Source: https://github.com/TencentCloudBase/CloudBase-AI-Toolkit/tree/main/skills/api-contract-review
Command: npx skills add https://github.com/TencentCloudBase/CloudBase-AI-Toolkit --skill api-contract-review-tencentcloudbase

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill prevents the deployment of stale, guessed, or undocumented CloudBase API integrations by enforcing strict adherence to official documentation and contract testing.

Core Features & Use Cases

  • Contract Verification: Validates action names, parameter shapes, and nesting against official Tencent CloudBase documentation.
  • Automated Audit: Identifies discrepancies between implementation, tests, and public API specs.
  • Use Case: Before shipping a new MCP tool or updating a cloud function wrapper, use this skill to confirm that the request payload matches the current CloudBase API contract, preventing runtime failures.

Quick Start

Use the api-contract-review skill to audit the current MCP tool implementation against the official CloudBase API documentation.

Frequently Asked Questions about api-contract-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate CloudBase API wrappers against official documentation?▼

To validate CloudBase API wrappers against official documentation, audit action names, parameter shapes, and request mappings against documented schemas to ensure contract correctness. This prevents runtime failures from stale or guessed integrations.

When do I need an API contract review for MCP tools?▼

You need an API contract review for MCP tools before shipping new implementations, updating cloud function wrappers, or debugging API integration mismatches. It enforces strict adherence to official CloudBase documentation during periodic quality reviews and PR preparation.

Can I use this to audit CloudBase API parameter shapes before a pull request?▼

Yes, you can use this to audit CloudBase API parameter shapes and nesting before preparing a pull request. The automated audit identifies discrepancies between your implementation, tests, and public API specs to ensure contract correctness.

What is the best way to debug CloudBase API integration mismatches?▼

The best way to debug CloudBase API integration mismatches is verifying request payloads against the current CloudBase API contract. This validates action names and parameter shapes, preventing the deployment of undocumented or stale API integrations.

Why does my MCP tool deployment fail with stale CloudBase API integrations?▼

Your MCP tool deployment fails with stale CloudBase API integrations because the request payload does not match the current documented API contract. Strict adherence to official documentation and contract testing prevents these runtime failures.

Does api-contract-review work without external dependencies?▼

Yes, api-contract-review works without external dependencies. It relies on internal references to validate CloudBase cloud API wrappers and MCP tools against official documentation, ensuring action names and parameter shapes are contract-correct.

Related Skills

Explore More Software Engineering Skills→
Ab0umarAb0umar

chatgpt-app-submission

Inspect MCP server codebases and generate chatgpt-app-submission.json with validation findings.

Community
Advanced
Verridian-aiVerridian-ai
1

Cloud Run Manager

Deploy and manage Google Cloud Run services using MCP tools.

Community
Intermediate
xongtaoxongtao

http-api-cloudbase

Access CloudBase platform features via raw HTTP API calls.

Community
Intermediate
qa-amanqa-aman
19

api-design

Define and validate REST and GraphQL API contracts with schemas and versioning.

Community
Intermediate