CtrlK
BlogDocsLog inGet started
Tessl Logo

api-interface-design

设计 BK-CI API 契约时使用,例如 Resource 路径设计、HTTP 方法选择、请求响应对象、错误码和版本策略。当用户要定义接口而不是实现业务逻辑时优先使用。

72

Quality

89%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

Quality

Content

86%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A tight, instruction-only design skill that assumes Claude's competence and is well-structured for quick navigation. Adding a concrete worked API-contract example would push actionability to full marks.

Suggestions

Include one short worked example of a designed contract (path + method + request/response + error code) to make the guidance fully concrete.

Add an explicit validation checkpoint in 快速指导 (e.g. 're-check that path/method/error/version are consistent as one contract before finalizing').

Consider a couple of natural-language synonyms in trigger phrasing (e.g. 'REST 接口', 'API 规范') to broaden discoverability.

DimensionReasoningScore

Conciseness

Lean and efficient — every section (适用场景, 快速指导, 高信号规则, 关键陷阱) adds design judgment Claude does not already have, with no padding about what APIs or REST are.

5 / 5

Actionability

Gives concrete rules and specifics (e.g. '/user/、/service/、/build/、/open/ 等路径前缀', '能用资源语义表达的,就不要退化成动作式杂糅接口'), but lacks a worked example of a fully designed contract, leaving a minor gap.

4 / 5

Workflow Clarity

The 快速指导 section lays out a clear 5-step design sequence with an explicit escape hatch to another skill, though it has no validation/checkpoint feedback loop.

4 / 5

Progressive Disclosure

A simple, well-organized skill under 50 lines with no need for external bundle files; sections are clearly labeled and easy to navigate.

5 / 5

Total

18

/

20

Passed

Description

92%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A well-targeted, third-person description that crisply states both capability and trigger conditions with strong distinctiveness. The only minor gap is trigger-term synonym coverage.

DimensionReasoningScore

Specificity

Lists multiple concrete design actions — 'Resource 路径设计、HTTP 方法选择、请求响应对象、错误码和版本策略' — giving comprehensive coverage of the API-contract domain.

5 / 5

Completeness

Explicitly answers both what ('设计 BK-CI API 契约…') and when ('当用户要定义接口而不是实现业务逻辑时优先使用') with concrete trigger phrasing.

5 / 5

Trigger Term Quality

Natural terms a user would say are present ('设计 API 契约', '接口', '错误码', '版本策略'), but coverage lacks common synonyms/variants, so it sits just below the comprehensive anchor.

4 / 5

Distinctiveness Conflict Risk

Carves a clear niche (BK-CI API contract design) and explicitly distinguishes it from implementation work, minimizing overlap with sibling skills.

5 / 5

Total

19

/

20

Passed

Validation

100%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository
TencentBlueKing/bk-ci
Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.