AI 接口度量项目是否暴露机器可读的接口:正式的 API 模式(schema)、Model Context Protocol(MCP)服务器,或可运行示例。凡此类接口存在之处,AI 代理即可通过契约来使用该软件,而无需从源码逆向推断其行为。
- 类别:AI 就绪度(类别内占 15%)
- 在总指数中的权重:0%——属于独立的 AI 就绪度徽章
- 指标键:
ai_interfaces - 当仓库不具备任何上述信号时为
null——缺失被视为不适用,绝不作为罚分
数值如何计算
| 组成部分 | 权重 | 证据 |
|---|---|---|
| API 模式 | 40 | OpenAPI/Swagger、GraphQL SDL、protobuf 或 AsyncAPI 文件 |
| MCP 服务器 | 20 | Model Context Protocol 服务器依赖或 mcp.json 配置 |
| 可运行示例 | 40 | examples/、recipes/ 或 samples/ 目录,或笔记本(notebook)文件 |
null 规则详解
一个普通的工具库理所当然地没有 API 模式、没有 MCP 表面,也可能没有示例目录——因其本性而对其降分是不公正的。因此,该指标仅在至少一个信号存在时才产生数值;否则为 null,AI 就绪度类别将权重重新归一化到其余指标之上,遵循方法论通用的缺失数据规则(参见健康指数)。
为什么是这三个信号
- API 模式是模型可以精确读取的契约——端点、类型与错误一览无余,无需推断。
- MCP 服务器是对代理就绪度最强有力的声明:项目为 AI 工具链提供了一等公民级的接口。
- 可运行示例是可执行的文档。对代理而言,一个能运行的示例是经过验证的起点,而非有待解读的文字——示例同时兼作公共 API 的事实性测试。
如何提升数值
- 发布项目已隐含的 API 模式:从框架生成 OpenAPI,提交
.proto或 GraphQL SDL 文件。 - 维护一个
examples/目录,收录小型可运行程序,并在 CI 中保持其时效。 - 若项目天然服务于工具链,可考虑随附一个 MCP 服务器。