Skip to content

Commit 3a07736

Browse files
committed
update doc
1 parent aaa15ab commit 3a07736

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# OpenAPI MCP Server
22

3-
Convert OpenAPI spec to MCP server, OpenAPI operations as tools
3+
Convert OpenAPI spec to MCP server, OpenAPI operations as tools.
4+
5+
This MCP server uses stdio transport.
46

57
## CLI Options
68

79
When running the MCP server, an OpenAPI spec is required. It can be either a file path or URL.
810

9-
The MCP server also provides options to filter operations to be converted as MCP tools. Filter conditions of the same type are combined using `OR`, while filter conditions of different types are combined using 'AND'.
11+
The MCP server also provides options to filter operations to be converted as MCP tools. Filter conditions of the same type are combined using `OR`, while filter conditions of different types are combined using `AND`.
1012

1113
Currently supported filter conditions:
1214

@@ -42,10 +44,18 @@ Run OpenAPI MCP server
4244

4345
## How to Run
4446

47+
### Standalone JAR file
48+
49+
Download latest [release JAR file](https://github.com/JavaAIDev/openapi-mcp-server/releases) and run it using `java -jar`.
50+
51+
```sh
52+
java -jar openapi-mcp-server-0.1.2-all.jar https://api.apis.guru/v2/specs/canada-holidays.ca/1.8.0/openapi.json
53+
```
54+
4555
### Container
4656

4757
Use Docker or Podman to run the container.
4858

4959
```sh
50-
podman run -i ghcr.io/javaaidev/openapi-mcp-server https://api.apis.guru/v2/specs/canada-holidays.ca/1.8.0/openapi.json
60+
docker run -i ghcr.io/javaaidev/openapi-mcp-server https://api.apis.guru/v2/specs/canada-holidays.ca/1.8.0/openapi.json
5161
```

0 commit comments

Comments
 (0)