CtrlK
BlogDocsLog inGet started
Tessl Logo

api-patterns

API design principles and decision-making. REST vs GraphQL vs tRPC selection, response formats, versioning, pagination.

44

Quality

44%

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 ./plugins/AI-Agents-Safe-Coding-Skills/skills/api-patterns/SKILL.md

The canonical home for this skill is api-patterns in sickn33/agentic-awesome-skills

SKILL.md
Quality
Evals
Security

Quality

Content

42%Scale 1-3

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

This skill functions primarily as an index/table of contents pointing to detailed sub-files, which is good for progressive disclosure but leaves the main file almost entirely devoid of actionable content. There are no code examples, concrete API designs, or executable guidance—just abstract checklists and do/don't lists. The content map is well-organized, but the skill relies entirely on external files for substance.

Suggestions

Add at least one concrete, executable example in the main file—e.g., a sample REST endpoint definition, a response envelope JSON schema, or a quick decision tree with specific code snippets for each API style.

Replace the vague anti-patterns section with concrete before/after examples showing incorrect vs correct API designs (e.g., bad endpoint naming vs good, inconsistent response vs consistent response with actual JSON).

Remove the 'When to Use' section which adds no information, and trim the 'Selective Reading Rule' which is meta-instruction Claude doesn't need.

DimensionReasoningScore

Conciseness

The content is reasonably lean but includes some filler like the 'Learn to THINK, not copy fixed patterns' tagline, the 'When to Use' section that says nothing, and the selective reading rule which is meta-instruction rather than substance. The content map and checklists are efficient, but some sections add little value.

2 / 3

Actionability

The skill provides no concrete code, commands, examples, or executable guidance. The anti-patterns section lists vague do/don't rules without showing what correct implementations look like. The content map points to other files but the skill itself contains no actionable API design content—it's entirely an index with abstract checklists.

1 / 3

Workflow Clarity

The decision checklist provides a reasonable sequence of considerations before designing an API, but it lacks explicit validation steps, feedback loops, or concrete sequencing of the design process. It's a checklist rather than a workflow with checkpoints.

2 / 3

Progressive Disclosure

The content map is well-structured with clear file references, descriptions, and 'When to Read' guidance. References are one level deep, clearly signaled, and organized for easy navigation. Related skills are also well-linked.

3 / 3

Total

8

/

12

Passed

Description

47%Scale 1-3

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 provides good keyword coverage for API design topics and names specific technologies, which aids discoverability. However, it lacks action verbs describing concrete capabilities and entirely omits a 'Use when...' clause, making it unclear when Claude should select this skill over others. Converting the topic list into explicit actions and adding trigger guidance would significantly improve it.

Suggestions

Add a 'Use when...' clause, e.g., 'Use when the user asks about choosing between REST, GraphQL, or tRPC, designing API endpoints, or needs guidance on API versioning, pagination, or response format decisions.'

Replace topic nouns with concrete action phrases, e.g., 'Guides API architecture decisions including REST vs GraphQL vs tRPC selection, designs response formats, recommends versioning strategies, and implements pagination patterns.'

Add file type or context triggers if applicable, e.g., 'Use when reviewing OpenAPI specs, designing new endpoints, or planning API migrations.'

DimensionReasoningScore

Specificity

Names the domain (API design) and lists several specific topics (REST vs GraphQL vs tRPC selection, response formats, versioning, pagination), but these read more like topic areas than concrete actions. No action verbs like 'design', 'evaluate', or 'implement' are used.

2 / 3

Completeness

Describes 'what' at a topic level but completely lacks a 'Use when...' clause or any explicit trigger guidance for when Claude should select this skill. Per rubric guidelines, a missing 'Use when...' clause caps completeness at 2, and the 'what' is also weak (topics rather than actions), warranting a 1.

1 / 3

Trigger Term Quality

Includes strong natural keywords users would say: 'API design', 'REST', 'GraphQL', 'tRPC', 'versioning', 'pagination', 'response formats'. These are terms developers naturally use when seeking API design guidance.

3 / 3

Distinctiveness Conflict Risk

The mention of specific technologies (REST, GraphQL, tRPC) and API-specific concerns (versioning, pagination) provides some distinctiveness, but 'API design principles' is broad enough to potentially overlap with general backend development or architecture skills.

2 / 3

Total

8

/

12

Passed

Validation

90%

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

Validation10 / 11 Passed

Validation for skill structure

CriteriaDescriptionResult

frontmatter_unknown_keys

Unknown frontmatter key(s) found; consider removing or moving to metadata

Warning

Total

10

/

11

Passed

Repository
administrakt0r/AI-Agents-Safe-Coding-Skills
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.