mcpField
A
aliyun-openapi-discovery

aliyun-openapi-discovery

github.com/cinience开发39656 次安装11 周前更新
代码仓库

关于 aliyun-openapi-discovery

aliyun-openapi-discovery 是用于收集 Alibaba Cloud 产品清单和 OpenAPI 元数据的工作流技能。它合并产品来源、获取 API 文档并生成摘要，以支持技能规划。

主要功能

  1. 01从三个来源收集产品
  2. 02合并产品清单
  3. 03获取 OpenAPI 元数据和文档
  4. 04关联产品与 API 数量
  5. 05按类别汇总产品

适用场景

  1. 01为技能规划构建产品清单
  2. 02按产品和版本查找 API 文档

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/cinience/alicloud-skills --skill aliyun-openapi-discovery

安装后在 Claude Code 中输入/aliyun-openapi-discovery确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

agents/
openai.yaml
references/
openapi-meta.md
product-sources.md
scripts/
analyze_products_vs_skills.py
apis_from_openapi_meta.py
join_products_with_api_meta.py
merge_product_sources.py
products_from_bssopenapi.py
products_from_openapi_meta.py
products_from_support_service.py
products_from_ticket_system.py
summarize_openapi_meta_products.py

详细介绍

阿里云产品与 API 发现

按照此工作流收集产品、解析 API 元数据，并为技能规划生成摘要。

工作流

  1. 从三个来源获取产品列表
  • 工单系统（ListProducts）
  • 支持与服务（ListProductByGroup）
  • BSS OpenAPI（QueryProductList）

运行随附的脚本（位于此技能文件夹中）：

python scripts/products_from_ticket_system.py
python scripts/products_from_support_service.py
python scripts/products_from_bssopenapi.py

在每个脚本中提供所需的环境变量（参见参考资料）。

  1. 合并产品列表
python scripts/merge_product_sources.py

这会写入 output/product-scan/merged_products.json 和 .md。

  1. 获取 OpenAPI 元数据产品列表
python scripts/products_from_openapi_meta.py

这会写入 output/product-scan/openapi-meta/products.json 和 products_normalized.json。

  1. 按产品/版本获取 OpenAPI API 文档
python scripts/apis_from_openapi_meta.py

默认情况下，数据量可能很大。可使用筛选条件进行试运行：

  • OPENAPI_META_MAX_PRODUCTS=10
  • OPENAPI_META_PRODUCTS=Ecs,Ons
  • OPENAPI_META_VERSIONS=2014-05-26
  1. 将产品与 API 数量关联
python scripts/join_products_with_api_meta.py
  1. 按类别/分组汇总产品
python scripts/summarize_openapi_meta_products.py

6)（可选）将产品与现有技能进行比较

python scripts/analyze_products_vs_skills.py

输出规范

所有生成的文件都必须放在 output/ 下。请勿将临时文件放在其他位置。

验证

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

通过标准：命令以 0 退出，且已生成 output/aliyun-openapi-discovery/validate.txt。

输出与证据

  • 将产物、命令输出和 API 响应摘要保存到 output/aliyun-openapi-discovery/ 下。
  • 在证据文件中包含关键参数（地域/资源 ID/时间范围），以便复现。

前置条件

  • 执行前配置遵循最小权限原则的阿里云凭证。
  • 优先使用环境变量：ALIBABACLOUD_ACCESS_KEY_ID、ALIBABACLOUD_ACCESS_KEY_SECRET、可选的 ALIBABACLOUD_REGION_ID。
  • 如果地域不明确，请在运行变更操作前询问用户。

参考资料

  • 产品源 API：参见 references/product-sources.md
  • OpenAPI 元数据端点：参见 references/openapi-meta.md

评论

支持 Markdown