openapi-diff-mcp-server

MCP开发工具

提供方 DrSatyr

开发工具 未标注 会话登录 社区 / 第三方 Claude DesktopClaudeCursorCline
查看接入方式

openapi-diff-mcp-server MCP server interface for AI integration with [openapi-diff](https://github.com/OpenAPITools/openapi-diff) tool for comparing OpenAPI specifications. Features - TBD Usage Using MCP Server with Cloude Desktop 1. Build MCP server Jar using: `shell mvn clean install ` 2. To use the MCP server with Cloude Desktop, you need to configure it using a `claude_desktop_

一句话选型结论

按资料字段整理

openapi-diff-mcp-server 属于开发工具类 MCP 服务器,传输方式未标注,会话登录,可直接接入 Claude Desktop、Claude、Cursor 等,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类开发工具 传输方式未标注 鉴权会话登录 部署方式未标注
GitHub 星标 未标注 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

开发工具
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

openapidiffmcp server

安装与配置

未标注 会话登录
上游未给出传输方式
java -jar -Dmcp.transport=stdio /path/to/jar/openapi-diff-mcp-server-0.0.1-SNAPSHOT.jar

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    按官方文档确认运行环境(常见为 Node.js 或 Python),装好后再执行安装命令。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
代码与仓库操作

在对话里直接查代码、提 issue、走 PR,省掉来回切工具。

本地命令与脚本

把构建、测试、格式化这类重复命令交给模型执行。

接口联调与测试

让模型调你的接口、跑一遍用例,快速定位问题。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude Desktop、Claude、Cursor,换客户端不用重新研究配置。

先想清楚的地方

  • 使用前要准备好会话登录对应的凭据,并按最小权限配置。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在开发工具场景里让模型直接调用外部能力的人。
  • 已经在用 Claude Desktop、Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
openapi-diff-mcp-server当前 未标注 未标注 未标注 有 未标注
Git 838e2ec1 12 stdio · 本地进程 本地部署 有 2026-05-17
Markitdown MCP 2c653a5f 1 stdio · 本地进程 本地部署 有 2026-05-17
JavaGuide 未标注 stdio · 本地进程 本地部署 有 2026-04-11
awesome-claude-skills 未标注 stdio · 本地进程 本地部署 有 2026-04-26
Context7 831acf40 未标注 stdio · 本地进程 本地部署 有 2026-05-17

服务器档案

开发工具
字段来自项目仓库与公开索引,中文说明由本站标注
提供方DrSatyr上游标注的维护方 DrSatyr
分类开发工具本站按上游分类展示
连接方式未标注上游未给出传输方式
鉴权方式会话登录远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · java本地安装时用到的包标识与运行时
部署类型未标注上游给出的部署形态
最近核验未标注上游最后核验时间

详细介绍

16.1 KB
来自项目仓库与上游目录的原文,未做删改

OpenAPI-diff

Compare two OpenAPI specifications (3.x) and render the difference to HTML plain text, Markdown files, or JSON files.

Requirements

  • Java 8

Feature

  • Supports OpenAPI spec v3.0.
  • In-depth comparison of parameters, responses, endpoint, http method (GET,POST,PUT,DELETE...)
  • Supports swagger api Authorization
  • Render difference of property with Expression Language
  • HTML, Markdown, Asciidoc & JSON render

Maven

Available on Maven Central```xml
<dependency>
<groupId>org.openapitools.openapidiff</groupId>
<artifactId>openapi-diff-core</artifactId>
<version>${openapi-diff-version}</version>
</dependency>


# Homebrew
Available for Mac users on brew```bash
brew install openapi-diff

Usage instructions in Usage -> Command line

Docker

Available on Docker Hub as openapitools/openapi-diff.```bash

docker run openapitools/openapi-diff:latest

usage: openapi-diff <old> <new>
--asciidoc <file> export diff as asciidoc in given file
--debug Print debugging information
--error Print error information
--fail-on-changed Fail if API changed but is backward
compatible
--fail-on-incompatible Fail only if API changes broke backward
compatibility
--config-file Config file to override default behavior. Supported file formats: .yaml
--config-prop Config property to override default behavior with key:value format (e.g. my.prop:true)
-h,--help print this message
--header <property=value> use given header for authorisation
--html <file> export diff as html in given file
--info Print additional information
--json <file> export diff as json in given file
-l,--log <level> use given level for log (TRACE, DEBUG,
INFO, WARN, ERROR, OFF). Default: ERROR
--markdown <file> export diff as markdown in given file
--off No information printed
--query <property=value> use query param for authorisation
--state Only output diff state: no_changes,
incompatible, compatible
--text <file> export diff as text in given file
--trace be extra verbose
--version print the version information and exit
--warn Print warning information


## Build the image

This is only required if you want to try new changes in the Dockerfile of this project.```bash
docker build -t local-openapi-diff .

You can replace the local image name local-openapi-diff by any name of your choice.

Run an instance

In this example the $(pwd)/core/src/test/resources directory is mounted in the /specs directory of the container
in readonly mode (ro).```bash
docker run --rm -t \
-v $(pwd)/core/src/test/resources:/specs:ro \
openapitools/openapi-diff:latest /specs/path_1.yaml /specs/path_2.yaml


The remote name `openapitools/openapi-diff` can be replaced with `local-openapi-diff` or the name you gave to your local image.

# Usage

openapi-diff can read OpenAPI specs from JSON files or HTTP URLs.

## Command Line```bash
$ openapi-diff --help
usage: openapi-diff &lt;old&gt; &lt;new&gt;
    --asciidoc &lt;file&gt;           export diff as asciidoc in given file
    --debug                     Print debugging information
    --error                     Print error information
 -h,--help                      print this message
    --header &lt;property=value&gt;   use given header for authorisation
    --html &lt;file&gt;               export diff as html in given file
    --info                      Print additional information
    --json &lt;file&gt;               export diff as json in given file
 -l,--log &lt;level&gt;               use given level for log (TRACE, DEBUG,
                                INFO, WARN, ERROR, OFF). Default: ERROR
    --markdown &lt;file&gt;           export diff as markdown in given file
    --off                       No information printed
    --query &lt;property=value&gt;    use query param for authorisation
    --state                     Only output diff state: no_changes,
                                incompatible, compatible
    --fail-on-incompatible      Fail only if API changes broke backward compatibility
    --fail-on-changed           Fail if API changed but is backward compatible
    --config-file               Config file to override default behavior. Supported file formats: .yaml
    --config-prop               Config property to override default behavior with key:value format (e.g. my.prop:true)
    --trace                     be extra verbose
    --version                   print the version information and exit
    --warn                      Print warning information

Maven Plugin

Add openapi-diff to your POM to show diffs when you test your Maven project. You may opt to throw an error if you have broken backwards compatibility or if your API has changed.```xml
<plugin>
<groupId>org.openapitools.openapidiff</groupId>
<artifactId>openapi-diff-maven</artifactId>
<version>${openapi-diff-version}</version>
<executions>
<execution>
<goals>
<goal>diff</goal>
</goals>
<configuration>

    &lt;oldSpec&gt;https://petstore3.swagger.io/api/v3/openapi.json&lt;/oldSpec&gt;

    &lt;newSpec&gt;${project.basedir}/target/openapi.yaml&lt;/newSpec&gt;

    &lt;failOnIncompatible&gt;true&lt;/failOnIncompatible&gt;

    &lt;failOnChanged&gt;true&lt;/failOnChanged&gt;

    &lt;consoleOutputFileName&gt;${project.basedir}/../maven/target/diff.txt&lt;/consoleOutputFileName&gt;

    &lt;jsonOutputFileName&gt;${project.basedir}/../maven/target/diff.json&lt;/jsonOutputFileName&gt;

    &lt;markdownOutputFileName&gt;${project.basedir}/../maven/target/diff.md&lt;/markdownOutputFileName&gt;

    &lt;configFiles&gt;
      &lt;configFile&gt;my/config-file.yaml&lt;/configFile&gt;
    &lt;/configFiles&gt;

    &lt;configProps&gt;
      &lt;incompatible.response.enum.increased&gt;false&lt;/incompatible.response.enum.increased&gt;
    &lt;/configProps&gt;
  &lt;/configuration&gt;
&lt;/execution&gt;

</executions>
</plugin>


## Direct Invocation```java
public class Main {
    public static final String OPENAPI_DOC1 = &quot;petstore_v3_1.json&quot;;
    public static final String OPENAPI_DOC2 = &quot;petstore_v2_2.yaml&quot;;

    public static void main(String[] args) {
        ChangedOpenApi diff = OpenApiCompare.fromLocations(OPENAPI_DOC1, OPENAPI_DOC2);

        //...
    }
}

Path Matching while comparing two OpenAPI paths

Path matching controls how paths from the old and new specs are paired during comparison (PathsDiff.java). The default matcher (DefaultPathMatcher) obfuscates path parameter names, meaning /users/{id} matches /users/{userId}. The default matcher fails on ambiguous signatures if the spec contains a few paths semantically identical. In case this behaviour is not fitting your use case, you can implement your own matching strategy.

You can plug in a custom matcher via OpenApiDiffOptions implementing the PathMatcher interface:```java
OpenApiDiffOptions options = OpenApiDiffOptions
.builder()
.pathMatcher(new MyCustomPathMatcher())
.build();

ChangedOpenApi diff = OpenApiCompare.fromLocations(oldSpec, newSpec, null, options);


### Render difference

---
#### HTML```java
HtmlRender htmlRender = new HtmlRender(&quot;Changelog&quot;, &quot;http://deepoove.com/swagger-diff/stylesheets/demo.css&quot;);
FileOutputStream outputStream = new FileOutputStream(&quot;testDiff.html&quot;);
OutputStreamWriter outputStreamWriter = new OutputStreamWriter(outputStream);
htmlRender.render(diff, outputStreamWriter);

Markdown```java

MarkdownRender markdownRender = new MarkdownRender();
FileOutputStream outputStream = new FileOutputStream("testDiff.md");
OutputStreamWriter outputStreamWriter = new OutputStreamWriter(outputStream);
markdownRender.render(diff, outputStreamWriter);


#### Asciidoc```java
AsciidocRender asciidocRender = new AsciidocRender();
FileOutputStream outputStream = new FileOutputStream(&quot;testDiff.adoc&quot;);
OutputStreamWriter outputStreamWriter = new OutputStreamWriter(outputStream);
asciidocRender.render(diff, outputStreamWriter);

JSON```java

JsonRender jsonRender = new JsonRender();
FileOutputStream outputStream = new FileOutputStream("testDiff.json");
OutputStreamWriter outputStreamWriter = new OutputStreamWriter(outputStream);
jsonRender.render(diff, outputStreamWriter);


### Extensions

This project uses Java Service Provider Interface (SPI) so additional extensions can be added.

To build your own extension, you simply need to create a `src/main/resources/META-INF/services/org.openapitools.openapidiff.core.compare.ExtensionDiff` file with the full classname of your implementation.
Your class must also implement the `org.openapitools.openapidiff.core.compare.ExtensionDiff` interface.
Then, including your library with the `openapi-diff` module will cause it to be triggered automatically.

# Examples

### CLI Output```text
==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                             Swagger Petstore
--------------------------------------------------------------------------
--                              What&#x27;s New                              --
--------------------------------------------------------------------------
- GET    /pet/{petId}

--------------------------------------------------------------------------
--                            What&#x27;s Deleted                            --
--------------------------------------------------------------------------
- POST   /pet/{petId}

--------------------------------------------------------------------------
--                          What&#x27;s Deprecated                           --
--------------------------------------------------------------------------
- GET    /user/logout

--------------------------------------------------------------------------
--                            What&#x27;s Changed                            --
--------------------------------------------------------------------------
- PUT    /pet
  Request:
        - Deleted application/xml
        - Changed application/json
          Schema: Backward compatible
- POST   /pet
  Parameter:
    - Add tags in query
  Request:
        - Changed application/xml
          Schema: Backward compatible
        - Changed application/json
          Schema: Backward compatible
- GET    /pet/findByStatus
  Parameter:
    - Deprecated status in query
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/xml
          Schema: Broken compatibility
        - Changed application/json
          Schema: Broken compatibility
- GET    /pet/findByTags
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/xml
          Schema: Broken compatibility
        - Changed application/json
          Schema: Broken compatibility
- DELETE /pet/{petId}
  Parameter:
    - Add newHeaderParam in header
- POST   /pet/{petId}/uploadImage
  Parameter:
    - Changed petId in path
- POST   /user
  Request:
        - Changed application/json
          Schema: Backward compatible
- POST   /user/createWithArray
  Request:
        - Changed application/json
          Schema: Backward compatible
- POST   /user/createWithList
  Request:
        - Changed application/json
          Schema: Backward compatible
- GET    /user/login
  Parameter:
    - Delete password in query
- GET    /user/logout
- GET    /user/{username}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/xml
          Schema: Broken compatibility
        - Changed application/json
          Schema: Broken compatibility
- PUT    /user/{username}
  Request:
        - Changed application/json
          Schema: Backward compatible
--------------------------------------------------------------------------
--                                Result                                --
--------------------------------------------------------------------------
                 API changes broke backward compatibility
--------------------------------------------------------------------------

Markdown```markdown

What's New


  • GET /pet/{petId} Find pet by ID

What's Deleted


  • POST /pet/{petId} Updates a pet in the store with form data

What's Deprecated


  • GET /user/logout Logs out current logged in user session

What's Changed


  • PUT /pet Update an existing pet
    Request

    Deleted request body : [application/xml]
    Changed response : [application/json]
    
    • POST /pet Add a new pet to the store
      Parameter

      Add tags //add new query param demo
      Request

      Changed response : [application/xml]
      Changed response : [application/json]
      * GET /pet/findByStatus Finds Pets by status
      Parameter

    Return Type

    Changed response : [200] //successful operation
    
    • GET /pet/findByTags Finds Pets by tags
      Return Type

      Changed response : [200] //successful operation
      * DELETE /pet/{petId} Deletes a pet
      Parameter

      Add newHeaderParam
      * POST /pet/{petId}/uploadImage uploads an image for pet
      Parameter

      petId Notes ID of pet to update change into ID of pet to update, default false
      * POST /user Create user
      Request

      Changed response : [application/json]
      * POST /user/createWithArray Creates list of users with given input array
      Request

      Changed response : [application/json]
      * POST /user/createWithList Creates list of users with given input array
      Request

      Changed response : [application/json]
      * GET /user/login Logs user into the system
      Parameter

      Delete password //The password for login in clear text
      * GET /user/logout Logs out current logged in user session
      * PUT /user/{username} Updated user
      Request

      Changed response : [application/json]
      * GET /user/{username} Get user by user name
      Return Type

      Changed response : [200] //successful operation


### JSON```json
{
    &quot;changedElements&quot;: [...],
    &quot;changedExtensions&quot;: null,
    &quot;changedOperations&quot;: [...],
    &quot;compatible&quot;: false,
    &quot;deprecatedEndpoints&quot;: [...],
    &quot;different&quot;: true,
    &quot;incompatible&quot;: true,
    &quot;missingEndpoints&quot;: [...],
    &quot;newEndpoints&quot;: [
        {
            &quot;method&quot;: &quot;GET&quot;,
            &quot;operation&quot;: {
                &quot;callbacks&quot;: null,
                &quot;deprecated&quot;: null,
                &quot;description&quot;: &quot;Returns a single pet&quot;,
                &quot;extensions&quot;: null,
                &quot;externalDocs&quot;: null,
                &quot;operationId&quot;: &quot;getPetById&quot;,
                &quot;parameters&quot;: [
                    {
                        &quot;$ref&quot;: null,
                        &quot;allowEmptyValue&quot;: null,
                        &quot;allowReserved&quot;: null,
                        &quot;content&quot;: null,
                        &quot;deprecated&quot;: null,
                        &quot;description&quot;: &quot;ID of pet to return&quot;,
                        &quot;example&quot;: null,
                        &quot;examples&quot;: null,
                        &quot;explode&quot;: false,
                        &quot;extensions&quot;: null,
                        &quot;in&quot;: &quot;path&quot;,
                        &quot;name&quot;: &quot;petId&quot;,
                        &quot;required&quot;: true,
                        &quot;schema&quot;: {...},
                        &quot;style&quot;: &quot;SIMPLE&quot;
                    }
                ],
                &quot;requestBody&quot;: null,
                &quot;responses&quot;: {...},
                &quot;security&quot;: [
                    {
                        &quot;api_key&quot;: []
                    }
                ],
                &quot;servers&quot;: null,
                &quot;summary&quot;: &quot;Find pet by ID&quot;,
                &quot;tags&quot;: [
                    &quot;pet&quot;
                ]
            },
            &quot;path&quot;: null,
            &quot;pathUrl&quot;: &quot;/pet/{petId}&quot;,
            &quot;summary&quot;: &quot;Find pet by ID&quot;
        }
    ],
    &quot;newSpecOpenApi&quot;: {...},
    &quot;oldSpecOpenApi&quot;: {...},
    &quot;unchanged&quot;: false
}

License

openapi-diff is released under the Apache License 2.0.

Thanks

  • Adarsh Sharma / adarshsharma
  • Quentin Desramé / quen2404
  • Sayi for his project swagger-diff
    which was a source of inspiration for this tool

常见问题

7 问
答案由本站依据条目字段整理,不引用上游原文
openapi-diff-mcp-server 怎么安装?

在客户端按下面的安装命令接入:java -jar -Dmcp.transport=stdio /path/to/jar/openapi-diff-mcp-server-0.0.1-SNAPSHOT.jar。装完在客户端配置里引用同一个包或端点。

openapi-diff-mcp-server 怎么在 Claude Desktop、Claude、Cursor 里配置?

它的传输方式未标注,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

openapi-diff-mcp-server 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

openapi-diff-mcp-server 需要 API Key 吗?

资料标注需要会话登录认证,使用前准备好对应凭据,并按最小权限配置。

openapi-diff-mcp-server 支持哪些客户端?

资料标注支持 Claude Desktop、Claude、Cursor、Cline、Codex、Zed;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

openapi-diff-mcp-server 能提供哪些能力?

资料显示能力标签包括 openapi、diff、mcp server、ai integration。具体工具清单以官方文档为准。

openapi-diff-mcp-server 需要什么运行环境?

运行时为 java。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 未标注。