BC API Design & Documentation Generator
AI-powered API design and documentation assistant — generate RESTful/OpenAPI specs, write comprehensive API docs (guides, tutorials, reference), create mock servers, validate API designs, and produce SDK code snippets. Supports OpenAPI 3.0/3.1, AsyncAPI, GraphQL SDL, and major languages. Built for backend developers, API product managers, DevOps engineers, and technical writers who need to design, document, and ship APIs faster. Keywords: API documentation, OpenAPI spec, REST API design, API reference, developer portal, API guide, Swagger, AsyncAPI, GraphQL schema, API validation, mock server, SDK generation, API设计, 接口文档, OpenAPI, Swagger文档.
As a process C 60/100 · Has gaps — weak spots: when it triggers, consistency, running it twice
How to improve
- Say in the description WHEN to use the skill ("use when…", example requests): that is the agent's main cue.
- The SKILL.md body is over 5,000 tokens: move reference detail into references/ and load it when needed.
- 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: 2. Evidence is masked. Grey chips explain why severity was lowered.
Against the Agent Skills spec
- warning
name-formatname should be kebab-case (lowercase letters, digits, hyphens) - warning
description-no-whendescription does not say WHEN to use the skill (no "use when") - warning
body-longSKILL.md body ≈ 5069 tokens (recommended < 5000); move details to references/
Process rating: all ten parameters 60/100
- 20When it triggers. No condition that starts the skill
- 30Running it twice. 11 mutating operations with no state check
- 40Consistency. Frontmatter name (API Design & Documentation Generator) differs from the folder (api-design-documentation)
- 50Failures and branches. 0 branches, has a failure section
- 60Tools and files. Uses tools (bash, web, python) that frontmatter does not declare
- 60Result and completion. Output format stated, no completion criterion
- 70Inputs and preconditions. Inputs and preconditions are listed
- 70Execution cost. Instruction body is 5069 tokens
- 100Steps. 80 steps
- 100Progress reporting. Reports progress
- low 14 top-level sections: this looks like several domains in one skill
- low The response is described with custom markup (6 tags): a typed call is more reliable
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)
- +1No license
- +2Single-language instructions
- +3Description length 649: enough signal without eating the budget
- +4Structure: 30 headings
- +3Step-by-step instructions: 80 items
- +3Output format is stated explicitly
- +4Has examples (25 code blocks)
Quality base 70; lint remarks subtract, signals add up to 100. Result: 60.