Agent skill

Arkcli API Explorer

by volcengine in volcengine/ark-cli

Inspect or invoke locally registered ArkCLI actions when product commands cannot cover a task.

Apache-2.0Auto-check passedBackend & APIs

Install Arkcli API Explorer

skills CLI
$ npx skills add volcengine/ark-cli --skill arkcli-api-explorer -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install volcengine/ark-cli arkcli-api-explorer --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/volcengine/ark-cli.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/arkcli-api-explorer .claude/skills/arkcli-api-explorer && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
arkcli-api-explorer
GitHub stars
140
Token cost
~1.3k tokens
SKILL.md length
375 words
Files
3 (incl. references)
Skills in repo
25
Repo updated
First seen
Licence
Apache-2.0

At a glance

Inspect or invoke locally registered ArkCLI actions when product commands cannot cover a task.

  • Works in 7 steps: 先判断用户目标是否已有产品入口:arkcli --help,并优先转对应业务… → 如果只是认证/配置问题,不要误判为需要 api → 枚举已注册 Action(无参等价于 list) → …
  • Registry errors
  • SKILL.md covers 使用原则, 适用场景, 唤起信号(When To Trigger) and 反唤起信号(When NOT To Trigger), plus 6 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Arkcli API Explorer is an agent skill from volcengine/ark-cli. Inspect or invoke locally registered ArkCLI actions when product commands cannot cover a task. Use for registry errors or exact raw payloads. Not for public API catalogs or OpenAPI schemas.

Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. The skill folder holds 3 other files, including reference files (for example `references/arkcli-api.md` and `references/evals.md`).

It sits in Backend & APIs, covering OpenAPI specifications. It works with OpenAPI. The repository describes itself as: The fastest way to put Volcengine Ark in your terminal and your AI agent — go from prompt to generated media, multimodal answer, or deployed endpoint in a single command, no API… The licence is Apache-2.0.

When your agent uses it

  • Registry errors
  • Exact raw payloads

Example prompts

  • “/arkcli-api-explorer”

Workflow steps

7 steps, taken from the first numbered list in SKILL.md.

  1. 先判断用户目标是否已有产品入口:arkcli --help,并优先转对应业务 skill
  2. 如果只是认证/配置问题,不要误判为需要 api
  3. 枚举已注册 Action(无参等价于 list)
  4. 定位契约与必填字段(禁止猜 JSON)
  5. 先用叶子命令的 Client Preview 核对最终 descriptor 和 payload
  6. 只读优先;写操作在 Preview 后仍必须二次确认,然后去掉 --dry-run 执行
  7. 输出尽量稳定、减少噪声

What it can do on your machine

Read from SKILL.md and the folder at commit fb5b7be. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are bash).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Arkcli API Explorer loads about 1.3k tokens when it runs, and up to ~3.8k if it reads all its reference files. Until then it costs about 52 tokens; SKILL.md has 375 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~52
When it runs · the whole SKILL.md, loaded when a task matches
~1.3k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~3.8k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from volcengine/ark-cli at commit fb5b7be, republished under its Apache-2.0 licence (© volcengine). 375 words, ~1,286 tokens.

Download SKILL.mdSave it as .claude/skills/arkcli-api-explorer/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.
name
arkcli-api-explorer
description
Inspect or invoke locally registered ArkCLI actions when product commands cannot cover a task. Use for registry errors or exact raw payloads. Not for public API catalogs or OpenAPI schemas.
version
1.1.1
metadata.cliHelp
arkcli api --help

arkcli api(Raw API Explorer)

CRITICAL — 开始前 MUST 先用 Read 工具读取 ../arkcli-shared/SKILL.md,其中包含认证、配置覆盖排查与命令选择顺序 CRITICAL — 只有在现有产品命令和业务 skill 确实不覆盖时,才允许进入本 skill;禁止把 arkcli api 当默认入口。 CRITICAL — 任何 arkcli api ... 调用前,MUST 先用 Read 工具读取 references/arkcli-api.md,禁止盲目猜参数与输出结构。

使用原则

  • unknown action 先查本地 api --list,使用完整注册名,不凭近似业务名猜 Action;MissingParameter 按当前契约里的字段名与大小写补齐,不轮流试 Id/ID/KeyID。

  • 查询 API Key 时,先读 Auth 的 API Key 查询与交付:list 只定位元数据,授权导出才用真实 Id 调 apikey.get_raw,不默认回显明文或轮换。

  • 安装态未必有仓库源码:优先读同版本 Skill/reference 与已注册目录;能访问源码时再查 req/resp JSON tag。没有确定的契约来源就说明缺口并停止,不能虚构本地 internal/apis 文件已被检查。

  • 先产品命令:arkcli <domain> <verb> 或 arkcli +<shortcut>

  • 再 skill / reference:确认是否已有稳定入口与正确参数

  • 最后才 arkcli api:仅用于低频、专业或高风险的底层 Action 验证与兜底

不要因为某个 Action 存在,就反推出新的顶层 skill 或 cmd/ 命令;只有升级为稳定产品能力时,才考虑补 shortcuts/。

适用场景

  • 现有产品命令确实无法覆盖需求(且该需求不值得做成标准命令或 +shortcut)
  • 需要验证某个已注册 Action 的输入输出契约(例如排障、回归验证、确认 transport 可达)
  • 需要确认 registry 中是否已存在某个 Action(用于开发或排查 “注册缺失”)

唤起信号(When To Trigger)

  • 用户明确提到:action / operation / registry / “已注册 Action” / “契约验证”
  • 用户给出:arkcli api ... --params ... 并需要你补全/排错
  • 用户遇到:unknown action / 需要确认某个 Action 是否存在
  • 开发场景:在 internal/apis/<domain>/ 新增 operation 后,要快速验证能否 --list 与可调用

反唤起信号(When NOT To Trigger)

  • 用户要公开 API 契约目录、接口标识、OpenAPI schema 或必填请求字段:转 arkcli-docs 的 docs apis list/spec。api --list 只列二进制本地注册的 Action,不是公开 API 目录,也不提供完整 OpenAPI schema。
  • 用户目标是:对话(+chat)、生成(+gen)、部署(+deploy)、用量(usage)、查模型(models)等已有稳定产品路径
  • 用户只是鉴权失败/未登录/环境 profile 混乱(应先走 auth/config,不要把问题导向 api)
  • 用户只是想“找一个命令怎么用”(优先 arkcli <domain> --help + 对应 skill/reference)

Agent 快速执行顺序

  1. 先判断用户目标是否已有产品入口:arkcli <domain> --help,并优先转对应业务 skill
  2. 如果只是认证/配置问题,不要误判为需要 api:
  3. 枚举已注册 Action(无参等价于 list):
    • arkcli api --list
    • arkcli api
  4. 定位契约与必填字段(禁止猜 JSON):
    • 查同版本 reference/官方契约;仓库可用时再查 internal/apis/<domain>/ 对应 req/resp 结构体,安装态没有源码时不得声称已检查
    • 同一 Action 因 MissingParameter / InvalidParameter 连续失败两次,且错误没有给出确定值时,停止更换相近字段名试错;回到注册 operation、req/resp tag 或官方契约确认。禁止循环枚举 Scene / Type / BizType 等猜测字段。
  5. 先用叶子命令的 Client Preview 核对最终 descriptor 和 payload:
    • arkcli api <registered-action> --params '{...}' --dry-run
    • Preview 是纯本地行为,不登录、不请求后端、不证明权限、配额或资源存在
  6. 只读优先;写操作在 Preview 后仍必须二次确认,然后去掉 --dry-run 执行:
    • arkcli api <registered-action> --params '{...}'
    • payload 自身的 "DryRun":true 是后端字段;未加 CLI --dry-run 时仍会发出真实网络请求
  7. 输出尽量稳定、减少噪声:
    • 优先用全局 --transform '<gjson path>' 提取关键字段
    • 只有排障需要时才开 --debug(会输出请求/响应调试信息到 stderr)
Show full SKILL.md (136 more words)Show less

Guard Checklist(必须执行)

检查点目的做法
产品命令覆盖判断防止误用 api先 arkcli <domain> --help 并对照对应 skill
认证闸门防止把鉴权问题误判为缺能力先 arkcli auth status;失败转 arkcli-auth
契约事实源防止猜参数从同版本 reference、官方契约或可访问的 req/resp JSON tag 生成 --params;缺确定契约就停止
Client Preview防止 raw Action 直接执行invoke 模式先加本地 --dry-run,核对 steps[0].protocol/target/payload
风险确认防止写操作误触发涉及创建/删除/修改/影响费用前,要求用户明确确认
噪声控制防止整坨输出污染上下游默认引导 --transform 提取关键字段;--debug 仅排障打开

示例

bash
arkcli api --list
arkcli api model.list_foundation_models --params '{"PageSize":10,"PageNumber":1}' --dry-run
arkcli api model.list_foundation_models --params '{"PageSize":10,"PageNumber":1}'

# 只提取 items 里的 name(示例 path,按实际输出结构调整)
arkcli api model.list_foundation_models --params '{"PageSize":10,"PageNumber":1}' --transform 'Result.Items.#.Name'

常见错误与处理

现象常见原因处理方式
unknown action "..."Action 未注册或拼写错误先 arkcli api --list;再在 internal/apis/ 中确认是否已注册
invalid --params JSON: ...JSON 不合法(引号/转义/单引号包裹不当)确保 --params 是合法 JSON;必要时把 JSON 放到文件再用 shell 展开传入
api list mode has no request to preview对 api --list 使用了 --dry-runlist 本身已经是纯本地枚举;移除 --dry-run
输出字段和预期不一致直接猜测了契约先读 references/arkcli-api.md 并查看 internal/apis/<domain>/ 的 req/resp

开发约束

  • 如果 Action 未注册:补 internal/apis/<domain>/ 的 operation 注册与 req/resp 契约
  • 不要直接因为 Action 缺失就新增 cmd/<action>;api 是兜底入口
  • 只有当它升级为稳定产品能力时,才在 shortcuts/ 中补业务命令(并配套 skill/reference/test)

参考

© volcengine, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 2 other files (references) in skills/arkcli-api-explorer of volcengine/ark-cli.

  • SKILL.md
  • references/arkcli-api.md
  • references/evals.md

Open the folder on GitHubat commit fb5b7be

Compare with similar skills

Arkcli API Explorer next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Arkcli API Explorer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Arkcli API Explorer this skillvolcengine/ark-cli140—~1.3kAutomated safety check: PassApache-2.0
ToolJet Marketplace Plugin BuilderToolJet/ToolJet41k—~2.1kAutomated safety check: PassAGPL-3.0
Step Partsearthtojake/text-to-cad18k1 repos~1.5kAutomated safety check: PassMIT
API DesignerJeffallan/claude-skills12k2 repos~2kAutomated safety check: PassMIT
OpenAPI to MCP Servermcp-use/mcp-use11k—~5.2kAutomated safety check: PassApache-2.0
Use Yaakmountain-loop/yaak19k—~1.9kAutomated safety check: PassMIT

Similar skills

  • Turns an API description, such as an OpenAPI file or a Postman collection, into a connector plugin for ToolJet's marketplace and checks it with the repo's validator.

    41k GitHub stars~2.1k tokensUpdated today
    Backend & APIsAuto-check passed
  • Step Parts

    earthtojake/text-to-cad

    Find, evaluate, and download common purchasable CAD parts from step.parts, including named off-the-shelf actuators, servos, motors, electronics boards, connectors, screws, bolts, nuts, washers…

    18k GitHub starsUsed in 1 repo~1.5k tokens
    Backend & APIsAuto-check passed
  • API Designer

    Jeffallan/claude-skills

    Designs REST and GraphQL APIs from resource modeling to an OpenAPI 3.1 contract, with versioning, pagination and RFC 7807 error handling.

    12k GitHub starsUsed in 2 repos~2k tokens
    Backend & APIsAuto-check passed
  • OpenAPI to MCP Server

    mcp-use/mcp-use

    Turns an OpenAPI or Swagger spec into an MCP server with the mcp-use TypeScript SDK, mapping each operation to a tool, wiring auth, testing and deploying.

    11k GitHub stars~5.2k tokensUpdated today
    Backend & APIsAuto-check passed
  • Use Yaak

    mountain-loop/yaak

    A skill your agent uses when the user mentions Yaak, a Yaak workspace, or the yaak command, or asks to call, hit, or smoke test HTTP/REST endpoints, save or organize API requests for reuse or manual…

    19k GitHub stars~1.9k tokensUpdated today
    Backend & APIsAuto-check passed
  • Old Coder API Design

    AmazingAng/old-coder

    Reviews or designs an HTTP/JSON API's endpoints, auth, pagination, versioning and deprecations, guarding against inventing a bespoke interface or silently breaking consumers.

    749 GitHub starsUsed in 1 repo~3.4k tokens
    Backend & APIsAuto-check passed

More from volcengine/ark-cli

All 25 skills in this repo
  • Arkcli Code Example

    volcengine/ark-cli

    arkcli +code-example:为指定基础模型生成多语言(Python / Go / Java / Node / curl)调用示例代码并写入本地文件。数据源是火山方舟 OpenTOP OpenGetSampleCode。当用户需要拿某个基础模型的 SDK / curl 调用示例、保存为本地接入模板时使用。反触发:TTS/ASR/语音模型没有 arkcli…

    140 GitHub stars~743 tokensUpdated 8 days ago
    Auto-check passed
  • Arkcli Config

    volcengine/ark-cli

    arkcli 本地配置管理。处理 profile 配置归因、update.mode 的 automatic/disabled 策略、config reset 与历史 yaml 排障;profile 类操作优先使用 arkcli profile <subcmd。

    140 GitHub stars~1.7k tokensUpdated 8 days ago
    Auto-check: notes
  • Arkcli Custommodel

    volcengine/ark-cli

    arkcli 自定义模型仓库管理:从 TOS 导入自定义模型、查询/筛选自定义模型、查看详情、改名、删除、查询可用量化模式、量化已就绪的模型。任何提到自定义模型 ID(cm-)的管理、部署准备,或要求用 cm- 直接对话/推理/试效果的边界判断,都必须使用本 skill。注意:查询火山公共基础模型(doubao 等 foundation models)走 arkcli-models;本…

    140 GitHub stars~2.6k tokensUpdated 8 days ago
    Auto-check passed
  • Arkcli Deploy

    volcengine/ark-cli

    arkcli +deploy:普通创建推理接入点(Endpoint)的统一首选入口。用户说『创建/新建/create 一个 endpoint/接入点』或『部署/上线/deploy 某模型』时优先走这里;但脚本化 / CI / 无护栏 / 原始 raw CRUD 创建是唯一例外,必须改走 arkcli-infer-endpoint,不能由本 skill…

    140 GitHub stars~2.6k tokensUpdated 8 days ago
    Auto-check passed
  • Arkcli Docs

    volcengine/ark-cli

    检索、读取与总结方舟官方文档。用户给出 ark.volcengine.com 文档 URL 或 /docs/ 路径、要求读链接、官方说明、API 契约或必填字段,询问 CC Switch 等第三方客户端的方舟图形配置流程,以及官方网页读取失败时使用。不用于业务调用、资源操作、CLI 帮助或通用知识。

    140 GitHub stars~3.3k tokensUpdated 8 days ago
    Auto-check passed
  • Arkcli Doctor

    volcengine/ark-cli

    arkcli doctor 统一入口,覆盖 CLI 健康、account、error、infer-endpoint、model、metrics、report 与 Ark 图片/视频来源特征验证。用户给 1-20 个媒体 URL 并问是否由 Ark/Seedance/Seedream 生成时,走 doctor +verify-origin:整批只披露并确认一次费用,确认前不发…

    140 GitHub stars~4.9k tokensUpdated 8 days ago
    Auto-check passed

Works with

Categories

Questions about Arkcli API Explorer

What does Arkcli API Explorer do?

Inspect or invoke locally registered ArkCLI actions when product commands cannot cover a task. Arkcli API Explorer is an agent skill from volcengine/ark-cli. Inspect or invoke locally registered ArkCLI actions when product commands cannot cover a task.

When should I use Arkcli API Explorer?

Arkcli API Explorer fits situations like: registry errors; exact raw payloads.

How do I install Arkcli API Explorer in Claude Code?

Run `npx skills add volcengine/ark-cli --skill arkcli-api-explorer -a claude-code`. Or copy the skill folder (skills/arkcli-api-explorer in volcengine/ark-cli) into .claude/skills/arkcli-api-explorer in your project. Claude Code loads it when a task matches its description.

How do I install Arkcli API Explorer in Codex?

Run `npx skills add volcengine/ark-cli --skill arkcli-api-explorer -a codex`. Or copy the skill folder (skills/arkcli-api-explorer in volcengine/ark-cli) into .agents/skills/arkcli-api-explorer in your project. Codex loads it when a task matches its description.

Can I use Arkcli API Explorer in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add volcengine/ark-cli --skill arkcli-api-explorer -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/arkcli-api-explorer, .gemini/skills/arkcli-api-explorer, .github/skills/arkcli-api-explorer and .opencode/skills/arkcli-api-explorer in your project.

What does Arkcli API Explorer need to run?

SKILL.md names no scripts, command-line tools or credentials: Arkcli API Explorer is instructions for the agent only.

Does Arkcli API Explorer access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Arkcli API Explorer safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Arkcli API Explorer use?

Arkcli API Explorer is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Arkcli API Explorer use?

About 1.3k tokens (SKILL.md is roughly 5.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 2.5k tokens, read only when the agent opens those files.

What are the alternatives to Arkcli API Explorer?

Skills that share tags, products or a category with Arkcli API Explorer: ToolJet Marketplace Plugin Builder (ToolJet/ToolJet, 41k stars), Step Parts (earthtojake/text-to-cad, 18k stars), API Designer (Jeffallan/claude-skills, 12k stars) and OpenAPI to MCP Server (mcp-use/mcp-use, 11k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Arkcli API Explorer?

volcengine (a GitHub organization) maintains it in volcengine/ark-cli, which has 140 GitHub stars. The repository holds 25 skills in this directory. The repository was last updated on September 29, 2026.

Source: volcengine/ark-cli on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.