CtrlK
BlogDocsLog inGet started
Tessl Logo

python-api-consistency-validator

Validate API consistency between two versions of Python libraries. Use when you need to compare API behavior, signatures, and exceptions between library versions to identify breaking changes, incompatible modifications, and behavior differences. The skill performs static analysis of Python code, compares function signatures, class definitions, parameter types, return types, and generates a detailed JSON report with breaking changes, warnings, and migration guidance. Supports Python libraries and packages.

70

Quality

86%

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

88%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 body is a well-organized, highly actionable quick-start document with executable commands, a concrete report example, and clear exit-code semantics. Its only weaknesses are minor: a redundant Overview/Usage overlap with the description and Quick Start, plus a few generic tips that could be trimmed.

DimensionReasoningScore

Conciseness

The body is largely lean with executable commands, a compact report schema, and exit-code semantics, but the Overview restates the frontmatter description and several Tips are common-sense filler ('Review breaking changes carefully', 'Check warnings for potential issues'). This fits 'efficient; minor instances of over-explanation that could be trimmed' rather than the every-token-earns-its-place anchor.

4 / 5

Actionability

Quick Start and Usage give copy-paste-ready, fully executable commands ('python scripts/validate.py /path/to/old_version /path/to/new_version --output report.json'), a concrete JSON report example, and explicit exit-code behavior. Not below the top anchor: the common cases (compare two paths, write report, interpret exit code) are all covered.

5 / 5

Workflow Clarity

This is a simple single-action skill — run the validator on two library paths and read the report/exit code — and that single action is unambiguous, which the simple-skill guidance allows to score 5. The operation is read-only static analysis, so the destructive/batch validation cap does not apply, and exit-code semantics provide the outcome checkpoint.

5 / 5

Progressive Disclosure

The body is well organized into sections with a correctly referenced, existing bundle script ('scripts/validate.py'), and the inline JSON example is appropriately sized. It falls short of a 5 only because the Usage section duplicates Quick Start and the body (~66 lines) exceeds the under-50-line simple-skill benchmark, leaving minor organization gaps rather than a flawlessly split structure.

4 / 5

Total

18

/

20

Passed

Description

83%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 strong description that explicitly states both what the skill does and when to use it, with numerous concrete capabilities and good trigger keywords. Its weaknesses are mild: second-person phrasing in the trigger clause and some missing natural synonyms and user phrasings for trigger terms.

Suggestions

Rewrite the trigger clause in third person (e.g., 'Use when comparing API behavior between library versions' instead of 'Use when you need to compare...') to keep the description in a consistent third-person voice.

Add natural user phrasings and synonyms such as 'upgrade dependencies', 'check backward compatibility', 'semantic versioning', or '.py' to broaden trigger term coverage.

Trim the redundant closing sentence 'Supports Python libraries and packages' since the scope is already established, tightening the description.

DimensionReasoningScore

Specificity

The description lists multiple concrete actions ('compares function signatures, class definitions, parameter types, return types, and generates a detailed JSON report with breaking changes, warnings, and migration guidance'), matching the comprehensive anchor. However, the trigger clause uses second person ('Use when you need to compare...'), which the judging guidelines penalize by reducing specificity by 1, so it cannot score 5.

4 / 5

Completeness

It clearly answers both what ('performs static analysis of Python code, compares function signatures... generates a detailed JSON report') and when, with an explicit 'Use when' clause containing concrete triggers ('when you need to compare API behavior, signatures, and exceptions between library versions to identify breaking changes'). This matches the top anchor; the 'when' clause is explicit and specific, not merely implied.

5 / 5

Trigger Term Quality

Good natural keywords are present ('API consistency', 'breaking changes', 'Python libraries', 'signatures', 'exceptions'), but common variations users would say are missing (e.g., 'upgrade dependencies', 'check compatibility', 'semantic versioning', file extensions). This fits 'good keyword coverage; a few natural terms missing' rather than comprehensive coverage.

4 / 5

Distinctiveness Conflict Risk

It carves a clear niche (version-to-version Python API comparison) with distinct triggers, but phrases like 'behavior differences' and 'incompatible modifications' create minor overlap risk with general code-diff and library-analysis skills. This fits 'mostly distinct; minor overlap risk' rather than minimal conflict risk.

4 / 5

Total

17

/

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.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository
ArabelaTso/Skills-4-SE
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.