CtrlK
BlogDocsLog inGet started
Tessl Logo

api-development

FastGPT API 开发规范。重点强调使用 zod schema 定义入参和出参,在 API 文档中声明路由信息,编写对应的 OpenAPI 文档,以及在 API 路由中使用 schema.parse 进行验证。

58

Quality

68%

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

Fix and improve this skill with Tessl

tessl review fix ./.agents/skills/system/api-development/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

77%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.

The content is highly actionable and workflow-clear with strong validation feedback loops for destructive/batch operations, but it is over-long due to duplicated examples and inlined reference catalogs that belong in separate files, and its external references point to machine-local or sibling-skill paths rather than real bundle files.

Suggestions

Move the large Zod-method catalog (快速参考 → 常用 Zod 验证方法) and Meta/类型导出 reference blocks into a references/ file (e.g. references/zod-reference.md) and link to it from SKILL.md to reduce duplication and improve progressive disclosure.

Collapse the standalone 完整开发示例 (Create User) and the 常见问题 FAQ, which restate rules already in 核心原则/审查检查清单; keep one canonical example and reference the rules instead.

Replace machine-local and sibling-skill reference paths ('/Volumes/code/...', '.claude/skills/pr-review/...') with relative paths to actual bundle files shipped under references/, so the referenced materials are real and portable.

DimensionReasoningScore

Conciseness

The body is mostly efficient actionable content but at ~790 lines it repeats the same patterns across multiple full examples (e.g. the Create User example re-derives Schema + handler already shown in 步骤 1-2), and the 常见问题 FAQ re-demonstrates fixes already covered by the rules and checklist. It could be tightened; it sits between efficient (4) and noticeably verbose (2), closer to the 'mostly efficient but could be tightened' anchor (3).

3 / 5

Actionability

It provides fully executable, copy-paste-ready TypeScript (imports, handler signatures, schema.parse calls, authApp usage) across standard templates and a complete end-to-end Create User example, plus concrete zod method references covering the common cases. Every token-earning example is concrete and runnable.

5 / 5

Workflow Clarity

Steps 1-4 are clearly sequenced with 🔴 checkpoints, the handler template numbers its validation steps (验证入参 → 业务逻辑 → 验证出参), and the destructive/batch data-cleaning section includes explicit feedback loops: dry-run default, explicit confirm before write, output of 成功/跳过/失败 statistics, skip-and-report for unsafe data. The checklist reinforces these checkpoints.

5 / 5

Progressive Disclosure

There is good section structure, but large blocks of inline reference material (the full 常用 Zod 验证方法 catalog, multiple complete duplicated examples) that could live in separate reference files are inlined, and the external references point to non-bundle paths — absolute machine paths like '/Volumes/code/fastgpt-pro/FastGPT/...' and '.claude/skills/pr-review/*.md' that are not present in references/ scripts/ assets/ (which do not exist here), so the referenced paths are not real bundle files. This matches 'some structure but content that should be separate is inline' (3) better than 4.

3 / 5

Total

16

/

20

Passed

Description

58%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.

The description states concrete, domain-specific capabilities in third person but omits any explicit 'Use when...' trigger guidance, which caps its completeness. It is specific and reasonably distinctive, yet trigger-term coverage is technical rather than natural.

Suggestions

Add an explicit 'Use when...' clause in Chinese, e.g. '当开发新的 FastGPT API 路由、修改入参/出参、或编写/审查 API 文档时使用此技能', to satisfy the completeness 'when' requirement and raise trigger-term quality.

Include more natural phrasings a user would actually say (Next.js API 路由、API 接口文档、参数校验) alongside the current technical jargon to improve trigger-term coverage.

Tighten the action list into a more comprehensive, comma-separated set of capabilities (e.g. add '导出 TypeScript 类型', '复用 PaginationSchema') to move specificity toward full coverage.

DimensionReasoningScore

Specificity

The description names several concrete actions — '使用 zod schema 定义入参和出参', '在 API 文档中声明路由信息', '编写对应的 OpenAPI 文档', '使用 schema.parse 进行验证' — which is multiple specific capabilities, though coverage is somewhat module-flavored rather than an exhaustive action list. It is above the 1-2-action anchor (3) but not the fully comprehensive anchor (5).

4 / 5

Completeness

It has a clear 'what' (define zod schemas, declare routes, write OpenAPI docs, validate with schema.parse) but provides no explicit 'when/Use when...' trigger guidance — per the guidelines a missing 'Use when' clause caps completeness at 3. The 'when' is entirely absent rather than weakly implied.

3 / 5

Trigger Term Quality

It surfaces domain terms users would say ('API 开发', '入参/出参', 'OpenAPI 文档', '路由', 'zod schema') but is technical-jargon heavy and omits common natural phrasings and file extensions a user would say (e.g. 'Next.js API route', 'API 文档', 'schema 验证'); coverage is partial rather than comprehensive. This fits the 'some relevant keywords but missing common variations' anchor better than 4.

3 / 5

Distinctiveness Conflict Risk

It carves a fairly specific niche — FastGPT API route development with zod schemas and OpenAPI docs — that is distinguishable from generic skills, with only minor overlap risk against a general 'code review' or 'TypeScript API' skill. It is not the maximally distinct anchor (5) because the wording lacks explicit trigger phrases that would eliminate ambiguity.

4 / 5

Total

14

/

20

Passed

Validation

93%

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

Validation15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

skill_md_line_count

SKILL.md is long (795 lines); consider splitting into references/ and linking

Warning

Total

15

/

16

Passed

Repository
labring/FastGPT
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.