SKILLEMALL.ai
RU Sign in

BF API-design-doc

标准化API接口设计文档生成工具。根据需求文档、数据库DDL等输入，进行API的标准化、规范化设计，输出完整的API接口设计文档，包括错误码规范、接口格式规范、入参出参定义、JSON示例等，指导后续的代码开发和前后端联调。使用场景包括：(1) 根据业务需求设计RESTful API接口，(2) 基于数据库DDL生成对应的CRUD接口文档，(3) 规范化现有API接口文档，(4) 为前后端联调提供标准化的接口规范文档

ClawHub Agent Skills author: cnsunxuefeng v1.0.0 MIT-0 7 files body ≈ 512 tokens Open the sourceclawhub.ai↗ analyzed 2 d ago

As a process F 33/100 · Will not run — References files that are not bundled: assets/templates/api-doc-template.md

IntegrationInfrastructuretype and topics are labelled automatically from the skill text
Runs in: OpenClaw Claude / Claude Code ChatGPT / Codex Gemini CLI Cursor GitHub Copilot / VS Code Qwen Code Kimi Code CLI Z.ai (GLM) DeepSeek (Deep Code) Mistral Vibe LangChain (deepagents) Goose OpenCode
JSON
Technical rating
B
84/100
safety, quality, tests
Safety 60%
100
Quality 40%
61
Run on models
none yet
Process rating
F
33/100
Will not run
References files that are not bundled: assets/templates/api-doc-template.md
Tools and files w 18
0
Result and completion w 14
0
Inputs and preconditions w 11
0
the three weakest of ten parameters · all ten

How to improve

  1. Say in the description WHEN to use the skill ("use when…", example requests): that is the agent's main cue.
  2. The text references files that are not there: add them or drop the references.
For the model run — optional
  • Your own cases (evals/evals.json, 4–6 real requests with expected answers): the full check would then run those instead of a model-drafted suite.
  • A spec.yaml with trigger phrases and assertions — a behaviour contract for CI; `skilltest init` writes a template.

Guard findings · 0

✓ No critical or high findings

Files scanned: 7. Evidence is masked. Grey chips explain why severity was lowered.

Against the Agent Skills spec

  • warning name-format name should be kebab-case (lowercase letters, digits, hyphens)
  • warning description-no-when description does not say WHEN to use the skill (no "use when")
  • warning missing-ref reference to a missing file: assets/templates/api-doc-template.md

Process rating: all ten parameters 33/100

Will not run. References files that are not bundled: assets/templates/api-doc-template.md
  • 0Tools and files. 1 referenced file(s) missing: assets/templates/api-doc-template.md
  • 0Result and completion. Does not say what the result is
  • 0Inputs and preconditions. Does not say what the process needs to start
  • 0Failures and branches. Linear process with no failure handling
  • 0Progress reporting. Says nothing while it works
  • 20When it triggers. No condition that starts the skill
  • 30Running it twice. 3 mutating operations with no state check
  • 100Steps. 47 steps
  • 100Consistency. Name and required fields are in place
  • 100Execution cost. Instruction body is 512 tokens

Everything here is measured from the skill text rather than judged by a model, so the numbers are checkable. A parameter weighs more when it is a more common reason for the process to stall.

Quality signals

  • +5Description has no quoted example phrases that should trigger the skill
  • +4Description does not say when NOT to use the skill (false activations)
  • +3Output format is not stated: the model decides each time
  • +4No input/output examples
  • +1No license
  • +2Single-language instructions
  • +3Description length 209: enough signal without eating the budget
  • +4Structure: 13 headings
  • +3Step-by-step instructions: 47 items
  • +4Reference files are cited in the instructions (4 of 4)

Quality base 70; lint remarks subtract, signals add up to 100. Result: 61.

External checks

ClawHub: clean
This skill is a straightforward API documentation generator whose main effect is creating one Markdown design document in the project.
LLM: benign (high) · VirusTotal: · 29 May 2026