mcpField
A
alicloud-platform-docs-api-review

alicloud-platform-docs-api-review

github.com/cinienceTesting & quality396266 installsUpdated 11w ago
Repository

About alicloud-platform-docs-api-review

A skill that reviews Alibaba Cloud product and API documentation for a named product. It gathers current documentation and API information, then produces a scored report with evidence and prioritized recommendations.

Key features

  1. 01Resolve product from OpenAPI metadata
  2. 02Fetch current API documentation
  3. 03Find official product help links
  4. 04Generate scored review report
  5. 05Prioritize recommendations by severity

Use cases

  1. 01Review a product's documentation quality
  2. 02Assess API documentation coverage
  3. 03Prepare prioritized documentation fixes

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/cinience/alicloud-skills --skill alicloud-platform-docs-api-review

After installing, type/alicloud-platform-docs-api-reviewin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

agents/
openai.yaml
references/
review-rubric.md
scripts/
review_product_docs_and_api.py

Details

From the project README

Alibaba Cloud Product Docs + API Docs Reviewer

Use this skill when the user gives a product name and asks for an end-to-end documentation/API quality review.

What this skill does

  1. Resolve product from latest OpenAPI metadata.
  2. Fetch latest API docs for default version.
  3. Discover product/help-doc links from official product page.
  4. Produce a structured review report with:
  • score
  • evidence
  • prioritized suggestions (P0/P1/P2)

Workflow

Run the bundled script:

python skills/platform/docs/alicloud-platform-docs-api-review/scripts/review_product_docs_and_api.py --product "<product name or product code>"

Example:

python skills/platform/docs/alicloud-platform-docs-api-review/scripts/review_product_docs_and_api.py --product "ECS"

Output policy

All generated artifacts must be written under:

output/alicloud-platform-docs-api-review/

For each run, the script creates:

  • review_evidence.json
  • review_report.md

Reporting guidance

When answering the user:

  1. State resolved product + version first.
  2. Summarize the score and the top 3 issues.
  3. List P0/P1/P2 recommendations with concrete actions.
  4. Provide source links used in the report.

Validation

mkdir -p output/alicloud-platform-docs-api-review
for f in skills/platform/docs/alicloud-platform-docs-api-review/scripts/*.py; do
  python3 -m py_compile "$f"
done
echo "py_compile_ok" > output/alicloud-platform-docs-api-review/validate.txt

Pass criteria: command exits 0 and output/alicloud-platform-docs-api-review/validate.txt is generated.

Output And Evidence

  • Save artifacts, command outputs, and API response summaries under output/alicloud-platform-docs-api-review/.
  • 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: ALICLOUD_ACCESS_KEY_ID, ALICLOUD_ACCESS_KEY_SECRET, optional ALICLOUD_REGION_ID.
  • If region is unclear, ask the user before running mutating operations.

References

  • Review rubric: references/review-rubric.md

Comments

Markdown supported