项目简介

本项目 'APIMatic OpenAPI 验证器 MCP 服务器' 是一个实现了 Model Context Protocol (MCP) 的服务器，它利用 APIMatic 的 API 来验证 OpenAPI (Swagger) 规范文件的有效性。通过集成到支持 MCP 协议的客户端（如 Claude Desktop），用户可以直接在客户端中使用此服务器提供的 OpenAPI 验证功能。

主要功能点

OpenAPI 规范验证: 支持 OpenAPI 2.0 和 3.0 规范文件的验证。
APIMatic API: 利用 APIMatic 强大的 API 验证能力，提供全面的验证结果。
JSON 和 YAML 支持: 支持 JSON 和 YAML 格式的 OpenAPI 规范文件。
MCP 协议: 遵循 Model Context Protocol，可以无缝集成到支持 MCP 的客户端。
工具集成: 作为一个 MCP 服务器，它将 OpenAPI 验证功能封装为工具，供 MCP 客户端调用。

安装步骤

克隆仓库

git clone https://github.com/apimatic/apimatic-validator-mcp.git
cd apimatic-validator-mcp

安装依赖

确保已安装 Node.js v18+，然后运行：
```
npm install
```
构建项目
```
npm run build
```

服务器配置

要将此 MCP 服务器集成到 MCP 客户端（例如 Claude Desktop），您需要配置客户端以启动并连接到此服务器。以下是 Claude Desktop 的配置示例，其他 MCP 客户端的配置方式类似。

首先，您需要在 APIMatic 注册并获取 API 密钥。然后，修改或创建 'claude_desktop_config.json' 配置文件。

配置文件路径：

Windows: '$env:AppData\Claude\claude_desktop_config.json'
macOS/Linux: '~/Library/Application\ Support/Claude/claude_desktop_config.json'

添加 MCP 服务器配置：

将以下 JSON 配置添加到 'claude_desktop_config.json' 文件中的 'mcpServers' 字段。请替换 '<Add your APIMatic token here>' 为您在 APIMatic 获取的 API 密钥，并将 'C:\PATH\TO\PARENT\FOLDER\build\index.js' 替换为 'build\index.js' 文件的实际路径。

{
    "mcpServers": {
        "APIMatic": {
            "command": "node",
            "args": [
                "C:\\PATH\\TO\\PARENT\\FOLDER\\build\\index.js"
            ],
            "env": {
                "APIMATIC_API_KEY": "<Add your APIMatic token here>"
            },
            "name": "APIMatic"  // 服务器名称，可自定义
        }
    }
}

配置参数说明：

'command': 启动 MCP 服务器的命令，这里使用 'node' 运行 Node.js 程序。
'args': 启动命令的参数，指向编译后的服务器入口文件 'build\index.js' 的路径。请务必根据实际文件路径进行修改。
'env': 环境变量配置。
- 'APIMATIC_API_KEY': 必须配置，您的 APIMatic API 密钥，用于访问 APIMatic 的 API 验证服务。
'name': 服务器在 MCP 客户端中显示的名称，可自定义。

配置完成后，在 Claude Desktop 等 MCP 客户端中，您应该能够看到集成的 'APIMatic' 服务器以及其提供的 'validate-openapi-using-apimatic' 工具。

基本使用方法

启动 MCP 客户端: 启动配置了 APIMatic MCP 服务器的 MCP 客户端（如 Claude Desktop）。
选择验证工具: 在客户端中找到并选择 'validate-openapi-using-apimatic' 工具。
提供 OpenAPI 文件: 在客户端的提示下，提供 OpenAPI 规范文件的内容（字符串形式）。
指定文件格式: 根据 OpenAPI 文件是 JSON 还是 YAML 格式，指定 'isYaml' 参数（true 或 false）。
获取验证结果: 执行工具后，服务器将调用 APIMatic API 验证 OpenAPI 文件，并将验证摘要以 JSON 格式返回给客户端。客户端将展示验证结果。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息