openapi-docs-mcp 0.1.3 → 0.1.5
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 +391 -390
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +15 -12
- package/dist/cli.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/mcp/server.d.ts.map +1 -1
- package/dist/mcp/server.js +27 -1
- package/dist/mcp/server.js.map +1 -1
- package/dist/openapi/diagnostics.d.ts +3 -0
- package/dist/openapi/diagnostics.d.ts.map +1 -0
- package/dist/openapi/diagnostics.js +24 -0
- package/dist/openapi/diagnostics.js.map +1 -0
- package/dist/openapi/loader.d.ts.map +1 -1
- package/dist/openapi/loader.js +61 -45
- package/dist/openapi/loader.js.map +1 -1
- package/dist/openapi/normalize.d.ts +7 -0
- package/dist/openapi/normalize.d.ts.map +1 -0
- package/dist/openapi/normalize.js +203 -0
- package/dist/openapi/normalize.js.map +1 -0
- package/dist/openapi/operations.d.ts.map +1 -1
- package/dist/openapi/operations.js +19 -1
- package/dist/openapi/operations.js.map +1 -1
- package/dist/service.d.ts +16 -4
- package/dist/service.d.ts.map +1 -1
- package/dist/service.js +32 -1
- package/dist/service.js.map +1 -1
- package/dist/types.d.ts +11 -0
- package/dist/types.d.ts.map +1 -1
- package/package.json +41 -41
|
@@ -14,6 +14,7 @@ export function extractOperations(document) {
|
|
|
14
14
|
const paths = asObject(root.paths);
|
|
15
15
|
if (!paths)
|
|
16
16
|
return [];
|
|
17
|
+
const operationIdCounts = countOperationIds(paths);
|
|
17
18
|
const operations = [];
|
|
18
19
|
for (const [path, rawPathItem] of Object.entries(paths)) {
|
|
19
20
|
const pathItem = asObject(rawPathItem);
|
|
@@ -25,7 +26,9 @@ export function extractOperations(document) {
|
|
|
25
26
|
continue;
|
|
26
27
|
const operationId = asString(operation.operationId);
|
|
27
28
|
const entry = {
|
|
28
|
-
id: operationId
|
|
29
|
+
id: operationId && operationIdCounts.get(operationId) === 1
|
|
30
|
+
? operationId
|
|
31
|
+
: `${method.toUpperCase()} ${path}`,
|
|
29
32
|
method,
|
|
30
33
|
path,
|
|
31
34
|
tags: asStringArray(operation.tags),
|
|
@@ -45,6 +48,21 @@ export function extractOperations(document) {
|
|
|
45
48
|
}
|
|
46
49
|
return operations.sort((a, b) => a.path.localeCompare(b.path) || a.method.localeCompare(b.method));
|
|
47
50
|
}
|
|
51
|
+
function countOperationIds(paths) {
|
|
52
|
+
const counts = new Map();
|
|
53
|
+
for (const rawPathItem of Object.values(paths)) {
|
|
54
|
+
const pathItem = asObject(rawPathItem);
|
|
55
|
+
if (!pathItem)
|
|
56
|
+
continue;
|
|
57
|
+
for (const method of HTTP_METHODS) {
|
|
58
|
+
const operation = asObject(pathItem[method]);
|
|
59
|
+
const operationId = asString(operation?.operationId);
|
|
60
|
+
if (operationId)
|
|
61
|
+
counts.set(operationId, (counts.get(operationId) ?? 0) + 1);
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
return counts;
|
|
65
|
+
}
|
|
48
66
|
export function findOperation(operations, input) {
|
|
49
67
|
if (input.id) {
|
|
50
68
|
const exact = operations.find((entry) => entry.id === input.id);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"operations.js","sourceRoot":"","sources":["../../src/openapi/operations.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,YAAY,GAA0B;IACjD,KAAK;IACL,KAAK;IACL,MAAM;IACN,QAAQ;IACR,SAAS;IACT,MAAM;IACN,OAAO;IACP,OAAO;IACP,OAAO;CACR,CAAC;AAEF,MAAM,UAAU,iBAAiB,CAAC,QAA0B;IAC1D,MAAM,IAAI,GAAG,QAAiC,CAAC;IAC/C,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnC,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IAEtB,MAAM,UAAU,GAAqB,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxD,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ;YAAE,SAAS;QAExB,KAAK,MAAM,MAAM,IAAI,YAAY,EAAE,CAAC;YAClC,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7C,IAAI,CAAC,SAAS;gBAAE,SAAS;YAEzB,MAAM,WAAW,GAAG,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YACpD,MAAM,KAAK,GAAmB;gBAC5B,EAAE,
|
|
1
|
+
{"version":3,"file":"operations.js","sourceRoot":"","sources":["../../src/openapi/operations.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,YAAY,GAA0B;IACjD,KAAK;IACL,KAAK;IACL,MAAM;IACN,QAAQ;IACR,SAAS;IACT,MAAM;IACN,OAAO;IACP,OAAO;IACP,OAAO;CACR,CAAC;AAEF,MAAM,UAAU,iBAAiB,CAAC,QAA0B;IAC1D,MAAM,IAAI,GAAG,QAAiC,CAAC;IAC/C,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnC,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IAEtB,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IACnD,MAAM,UAAU,GAAqB,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxD,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ;YAAE,SAAS;QAExB,KAAK,MAAM,MAAM,IAAI,YAAY,EAAE,CAAC;YAClC,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7C,IAAI,CAAC,SAAS;gBAAE,SAAS;YAEzB,MAAM,WAAW,GAAG,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YACpD,MAAM,KAAK,GAAmB;gBAC5B,EAAE,EACA,WAAW,IAAI,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC;oBACrD,CAAC,CAAC,WAAW;oBACb,CAAC,CAAC,GAAG,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE;gBACvC,MAAM;gBACN,IAAI;gBACJ,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC;gBACnC,SAAS;gBACT,QAAQ;aACT,CAAC;YACF,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAC5C,MAAM,WAAW,GAAG,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YACpD,IAAI,OAAO;gBAAE,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;YACrC,IAAI,WAAW;gBAAE,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;YACjD,IAAI,WAAW;gBAAE,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;YACjD,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAC9B,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CACjE,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAiB;IAC1C,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/C,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ;YAAE,SAAS;QACxB,KAAK,MAAM,MAAM,IAAI,YAAY,EAAE,CAAC;YAClC,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7C,MAAM,WAAW,GAAG,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YACrD,IAAI,WAAW;gBAAE,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/E,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,UAA4B,EAC5B,KAAsD;IAEtD,IAAI,KAAK,CAAC,EAAE,EAAE,CAAC;QACb,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC;QAChE,IAAI,KAAK;YAAE,OAAO,KAAK,CAAC;IAC1B,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC;QAC3C,OAAO,UAAU,CAAC,IAAI,CACpB,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,CAC7E,CAAC;IACJ,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACzE,CAAC,CAAE,KAAoB;QACvB,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACtG,CAAC"}
|
package/dist/service.d.ts
CHANGED
|
@@ -1,13 +1,25 @@
|
|
|
1
|
-
import type { OpenApiContext, SchemaFormatOptions, SearchOptions } from "./types.js";
|
|
1
|
+
import type { JsonObject, OpenApiContext, SchemaFormatOptions, SearchOptions } from "./types.js";
|
|
2
|
+
export interface ReloadResult extends JsonObject {
|
|
3
|
+
source: string;
|
|
4
|
+
version: string;
|
|
5
|
+
previousOperationCount: number;
|
|
6
|
+
operationCount: number;
|
|
7
|
+
validationWarnings: OpenApiContext["validationWarnings"];
|
|
8
|
+
}
|
|
9
|
+
export type OpenApiReloader = () => Promise<OpenApiContext>;
|
|
2
10
|
export declare class OpenApiService {
|
|
3
|
-
readonly
|
|
4
|
-
|
|
11
|
+
private readonly reloader?;
|
|
12
|
+
context: OpenApiContext;
|
|
13
|
+
private reloadPromise;
|
|
14
|
+
constructor(context: OpenApiContext, reloader?: OpenApiReloader | undefined);
|
|
15
|
+
reload(): Promise<ReloadResult>;
|
|
16
|
+
private performReload;
|
|
5
17
|
search(options: SearchOptions): import("./types.js").SearchResult[];
|
|
6
18
|
getApi(input: {
|
|
7
19
|
id?: string;
|
|
8
20
|
path?: string;
|
|
9
21
|
method?: string;
|
|
10
|
-
}, options?: SchemaFormatOptions):
|
|
22
|
+
}, options?: SchemaFormatOptions): JsonObject | undefined;
|
|
11
23
|
getSchema(name: string, options?: SchemaFormatOptions): {
|
|
12
24
|
name: string;
|
|
13
25
|
schema: unknown;
|
package/dist/service.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EACd,mBAAmB,EACnB,aAAa,EACd,MAAM,YAAY,CAAC;AAMpB,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,cAAc,CAAC,oBAAoB,CAAC,CAAC;CAC1D;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;AAE5D,qBAAa,cAAc;IAIY,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAH/D,OAAO,EAAE,cAAc,CAAC;IACxB,OAAO,CAAC,aAAa,CAAoC;IAEzD,YAAY,OAAO,EAAE,cAAc,EAAmB,QAAQ,CAAC,EAAE,eAAe,YAAA,EAE/E;IAEK,MAAM,IAAI,OAAO,CAAC,YAAY,CAAC,CAapC;YAEa,aAAa;IAa3B,MAAM,CAAC,OAAO,EAAE,aAAa,uCAE5B;IAED,MAAM,CACJ,KAAK,EAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,EACtD,OAAO,GAAE,mBAAwB,0BAMlC;IAED,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;;;kBAKxD;IAED,UAAU;;;QAST;IAED,WAAW,aAEV;CACF"}
|
package/dist/service.js
CHANGED
|
@@ -3,10 +3,41 @@ import { findSchema, formatSchema, listSchemaNames } from "./formatter/schema.js
|
|
|
3
3
|
import { findOperation } from "./openapi/operations.js";
|
|
4
4
|
import { searchOperations } from "./search/search.js";
|
|
5
5
|
export class OpenApiService {
|
|
6
|
+
reloader;
|
|
6
7
|
context;
|
|
7
|
-
|
|
8
|
+
reloadPromise;
|
|
9
|
+
constructor(context, reloader) {
|
|
10
|
+
this.reloader = reloader;
|
|
8
11
|
this.context = context;
|
|
9
12
|
}
|
|
13
|
+
async reload() {
|
|
14
|
+
if (!this.reloader) {
|
|
15
|
+
throw new Error("Document reload is not configured for this service");
|
|
16
|
+
}
|
|
17
|
+
if (this.reloadPromise)
|
|
18
|
+
return await this.reloadPromise;
|
|
19
|
+
const promise = this.performReload();
|
|
20
|
+
this.reloadPromise = promise;
|
|
21
|
+
try {
|
|
22
|
+
return await promise;
|
|
23
|
+
}
|
|
24
|
+
finally {
|
|
25
|
+
if (this.reloadPromise === promise)
|
|
26
|
+
this.reloadPromise = undefined;
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
async performReload() {
|
|
30
|
+
const previousOperationCount = this.context.operations.length;
|
|
31
|
+
const context = await this.reloader();
|
|
32
|
+
this.context = context;
|
|
33
|
+
return {
|
|
34
|
+
source: context.source,
|
|
35
|
+
version: context.version,
|
|
36
|
+
previousOperationCount,
|
|
37
|
+
operationCount: context.operations.length,
|
|
38
|
+
validationWarnings: context.validationWarnings,
|
|
39
|
+
};
|
|
40
|
+
}
|
|
10
41
|
search(options) {
|
|
11
42
|
return searchOperations(this.context.operations, options);
|
|
12
43
|
}
|
package/dist/service.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAClF,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAYtD,MAAM,OAAO,cAAc;IAI6B,QAAQ;IAH9D,OAAO,CAAiB;IAChB,aAAa,CAAoC;IAEzD,YAAY,OAAuB,EAAmB,QAA0B;wBAA1B,QAAQ;QAC5D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,MAAM;QACV,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,CAAC;QACD,IAAI,IAAI,CAAC,aAAa;YAAE,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC;QAExD,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC;QAC7B,IAAI,CAAC;YACH,OAAO,MAAM,OAAO,CAAC;QACvB,CAAC;gBAAS,CAAC;YACT,IAAI,IAAI,CAAC,aAAa,KAAK,OAAO;gBAAE,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QACrE,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,aAAa;QACzB,MAAM,sBAAsB,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC;QAC9D,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAS,EAAE,CAAC;QACvC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO;YACL,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,sBAAsB;YACtB,cAAc,EAAE,OAAO,CAAC,UAAU,CAAC,MAAM;YACzC,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;SAC/C,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,OAAsB;QAC3B,OAAO,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,CACJ,KAAsD,EACtD,OAAO,GAAwB,EAAE;QAEjC,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QAChE,OAAO,SAAS;YACd,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC;YAC5D,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAED,SAAS,CAAC,IAAY,EAAE,OAAO,GAAwB,EAAE;QACvD,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACvD,OAAO,MAAM,KAAK,SAAS;YACzB,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IAC7E,CAAC;IAED,UAAU;QACR,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;QACzC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YAChD,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;YACnE,KAAK,MAAM,GAAG,IAAI,IAAI;gBAAE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACtE,CAAC;QACD,OAAO,CAAC,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;aACzB,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;aAC3D,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAClD,CAAC;IAED,WAAW;QACT,OAAO,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;CACF"}
|
package/dist/types.d.ts
CHANGED
|
@@ -38,6 +38,17 @@ export interface OpenApiContext {
|
|
|
38
38
|
message: string;
|
|
39
39
|
count: number;
|
|
40
40
|
}>;
|
|
41
|
+
diagnostics: OpenApiDiagnostic[];
|
|
42
|
+
}
|
|
43
|
+
export type DiagnosticSeverity = "repair" | "warning" | "skipped";
|
|
44
|
+
export type DiagnosticCode = "ref_repaired" | "ref_unresolved" | "ref_ambiguous" | "path_skipped" | "operation_skipped" | "responses_added" | "duplicate_operation_id" | "validation_warning";
|
|
45
|
+
export interface OpenApiDiagnostic {
|
|
46
|
+
severity: DiagnosticSeverity;
|
|
47
|
+
code: DiagnosticCode;
|
|
48
|
+
path: string;
|
|
49
|
+
message: string;
|
|
50
|
+
original?: unknown;
|
|
51
|
+
replacement?: unknown;
|
|
41
52
|
}
|
|
42
53
|
export interface SchemaFormatOptions {
|
|
43
54
|
maxDepth?: number;
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAErD,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACjD,MAAM,MAAM,UAAU,GAClB,KAAK,GACL,KAAK,GACL,MAAM,GACN,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,CAAC;AAEZ,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,SAAS,EAAE,UAAU,CAAC;IACtB,QAAQ,EAAE,UAAU,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,cAAc,EAAE,CAAC;IAC7B,kBAAkB,EAAE,KAAK,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAErD,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACjD,MAAM,MAAM,UAAU,GAClB,KAAK,GACL,KAAK,GACL,MAAM,GACN,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,CAAC;AAEZ,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,SAAS,EAAE,UAAU,CAAC;IACtB,QAAQ,EAAE,UAAU,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,cAAc,EAAE,CAAC;IAC7B,kBAAkB,EAAE,KAAK,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC9D,WAAW,EAAE,iBAAiB,EAAE,CAAC;CAClC;AAED,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;AAElE,MAAM,MAAM,cAAc,GACtB,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,cAAc,GACd,mBAAmB,GACnB,iBAAiB,GACjB,wBAAwB,GACxB,oBAAoB,CAAC;AAEzB,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}
|
package/package.json
CHANGED
|
@@ -1,41 +1,41 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "openapi-docs-mcp",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "A vendor-neutral MCP server for searching and understanding OpenAPI documents.",
|
|
5
|
-
"type": "module",
|
|
6
|
-
"bin": {
|
|
7
|
-
"openapi-docs-mcp": "dist/cli.js"
|
|
8
|
-
},
|
|
9
|
-
"exports": {
|
|
10
|
-
".": "./dist/index.js"
|
|
11
|
-
},
|
|
12
|
-
"files": [
|
|
13
|
-
"dist",
|
|
14
|
-
"README.md",
|
|
15
|
-
"LICENSE"
|
|
16
|
-
],
|
|
17
|
-
"scripts": {
|
|
18
|
-
"build": "tsc -p tsconfig.build.json",
|
|
19
|
-
"dev": "tsx src/cli.ts",
|
|
20
|
-
"test": "vitest run",
|
|
21
|
-
"test:watch": "vitest",
|
|
22
|
-
"typecheck": "tsc --noEmit"
|
|
23
|
-
},
|
|
24
|
-
"engines": {
|
|
25
|
-
"node": ">=20"
|
|
26
|
-
},
|
|
27
|
-
"license": "MIT",
|
|
28
|
-
"dependencies": {
|
|
29
|
-
"@modelcontextprotocol/server": "^2.0.0",
|
|
30
|
-
"@scalar/openapi-parser": "^0.28.12",
|
|
31
|
-
"@scalar/openapi-types": "^0.9.4",
|
|
32
|
-
"zod": "^4.4.3"
|
|
33
|
-
},
|
|
34
|
-
"devDependencies": {
|
|
35
|
-
"@modelcontextprotocol/client": "^2.0.0",
|
|
36
|
-
"@types/node": "^26.2.0",
|
|
37
|
-
"tsx": "^4.23.12",
|
|
38
|
-
"typescript": "^7.0.2",
|
|
39
|
-
"vitest": "^4.1.10"
|
|
40
|
-
}
|
|
41
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "openapi-docs-mcp",
|
|
3
|
+
"version": "0.1.5",
|
|
4
|
+
"description": "A vendor-neutral MCP server for searching and understanding OpenAPI documents.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"bin": {
|
|
7
|
+
"openapi-docs-mcp": "dist/cli.js"
|
|
8
|
+
},
|
|
9
|
+
"exports": {
|
|
10
|
+
".": "./dist/index.js"
|
|
11
|
+
},
|
|
12
|
+
"files": [
|
|
13
|
+
"dist",
|
|
14
|
+
"README.md",
|
|
15
|
+
"LICENSE"
|
|
16
|
+
],
|
|
17
|
+
"scripts": {
|
|
18
|
+
"build": "tsc -p tsconfig.build.json",
|
|
19
|
+
"dev": "tsx src/cli.ts",
|
|
20
|
+
"test": "vitest run",
|
|
21
|
+
"test:watch": "vitest",
|
|
22
|
+
"typecheck": "tsc --noEmit"
|
|
23
|
+
},
|
|
24
|
+
"engines": {
|
|
25
|
+
"node": ">=20"
|
|
26
|
+
},
|
|
27
|
+
"license": "MIT",
|
|
28
|
+
"dependencies": {
|
|
29
|
+
"@modelcontextprotocol/server": "^2.0.0",
|
|
30
|
+
"@scalar/openapi-parser": "^0.28.12",
|
|
31
|
+
"@scalar/openapi-types": "^0.9.4",
|
|
32
|
+
"zod": "^4.4.3"
|
|
33
|
+
},
|
|
34
|
+
"devDependencies": {
|
|
35
|
+
"@modelcontextprotocol/client": "^2.0.0",
|
|
36
|
+
"@types/node": "^26.2.0",
|
|
37
|
+
"tsx": "^4.23.12",
|
|
38
|
+
"typescript": "^7.0.2",
|
|
39
|
+
"vitest": "^4.1.10"
|
|
40
|
+
}
|
|
41
|
+
}
|