关键词

OpenAPIAPI集成LLM工具服务器生成SSE

使用说明

项目简介

本项目是一个命令行工具，旨在简化MCP服务器的创建过程。通过提供OpenAPI规范文件，开发者可以快速生成一个可运行的MCP服务器。该服务器将您的API接口转化为工具，供大型语言模型（LLM）通过模型上下文协议（MCP）调用。

主要功能点

  • OpenAPI规范到MCP服务器代码生成：根据OpenAPI规范自动生成MCP服务器的骨架代码。
  • SSE传输支持：使用Server-Sent Events (SSE) 协议进行MCP客户端与服务器之间的通信。
  • 工具自动创建：依据OpenAPI规范中定义的API端点，自动创建相应的工具，无需手动编写工具注册代码。
  • 基于@modelcontextprotocol/sdk：底层MCP协议实现基于官方的 '@modelcontextprotocol/sdk' 库，保证了协议的兼容性和标准性。

安装步骤

  1. 安装Node.js和npm/pnpm：确保您的开发环境中已安装Node.js和包管理器npm或pnpm。
  2. 全局安装CLI工具 (推荐使用npx，无需全局安装)： 可以直接使用 'npx' 运行该工具，无需全局安装。如果需要全局安装，请使用 'npm install -g @usemodel-dev/cli' 或 'pnpm install -g @usemodel-dev/cli'。

服务器配置

MCP客户端需要配置以下信息以连接到生成的MCP服务器。以下是配置示例（JSON格式）：

{
  "serverName": "OpenAPI-MCP Server",
  "command": "server",
  "args": [],
  "transport": "sse",
  "baseUrl": "http://localhost:3001/sse"
}

配置项说明：

  • 'serverName': 服务器名称，可以自定义，建议与您的API服务相关。
  • 'command': 启动服务器的命令，固定为 '"server"'。
  • 'args': 启动命令的参数，本服务器实现中无需参数，故为空数组 '[]'。
  • 'transport': 使用的传输协议，固定为 '"sse"' (Server-Sent Events)。
  • 'baseUrl': SSE协议的基础URL，默认为 'http://localhost:3001/sse'。请确保MCP客户端能够访问此URL。

服务器启动命令： 使用 'npx' 启动服务器 (无需预先构建):

npx -y -p @usemodel-dev/cli@latest server

或者，先构建再启动 (使用pnpm):

pnpm build
pnpm start

服务器默认运行在 'http://localhost:3001'。

基本使用方法

  1. 生成MCP服务器代码： 使用 'generate' 命令，并指定您的OpenAPI规范文件路径（YAML或JSON格式）。例如：

    npx -y -p @usemodel-dev/cli@latest cli generate path/to/your/openapi.yaml

    或者

    npx -y -p @usemodel-dev/cli@latest cli generate path/to/your/openapi.json

    这将在当前目录下生成MCP服务器相关文件。

  2. 运行MCP服务器： 在生成代码的目录下，执行服务器启动命令（见 服务器配置 部分）。

  3. 配置MCP客户端连接： 将 服务器配置 部分提供的JSON配置信息填入您的MCP客户端，确保客户端能够通过SSE协议连接到运行中的MCP服务器。服务器启动后，将根据您的OpenAPI规范提供相应的工具供LLM调用。

注意：服务器可能需要环境变量配置，例如API密钥等，请参考生成的服务器代码和'.env'文件进行配置。

信息

分类

开发者工具

访问项目