@dilina0914/openapi-mcp 6.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.
Files changed (3) hide show
  1. package/README.md +53 -11
  2. package/dist/index.js +0 -0
  3. package/package.json +17 -16
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 Cloud ERP service metadata. Load specs, explore endpoints, extract schemas, and search operations through MCP tools.
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
  [![npm version](https://img.shields.io/npm/v/@dilina0914/openapi-mcp.svg)](https://www.npmjs.com/package/@dilina0914/openapi-mcp)
6
6
  [![Node.js](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen.svg)](https://nodejs.org/)
7
7
 
8
- ## Features
8
+ ## What's New in 8.0.0
9
9
 
10
- - **OpenAPI Parsing**: Load and parse OpenAPI 3.0 specifications from files or URLs
11
- - **7 Powerful Tools**: Complete API discovery, schema extraction, and operation search
12
- - **Endpoint Discovery**: List and filter API endpoints by tags, paths, or methods
13
- - **Schema Extraction**: Extract entity schemas with data types, required fields, and examples
14
- - **Operation Search**: Search operations by query, tag, or entity name
15
- - **Multi-Spec Support**: Load and manage multiple specs simultaneously
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@6.0.0"
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@6.0.0"
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@6.0.0"],
182
+ "args": ["-y", "@dilina0914/openapi-mcp@8.0.0"],
141
183
  "env": {
142
184
  "LOG_LEVEL": "info"
143
185
  }
package/dist/index.js CHANGED
File without changes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dilina0914/openapi-mcp",
3
- "version": "6.0.0",
3
+ "version": "8.0.0",
4
4
  "description": "MCP server for parsing OpenAPI specifications and extracting Cloud ERP service metadata",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -35,6 +35,17 @@
35
35
  "access": "public",
36
36
  "registry": "https://registry.npmjs.org/"
37
37
  },
38
+ "scripts": {
39
+ "build": "tsup",
40
+ "build:dev": "tsc",
41
+ "dev": "tsx watch src/index.ts",
42
+ "start": "node dist/index.js",
43
+ "test": "vitest",
44
+ "test:unit": "vitest run",
45
+ "typecheck": "tsc --noEmit",
46
+ "clean": "rimraf dist",
47
+ "prepublishOnly": "pnpm run build"
48
+ },
38
49
  "dependencies": {
39
50
  "@modelcontextprotocol/sdk": "^1.0.0",
40
51
  "@readme/openapi-parser": "^2.6.0",
@@ -43,27 +54,17 @@
43
54
  "yaml": "^2.8.2"
44
55
  },
45
56
  "devDependencies": {
57
+ "@ifs/logging": "workspace:*",
58
+ "@ifs/mcp-core": "workspace:*",
59
+ "@ifs/security": "workspace:*",
46
60
  "@types/node": "^20.14.0",
47
61
  "rimraf": "^5.0.7",
48
62
  "tsup": "^8.5.1",
49
63
  "tsx": "^4.15.4",
50
64
  "typescript": "^5.4.5",
51
- "vitest": "^1.6.0",
52
- "@ifs/logging": "1.0.0",
53
- "@ifs/security": "1.0.0",
54
- "@ifs/mcp-core": "1.0.0"
65
+ "vitest": "^1.6.0"
55
66
  },
56
67
  "peerDependencies": {
57
68
  "@modelcontextprotocol/sdk": "^1.0.0"
58
- },
59
- "scripts": {
60
- "build": "tsup",
61
- "build:dev": "tsc",
62
- "dev": "tsx watch src/index.ts",
63
- "start": "node dist/index.js",
64
- "test": "vitest",
65
- "test:unit": "vitest run",
66
- "typecheck": "tsc --noEmit",
67
- "clean": "rimraf dist"
68
69
  }
69
- }
70
+ }