MCP

介绍

Orval 从 OpenAPI 生成 MCP 服务器。 模型上下文协议 (MCP) 服务器通过简单地中继 API 客户端创造巨大价值。 这消除了等待某人开发或在市场上发布它的需要。您可以为拥有 OpenAPI 的各种服务创建 MCP 服务器，并与 AI 代理一起使用它们。 从单个 OpenAPI 规范中，可以生成各种 API 生态系统组件。相同的规范可用于支持传统的客户端-服务器应用程序和 AI 代理集成。

如何使用

如果您想生成 模型上下文协议 (MCP) 的服务器，请将 client 属性定义为 mcp，将在目标文件和目录中生成 MCP 服务器。您可以查看 typescript-sdk。

使用 orval.config.js 的示例

1import { defineConfig } from 'orval';
2
3export default defineConfig({
4  petstore: {
5    input: {
6      target: './petstore.yaml',
7    },
8    output: {
9      mode: 'single',
10      client: 'mcp',
11      baseUrl: 'https://petstore3.swagger.io/api/v3',
12      target: 'src/handlers.ts',
13      schemas: 'src/http-schemas',
14    },
15  },
16});

目前，请注意 mcp 客户端仅在 single 模式下工作。

生成的模板结构

orval 按以下结构生成文件：

1src/
2├── http-schemas
3│   ├── createPetsBodyItem.ts
4│   ├── error.ts
5│   ├── index.ts
6│   ├── listPetsParams.ts
7│   ├── pet.ts
8│   ├── pets.ts
9│   └── updatePetByParamsParams.ts
10├── handlers.ts
11├── http-client.ts
12├── server.ts
13└── tool-schemas.zod.ts

每个生成的文件都有特定的用途：

• http-schemas/: 包含 request/response 数据的 TypeScript 类型定义的目录
• handlers.ts: 包含使用 fetch 客户端进行 API 调用并以 MCP 格式返回结果的处理器函数
• http-client.ts: 包含用于 API 通信的生成 fetch 客户端函数
• server.ts: 定义 MCP 工具 和服务器配置
• tool-schemas.zod.ts: 为 MCP 工具 输入定义 Zod 模式

使用生成的 MCP 服务器

要将生成的代码用作 MCP 服务器，请按照以下步骤操作：

1. 构建 Docker 镜像：

docker build ./ -t mcp-petstore

2. 在 AI 代理的配置中配置 MCP 服务器：

这里我们将介绍使用 cline 为 AI 代理进行的设置。它将与其他 AI 代理一起工作，因此请相应地调整详细设置。 对于 clile，请按如下方式指定：

1{
2  "mcpServers": {
3    "petstore": {
4      "command": "docker",
5      "args": [
6        "run",
7        "-i",
8        "--rm",
9        "mcp-petstore"
10      ],
11      "disabled": false,
12      "alwaysAllow": []
13    },
14  }
15}

此设置允许您的 AI 代理通过 MCP 协议与 petstore API 交互，使用生成的处理器和工具。

查看 这里 的完整示例。