JJ

jentic/jentic-api-scorecard

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

21 stars 质量 70 趋势 30Apache-2.0

为任何OpenAPI文档进行AI准备度评分。命令行工具、GitHub Action和实现开放JAIRF评分框架的代理技能,包含HTML报告和OpenAPI覆盖层输出。

概览

通过验证的 OpenAPI 文档不一定是 AI 代理能使用的文档。语法是一回事;语义清晰、安全性和可发现性则是另一回事。它会根据 Jentic API AI 准备框架(JAIRF)在六个维度上对你的 OpenAPI 文档进行评分,并返回一个评分——让你准确知道哪些地方需要改进。将其与配套代理技能配合使用,自动应用这些改进:不破坏的编辑、可重复使用的 OpenAPI 覆盖层,以及前后变更日志。 1. 在Jentic记分卡API密钥页面获取免费密钥。 每份OpenAPI文档都从六个角度进行评估——其中任何一个小而有针对性的变化,往往能为人类开发者和AI代理带来巨大的收益: - — 结构有效性和对OpenAPI本身的一致性。- — 文档质量以及OpenAPI文档与下游工具的兼容性。- — 语义清晰度以及LLM需要推理每个操作的上下文。

概述(AI 翻译)

通过验证的OpenAPI文档不一定是AI代理能使用的文档。语法是 一方面;语义清晰、安全性和可发现性则是另一回事。Jentic API 评分卡 将你的 OpenAPI 文档与 Jentic API AI 准备框架(JAIRF) 跨越六个维度,并返回一个等级——这样你就知道哪些地方需要改进。配对 配合配套的api-improve代理技能,可以自动应用这些改进: 非断裂编辑,可重复使用。 OpenAPI 覆盖层,以及之前/之后的变更日志。

目录

  • 快速入门
  • 它的得分
  • 工作原理
  • 要求
  • 安装
  • 现在试试
  • 控制输出深度
  • 机器可读输出
  • HTML 报告
  • LLM分析
  • 匿名访问与密钥访问
  • 技能
  • Jentic-API 记分卡
  • Jentic-API-Improve
  • CLI 参考
  • 命令
  • score
  • GitHub Action
  • 喜欢浏览器?
  • 默认企业级
  • 你的 OpenAPI 文档永远不会离开你的环境
  • 可端到端可听
  • 签署受监管环境
  • 无处不在
  • 置顶以保证重复性
  • 状态
  • 计分发动机信号状态
  • 许可证

快速开始

本页由 AI 翻译,技术细节请以原文为准。

README

以下为原文 README 节选,完整内容请查看原文。

Jentic API Scorecard

An OpenAPI document that passes validation isn’t necessarily one an AI agent can use. Grammar is one thing; semantic clarity, safety, and discoverability are another. The Jentic API Scorecard scores your OpenAPI document against the Jentic API AI Readiness Framework (JAIRF) across six dimensions and returns a single grade — so you know exactly where to improve. Pair it with the companion api-improve agent skill to apply those improvements automatically: non-breaking edits, a reusable OpenAPI Overlay, and a before/after changelog.

Table of contents

Quick start

  1. Get a free key at the Jentic Scorecard API Keys page.

  2. Score an OpenAPI document:

    JENTIC_API_KEY= npx @jentic/api-scorecard-cli score ./openapi.yaml
    

What it scores

Each OpenAPI document is evaluated across six lenses — small, targeted improvements in any of them tend to produce outsized gains for both human developers and AI agents:

在 GitHub 查看完整 README

推荐工具

换一个关键词,或者移除筛选条件。

安装

npx skillfish add jentic/jentic-api-scorecard
新手?先看 mcpskill.org 教程 →