项目简介

kumoctl是一个功能强大的命令行工具,旨在帮助开发者将现有的OpenAPI(也称为Swagger)API规范无缝转换为模型上下文协议(MCP)服务器,从而使大型语言模型(LLM)客户端(如Claude Desktop、Cursor等)能够直接理解并调用这些API。通过 kumoctl,您可以轻松地将任何OpenAPI定义的API操作暴露为LLM可用的工具,极大地简化了LLM与外部服务的集成。

主要功能点

  • API规范转换:自动解析OpenAPI 2.0或3.0规范文件(JSON或YAML),将其中定义的每个API操作(如GET、POST等)动态转换为LLM可调用的MCP工具。
  • 动态API调用:当LLM客户端通过MCP协议调用工具时,kumoctl会根据转换后的工具定义,动态构建并执行实际的HTTP请求到您的后端API,并将API响应返回给LLM。
  • 智能参数映射:自动从OpenAPI规范中提取路径参数、查询参数和请求体字段,生成LLM调用工具所需的JSON Schema输入格式。
  • LLM客户端自动配置:提供便捷的'configure'命令,支持自动为Claude Desktop和Cursor等主流LLM客户端设置MCP服务器配置,无需手动编辑复杂的JSON配置文件。
  • 跨平台支持:作为原生的命令行工具,可在Linux、macOS和Windows操作系统上轻松安装和运行。

安装步骤

Linux, macOS

打开终端,运行以下命令:

curl -fsSL https://get.kumolab.ai | sh

Windows

打开PowerShell,运行以下命令:

irm https://get.kumolab.ai/install.ps1 | iex

服务器配置

MCP客户端需要配置MCP服务器的启动命令和参数才能与其建立连接。kumoctl的'configure'命令正是为此设计,它会自动为您完成这一过程,无需手动编辑JSON配置文件。

例如,如果您想为名为 'weather-api' 的OpenAPI规范 'examples/openapi3-example.yaml' 配置Claude Desktop,您只需运行以下命令:

kumoctl configure examples/openapi3-example.yaml weather-api

这条命令会自动在您的Claude Desktop配置中添加一个名为 'weather-api' 的MCP服务器。该服务器将使用 kumoctl 来启动,并指定您的 'examples/openapi3-example.yaml' 作为API规范来源。

注意: 对于Claude Desktop,配置完成后通常需要重启客户端才能使更改生效。

基本使用方法

  1. 启动MCP服务器: 您可以使用'serve'命令从OpenAPI规范文件或URL直接启动一个MCP服务器。

    kumoctl serve <你的OpenAPI规范文件或URL>
    
    # 示例:
    kumoctl serve ./examples/openapi2-example.json
    kumoctl serve https://api.example.com/openapi.yaml
  2. 自动配置LLM客户端: 如上所述,使用'configure'命令可以自动为您的LLM客户端(如Claude Desktop或Cursor)设置MCP服务器。

    kumoctl configure <你的OpenAPI规范文件或URL> <服务器名称>
    
    # 示例:为Claude Desktop配置
    kumoctl configure examples/openapi3-example.yaml my-api-server
    
    # 示例:预览配置(不实际安装)
    kumoctl configure --dry-run examples/openapi3-example.yaml weather-api
    
    # 示例:为Cursor配置
    kumoctl configure --client=cursor examples/openapi2-example.json my-tools

    运行'configure'命令后,LLM客户端将能够发现并使用由您的OpenAPI规范提供的API工具。

信息

分类

开发者工具