jentic-api-scorecard

Score OpenAPI documents against the Jentic API AI Readiness Framework.

21|5|Updated May 21, 2026
One-click install
npx skills add https://github.com/jentic/jentic-api-scorecard --skill jentic-api-scorecard
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: jentic-api-scorecard
Source: https://github.com/jentic/jentic-api-scorecard/tree/main/skills/jentic-api-scorecard
Command: npx skills add https://github.com/jentic/jentic-api-scorecard --skill jentic-api-scorecard

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

The jentic-api-scorecard skill addresses the challenge of ensuring the quality, safety, and AI-readiness of your OpenAPI (Swagger) specification by providing a comprehensive scoring service.

Core Features & Use Cases

  • AI Readiness Scoring: Measures your OpenAPI spec against the Jentic API AI Readiness Framework (JAIRF) with a grade.
  • Automated Linting: Identifies issues such as syntax errors and semantic inconsistencies.
  • Machine-Readable Output: Delivers a JSON scorecard that can be used in CI pipelines.
  • Custom Reports: Offers various formats for reporting, including JSON, HTML, and markdown.
  • LLM Analysis: Provides additional signals using language models to enrich the analysis.
  • Integration: Seamlessly integrates with CI/CD pipelines and GitHub Actions.

Quick Start

To score your OpenAPI document using the jentic-api-scorecard skill, execute the following command:

JENTIC_API_KEY=<your-key> npx @jentic/api-scorecard-cli score ./openapi.yaml

Frequently Asked Questions about jentic-api-scorecard

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check if my OpenAPI document is ready for AI integration?

To check AI readiness, you score your OpenAPI document against the Jentic API AI Readiness Framework. This process performs linting and analysis to identify syntax errors and semantic inconsistencies, returning a machine-readable grade.

What is OpenAPI AI readiness scoring?

OpenAPI AI readiness scoring measures your specification against the Jentic API AI Readiness Framework (JAIRF). It evaluates quality and safety by linting the document and producing a scorecard to ensure APIs are reliable for AI agents.

Can I use OpenAPI linting in a CI/CD pipeline?

Yes, you can integrate OpenAPI linting into CI/CD pipelines and GitHub Actions. The tool outputs a machine-readable JSON scorecard that automates API quality checks and blocks deployments on semantic inconsistencies.

How do I generate an OpenAPI scorecard report?

You generate an OpenAPI scorecard by running the scoring command with your API key and document path. The tool outputs custom reports in various formats including JSON, HTML, and markdown for documentation and CI automation.

Does OpenAPI quality analysis support LLM enrichment?

Yes, OpenAPI quality analysis supports optional LLM enrichment. Language models provide additional signals to enrich the standard linting and semantic analysis, offering deeper insights into your API specification.