@dilina0914/openapi-mcp 7.0.0 → 8.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,18 +1,60 @@
|
|
|
1
1
|
# OpenAPI MCP Server
|
|
2
2
|
|
|
3
|
-
A Model Context Protocol (MCP) server for parsing OpenAPI specifications and extracting
|
|
3
|
+
A Model Context Protocol (MCP) server for parsing OpenAPI 3.0 specifications and extracting API metadata. Provides 7 tools for spec management, endpoint discovery, and schema extraction - complementing code-first analysis when OpenAPI specifications are available.
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/@dilina0914/openapi-mcp)
|
|
6
6
|
[](https://nodejs.org/)
|
|
7
7
|
|
|
8
|
-
##
|
|
8
|
+
## What's New in 8.0.0
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
10
|
+
### Documentation & Setup
|
|
11
|
+
|
|
12
|
+
**📚 Complete Documentation Overhaul**
|
|
13
|
+
- Comprehensive README with accurate feature descriptions
|
|
14
|
+
- Clear integration instructions for all platforms
|
|
15
|
+
- Detailed troubleshooting guide
|
|
16
|
+
- Complete tool reference with examples
|
|
17
|
+
|
|
18
|
+
**🎯 Purpose Clarification**
|
|
19
|
+
- Designed for OpenAPI 3.0 specification parsing
|
|
20
|
+
- Complements code-first approach in `sar-test-mcp`
|
|
21
|
+
- Provides API metadata when OpenAPI specs are available
|
|
22
|
+
- 7 focused tools for spec management, endpoint discovery, and schema extraction
|
|
23
|
+
|
|
24
|
+
### Features
|
|
25
|
+
|
|
26
|
+
**📖 OpenAPI Parsing**
|
|
27
|
+
- Load specs from local files or URLs
|
|
28
|
+
- Support for JSON and YAML formats
|
|
29
|
+
- Automatic `$ref` resolution
|
|
30
|
+
- Multi-spec management
|
|
31
|
+
|
|
32
|
+
**🔍 Endpoint Discovery**
|
|
33
|
+
- List all API endpoints with filtering
|
|
34
|
+
- Filter by tags, paths, or methods
|
|
35
|
+
- Search operations by query or entity
|
|
36
|
+
- Get complete operation details
|
|
37
|
+
|
|
38
|
+
**📊 Schema Extraction**
|
|
39
|
+
- Extract entity schemas with data types
|
|
40
|
+
- Identify required fields and constraints
|
|
41
|
+
- Include default values and examples
|
|
42
|
+
- Resolve nested references
|
|
43
|
+
|
|
44
|
+
### Use Cases
|
|
45
|
+
|
|
46
|
+
1. **API Discovery**: When OpenAPI specs are available for IFS Cloud services
|
|
47
|
+
2. **Schema Validation**: Verify entity structures and field types
|
|
48
|
+
3. **Endpoint Mapping**: Map service endpoints to test requirements
|
|
49
|
+
4. **Documentation**: Extract API documentation for test planning
|
|
50
|
+
5. **Complementary Analysis**: Use alongside code analysis from `sar-test-mcp`
|
|
51
|
+
|
|
52
|
+
### Integration
|
|
53
|
+
|
|
54
|
+
Works seamlessly with `sar-test-mcp` and `http-capture-mcp`:
|
|
55
|
+
- `sar-test-mcp` for code-first analysis (primary approach)
|
|
56
|
+
- `openapi-mcp` for API spec metadata (when available)
|
|
57
|
+
- `http-capture-mcp` for browser verification (when needed)
|
|
16
58
|
|
|
17
59
|
## Prerequisites
|
|
18
60
|
|
|
@@ -67,7 +109,7 @@ Inside the `.vscode` folder, create a file named `mcp.json` with the following c
|
|
|
67
109
|
"command": "npx",
|
|
68
110
|
"args": [
|
|
69
111
|
"-y",
|
|
70
|
-
"@dilina0914/openapi-mcp@
|
|
112
|
+
"@dilina0914/openapi-mcp@8.0.0"
|
|
71
113
|
],
|
|
72
114
|
"env": {
|
|
73
115
|
"LOG_LEVEL": "info",
|
|
@@ -111,7 +153,7 @@ In the MCP settings, add a new server with the following configuration:
|
|
|
111
153
|
"command": "npx",
|
|
112
154
|
"args": [
|
|
113
155
|
"-y",
|
|
114
|
-
"@dilina0914/openapi-mcp@
|
|
156
|
+
"@dilina0914/openapi-mcp@8.0.0"
|
|
115
157
|
],
|
|
116
158
|
"env": {
|
|
117
159
|
"LOG_LEVEL": "info"
|
|
@@ -137,7 +179,7 @@ Add to your Claude Desktop configuration file:
|
|
|
137
179
|
"mcpServers": {
|
|
138
180
|
"openapi": {
|
|
139
181
|
"command": "npx",
|
|
140
|
-
"args": ["-y", "@dilina0914/openapi-mcp@
|
|
182
|
+
"args": ["-y", "@dilina0914/openapi-mcp@8.0.0"],
|
|
141
183
|
"env": {
|
|
142
184
|
"LOG_LEVEL": "info"
|
|
143
185
|
}
|
package/package.json
CHANGED