内容
# mcp-bridge-parser
**将任何 OpenAPI 3.x 规范转换为可立即使用的模型上下文协议(MCP)服务器配置。在 Node.js、浏览器和 Deno 中运行 — 零网络请求,零依赖(除了 js-yaml)。**
[](https://www.npmjs.com/package/mcp-bridge-parser)
[](https://www.npmjs.com/package/mcp-bridge-parser)
[](https://opensource.org/licenses/MIT)
[](https://github.com/stormlive-ai/mcp-bridge-parser)
**[mcpbridge.org](https://mcpbridge.org)** — 尝试在线转换器,浏览 1000+ API 配置,并访问托管的 MCP 端点。
---
## 功能
- **无处不在** — Node.js、浏览器、Deno、Bun(无 `fs` 或 `http` 依赖)
- **JSON + YAML** — 自动解析两种 OpenAPI 格式
- **零网络** — 所有处理都是本地的;无数据离开您的机器
- **TypeScript** — 捆绑了完整的类型定义
- **可树状摇动** — 仅导入所需内容(ESM + CJS)
- **小巧** — 约 2.7 KB 压缩
## 安装
```bash
npm install mcp-bridge-parser
```
```bash
yarn add mcp-bridge-parser
```
```bash
pnpm add mcp-bridge-parser
```
```bash
bun add mcp-bridge-parser
```
## 快速入门
```ts
import { parseOpenApiSpec } from "mcp-bridge-parser"
const config = parseOpenApiSpec(`
openapi: "3.0.0"
info:
title: 我的 API
version: "1.0.0"
paths:
/users:
get:
summary: 列出用户
operationId: listUsers
responses:
"200":
description: 用户列表
`)
console.log(config.mcpServers.my_api.tools[0].name)
// => "list_users"
```
### 从 JSON 对象
```ts
import { parseSpecObject } from "mcp-bridge-parser"
const spec = {
openapi: "3.0.0",
info: { title: "Stripe API", version: "2024-01-01" },
paths: {
"/v1/customers": {
get: { summary: "列出客户", operationId: "listCustomers" },
},
},
}
const config = parseSpecObject(spec)
// config.mcpServers.stripe_api.tools[0] — 适用于 Claude Desktop、Cursor 等
```
### 在线试用
在 [mcpbridge.org/convert](https://mcpbridge.org/convert) 上粘贴任何 OpenAPI 规范 — 转换器完全在您的浏览器中运行。
---
## API
### `parseOpenApiSpec(input: string | Record<string, unknown>): McpConfig`
解析 OpenAPI 规范(JSON 字符串、YAML 字符串或 JavaScript 对象)并返回 MCP 配置对象。如果输入不是有效的 OpenAPI,则抛出异常。
| 参数 | 类型 | 描述 |
|-----------|------|-------------|
| `input` | `string \| Record<string, unknown>` | OpenAPI 3.x 规范为 JSON、YAML 或预解析对象 |
### `parseSpecObject(spec: Record<string, unknown>): McpConfig`
解析预解析的 OpenAPI 规范对象。在您已经在其他地方加载和验证了规范时很有用。
### 返回类型:`McpConfig`
```ts
interface McpConfig {
mcpServers: Record<string, McpServerConfig>
}
interface McpServerConfig {
command: string
args: string[]
env: Record<string, string>
tools: McpTool[]
}
interface McpTool {
name: string
description: string
inputSchema: Record<string, unknown>
}
```
输出兼容于:
- **Claude Desktop** — 放入 `claude_desktop_config.json`
- **Cursor** — 在 `.cursor/mcp.json` 中用作 MCP 服务器
- **VS Code** — 与 MCP 扩展一起使用
- **任何 MCP 客户端** — 标准 `mcpServers` 格式
---
## 用例
### AI 代理工具集成
通过将 OpenAPI 规范转换为 MCP 服务器配置,为您的 AI 代理(Claude、GPT、Copilot)提供对任何 REST API 的访问。代理自动获取具有输入模式的结构化工具定义。
### 快速原型设计
在 API 开发过程中,快速生成 MCP 配置,以在不编写样板代码的情况下使用 AI 客户端测试您的端点。
### CI/CD 管道
在您的构建管道中使用 `mcp-bridge-parser`,每次部署时从您的 API 规范自动生成 MCP 配置。
---
## 关于 MCP-Bridge
`mcp-bridge-parser` 是 [MCP-Bridge](https://mcpbridge.org) 背后的核心解析引擎,MCP-Bridge 是一个完整的 MCP 生态系统平台:
- **转换器** — 基于浏览器的 OpenAPI → MCP 工具(免费)
- **配置 URL 注册表** — 1000+ API,具有永久、可获取的配置 URL
- **托管端点** — 将任何 OpenAPI 规范转换为实时 MCP 端点($5/月)
- **捆绑堆栈** — 预配置的 API + 光标规则组合($15/月)
- **目录** — 1000+ MCP-ready API 的可搜索索引
---
## 许可证
MIT — 请参阅 [LICENSE](LICENSE)。
---
由 [stormlive-ai](https://github.com/stormlive-ai) 构建。
网站:[mcpbridge.org](https://mcpbridge.org)