关键词

OpenAPIAPI 代理LLM 工具自然语言接口API 集成

使用说明

项目简介

OpenAPI MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现，它充当 OpenAPI (v3.1) API 的代理。该服务器可以将任何符合 OpenAPI 规范的 API 转换为 LLM 客户端（如 Claude Desktop）可以理解和调用的工具，从而实现通过自然语言与 API 进行交互。

主要功能点

  • OpenAPI 规范转换: 自动将符合 OpenAPI v3.1 规范的 API 转换为 MCP 工具，无需手动定义工具。
  • API 代理: 作为 OpenAPI API 的代理，接收 LLM 客户端的请求，并调用底层的 OpenAPI API。
  • 自然语言访问: 允许用户通过自然语言指令，使用 LLM 客户端与任何符合 OpenAPI 规范的 API 进行交互。
  • 文件上传支持: 支持 OpenAPI 规范中定义的文件上传功能，允许 LLM 客户端通过文件路径上传本地文件。
  • 易于集成: 可以轻松集成到任何支持 MCP 协议的 LLM 客户端，例如 Claude Desktop。

安装步骤

  1. 前提条件: 确保你的系统已安装 Node.js 和 npm 或 pnpm 包管理器。
  2. 下载代码: 克隆 GitHub 仓库到本地： 
    git clone https://github.com/MCP-Mirror/snaggle-ai_openapi-mcp-server.git
  3. 进入目录: 导航到项目目录： 
    cd snaggle-ai_openapi-mcp-server
  4. 安装依赖: 安装项目所需的依赖包： 
    pnpm install
    或者使用 npm: 
    npm install
  5. 构建项目: 编译 TypeScript 代码： 
    pnpm build
    或者使用 npm: 
    npm run build
  6. 全局链接 (可选): 为了方便使用 'npx' 命令直接运行，可以将项目链接到全局 'node_modules'： 
    npm link

服务器配置

要将 OpenAPI MCP Server 集成到 MCP 客户端（例如 Claude Desktop），你需要在客户端的配置文件中添加服务器配置。以 Claude Desktop 为例，你需要编辑 'claude_desktop_config.json' 文件，并在 'mcpServers' 字段下添加配置信息。

以下是一个配置示例，假设你的 OpenAPI 规范文件路径为 '/path/to/your/openapi.json'，并且你希望将此服务器命名为 "my-openapi-server"：

{
  "mcpServers": {
    "my-openapi-server": {
      "command": "npx",
      "args": ["openapi-mcp-server", "/path/to/your/openapi.json"]
    }
  }
}

配置参数说明:

  • 'server name': 'my-openapi-server' - 这是你在 MCP 客户端中识别和引用此服务器的名称，可以自定义设置。
  • 'command': '"npx"' - 指定用于启动服务器的命令。这里使用 'npx'，它允许你运行本地安装在 'node_modules' 中的可执行文件，前提是你已经执行了 'npm link' 或者你的环境变量配置正确。
  • 'args': '["openapi-mcp-server", "/path/to/your/openapi.json"]' - 传递给启动命令的参数列表。
    • '"openapi-mcp-server"': 这是实际执行的命令，对应于项目中的 'scripts/start-proxy.ts' 脚本，通过 'npm link' 或 'npx' 可以找到并执行它。
    • '"/path/to/your/openapi.json"': 你需要将此路径替换为你实际的 OpenAPI 规范文件路径。这可以是本地文件系统的绝对路径，也可以是一个可访问的 URL，指向 OpenAPI 规范的 JSON 文件。

请确保将 '/path/to/your/openapi.json' 替换为你 OpenAPI 规范文件的实际路径或 URL。 配置完成后，重启你的 MCP 客户端，它应该能够检测到并连接到新配置的 OpenAPI MCP Server。

基本使用方法

  1. 启动 MCP 客户端: 确保你的 MCP 客户端（例如 Claude Desktop）已启动，并已正确加载包含 OpenAPI MCP Server 配置的配置文件。
  2. 自然语言交互: 在 MCP 客户端中，你可以使用自然语言开始与你的 OpenAPI API 进行交互。客户端会将你的自然语言指令发送到 OpenAPI MCP Server。
  3. API 调用: OpenAPI MCP Server 会解析你的指令，并根据 OpenAPI 规范将其转换为对底层 API 的调用。
  4. 接收响应: API 的响应将通过 OpenAPI MCP Server 传递回 MCP 客户端，客户端会将结果以自然语言或结构化数据的形式呈现给你。

例如，如果你的 OpenAPI 规范描述了一个宠物商店 API，你可以向 Claude Desktop 提出类似这样的问题：

  • "列出所有可用的宠物"
  • "查找 ID 为 123 的宠物信息"
  • "创建一个新的宠物，名字叫 'Buddy'，种类是狗，年龄 3 岁"

客户端会将这些问题转化为对宠物商店 API 的相应调用，并返回结果。

信息

分类

网页与API

访问项目