内容
# API 治理 MCP
一个 [Model Context Protocol](https://modelcontextprotocol.io) 服务器,允许 **任何 AI 客户端** 根据最佳实践的 **API 治理规则集** 检查您的 API 工件 -
这样代理可以检查您的 OpenAPI(**3.x 和 Swagger 2.0**)、AsyncAPI、Arazzo、APIs.json、JSON Schema、MCP 等,并以对话式的方式告诉您需要修复的内容。
由 **[Spectral](https://github.com/stoplightio/spectral)** 驱动。它运行与 [API Commons **API 验证器**](https://validator.apicommons.org) 相同的引擎和编译后的规则集(`rules/all-rules.yaml`),后者是浏览器工具,在此处通过 stdio 在服务器端运行。规则集是从公共 Spectral 规则集和 [API Evangelist](https://apievangelist.com) 治理规则编译而成的:**12 种工件格式中的 769 条规则**,其中 **`openapi` 组有 462 条规则**。每条规则都附带 `info` 级别的说明;您可以将个别规则提升到 `warn`/`error` 级别,并使用自定义规则集来强制执行您选择的内容。
**Swagger 2.0 与 OpenAPI 3.x 并驾齐驱。** `openapi` 目录治理 `swagger: "2.0"` 文档与治理 `openapi: 3.x` 文档完全相同 - Spectral 自动检测每种文档的格式并运行匹配的规则(双胞胎和格式门控意味着跨版本不会出现假阳性)。服务器将 `swagger` 格式同义词映射到 `openapi`,因此客户端可以任选其一。
## 工具
| 工具 | 功能 |
| --- | --- |
| `lint_artifact` | 检查工件(`content`,可选 `format`,可选自定义 `ruleset`)→ 发现(代码、消息、严重程度、路径)+ 计数 |
| `list_rulesets` | 它所治理的工件格式以及每种格式适用的规则 |
| `list_formats` | 规则集可以检查的工件格式 |
| `describe_rule` | 查询发现代码 → 标题、描述、严重程度、标签、目标路径和修复提示 |
| `validate_ruleset` | 在使用自定义 Spectral 规则集进行检查之前,对其进行结构验证 |
| `request_review` | 获取一封可以直接发送的电子邮件,以便与 [API Evangelist](https://apievangelist.com/services/) 接洽,获取专家治理服务 |
### 格式
`openapi` · `asyncapi` · `arazzo` · `apis-json` · `jsonschema` · `json-structure` ·
`json-ld` · `mcp` · `plans` · `rate-limits` · `finops` · `agent-skill`
`openapi` 格式涵盖 **Swagger 2.0 和 OpenAPI 3.x**(可使用 `swagger` 或 `openapi`)。`openapi` 和 `asyncapi` 规则集还扩展了推荐的 Spectral 引擎规则;其他所有格式都完全由其精选的规则检查。
## 使用方法
```bash
npm install
npm start # 通过 stdio 启用 MCP
```
### Claude Desktop / 任意 MCP 客户端
将以下内容添加到客户端的 MCP 服务器配置中(例如 Claude Desktop 的 `claude_desktop_config.json`):
```json
{
"mcpServers": {
"api-governance": {
"command": "npx",
"args": ["-y", "@api-common/api-governance-mcp"]
}
}
}
```
然后询问: *"检查此 OpenAPI 是否存在治理问题,并告诉我如何修复。"*
## API Commons 工具的一部分
面向您生产和消费的 API 的浏览器优先、无后端工具 - **[API 发现](https://discovery.apicommons.org)**、 **[API 文档](https://documentation.apicommons.org)**、 **[API 验证器](https://validator.apicommons.org)**、 **[API 可重用性](https://reusability.apicommons.org)** 和 **[MCP 安装](https://install.apicommons.org)**。这是 **API 验证器** 的 AI 接口:相同的 Spectral 治理,通过 MCP 暴露给任何代理。您可以在 [apicommons.org/tools](https://apicommons.org/tools/) 上找到它们。
---
[API Evangelist](https://apievangelist.com) 项目,在 [API Commons](https://apicommons.org) 下公开维护。该工具是开放且免费的;API Evangelist 提供围绕它的专家治理服务。Apache-2.0.
**治理指导** - 工具背后的原因: [MCP](https://guidance.apievangelist.com/store/mcp/),位于 guidance.apievangelist.com。