Now liveThe Skillselion MCP - thousands of ranked skills, loaded into your agent mid-task. No install.Get it →
cinience avatar

Alicloud Platform Docs Api Review Test

  • 158 installs
  • 396 repo stars
  • Updated July 18, 2026
  • cinience/alicloud-skills

Review Alibaba Cloud API reference docs for accuracy, completeness, and agent-friendly examples before publishing SDK guides or customer-facing integration documentation.

About

Helps agents systematically review Alibaba Cloud platform API documentation for endpoint accuracy, request and response schemas, error codes, and workable examples so integration docs are trustworthy before developers and coding agents consume them.

  • API reference accuracy checks
  • Parameter and response validation
  • Example code completeness review
  • Consistency across service docs
  • Pre-publish documentation quality gate

Alicloud Platform Docs Api Review Test by the numbers

  • 158 all-time installs (skills.sh)
  • Ranked #558 of 1,879 Documentation skills by installs in the Skillselion catalog
  • Data as of Aug 5, 2026 (Skillselion catalog sync)
npx skills add https://github.com/cinience/alicloud-skills --skill alicloud-platform-docs-api-review-test

Add your badge

Show developers this skill is listed on Skillselion. Paste this into your README.

Listed on Skillselion
Installs158
repo stars396
Last updatedJuly 18, 2026
Repositorycinience/alicloud-skills

What it does

Review Alibaba Cloud API reference docs for accuracy, completeness, and agent-friendly examples before publishing SDK guides or customer-facing integration documentation.

Files

SKILL.mdMarkdownGitHub ↗

Category: service

Cloud Backup

Use Alibaba Cloud OpenAPI (RPC) with official SDKs or OpenAPI Explorer to manage resources for Cloud Backup.

Workflow

1) Confirm region, resource identifiers, and desired action. 2) Discover API list and required parameters (see references). 3) Call API with SDK or OpenAPI Explorer. 4) Verify results with describe/list APIs.

AccessKey priority (must follow)

1) Environment variables: ALIBABACLOUD_ACCESS_KEY_ID / ALIBABACLOUD_ACCESS_KEY_SECRET / ALIBABACLOUD_REGION_ID Region policy: ALIBABACLOUD_REGION_ID is an optional default. If unset, decide the most reasonable region for the task; if unclear, ask the user. 2) Shared config file: ~/.alibabacloud/credentials

API discovery

  • Product code: hbr
  • Default API version: 2017-09-08
  • Use OpenAPI metadata endpoints to list APIs and get schemas (see references).

High-frequency operation patterns

1) Inventory/list: prefer List* / Describe* APIs to get current resources. 2) Change/configure: prefer Create* / Update* / Modify* / Set* APIs for mutations. 3) Status/troubleshoot: prefer Get* / Query* / Describe*Status APIs for diagnosis.

Minimal executable quickstart

Use metadata-first discovery before calling business APIs:

python scripts/list_openapi_meta_apis.py

Optional overrides:

python scripts/list_openapi_meta_apis.py --product-code <ProductCode> --version <Version>

The script writes API inventory artifacts under the skill output directory.

Output policy

If you need to save responses or generated artifacts, write them under: output/aliyun-hbr-backup/

Validation

mkdir -p output/aliyun-hbr-backup
for f in skills/backup/aliyun-hbr-backup/scripts/*.py; do
  python3 -m py_compile "$f"
done
echo "py_compile_ok" > output/aliyun-hbr-backup/validate.txt

Pass criteria: command exits 0 and output/aliyun-hbr-backup/validate.txt is generated.

Output And Evidence

  • Save artifacts, command outputs, and API response summaries under output/aliyun-hbr-backup/.
  • Include key parameters (region/resource id/time range) in evidence files for reproducibility.

Prerequisites

  • Configure least-privilege Alibaba Cloud credentials before execution.
  • Prefer environment variables: ALIBABACLOUD_ACCESS_KEY_ID, ALIBABACLOUD_ACCESS_KEY_SECRET, optional ALIBABACLOUD_REGION_ID.
  • If region is unclear, ask the user before running mutating operations.

References

  • Sources: references/sources.md

Related skills

Documentationdocsbackend

This week in AI coding

Five minutes, every Monday - the tools, releases and tactics for developers.

unsubscribe anytime.