openapi-docs-mcp 0.1.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 (43) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +253 -0
  3. package/dist/cli.d.ts +10 -0
  4. package/dist/cli.d.ts.map +1 -0
  5. package/dist/cli.js +92 -0
  6. package/dist/cli.js.map +1 -0
  7. package/dist/formatter/operation.d.ts +4 -0
  8. package/dist/formatter/operation.d.ts.map +1 -0
  9. package/dist/formatter/operation.js +135 -0
  10. package/dist/formatter/operation.js.map +1 -0
  11. package/dist/formatter/schema.d.ts +7 -0
  12. package/dist/formatter/schema.d.ts.map +1 -0
  13. package/dist/formatter/schema.js +142 -0
  14. package/dist/formatter/schema.js.map +1 -0
  15. package/dist/index.d.ts +6 -0
  16. package/dist/index.d.ts.map +1 -0
  17. package/dist/index.js +5 -0
  18. package/dist/index.js.map +1 -0
  19. package/dist/mcp/server.d.ts +4 -0
  20. package/dist/mcp/server.d.ts.map +1 -0
  21. package/dist/mcp/server.js +89 -0
  22. package/dist/mcp/server.js.map +1 -0
  23. package/dist/openapi/loader.d.ts +9 -0
  24. package/dist/openapi/loader.d.ts.map +1 -0
  25. package/dist/openapi/loader.js +125 -0
  26. package/dist/openapi/loader.js.map +1 -0
  27. package/dist/openapi/operations.d.ts +13 -0
  28. package/dist/openapi/operations.d.ts.map +1 -0
  29. package/dist/openapi/operations.js +71 -0
  30. package/dist/openapi/operations.js.map +1 -0
  31. package/dist/search/search.d.ts +4 -0
  32. package/dist/search/search.d.ts.map +1 -0
  33. package/dist/search/search.js +117 -0
  34. package/dist/search/search.js.map +1 -0
  35. package/dist/service.d.ts +21 -0
  36. package/dist/service.d.ts.map +1 -0
  37. package/dist/service.js +40 -0
  38. package/dist/service.js.map +1 -0
  39. package/dist/types.d.ts +46 -0
  40. package/dist/types.d.ts.map +1 -0
  41. package/dist/types.js +2 -0
  42. package/dist/types.js.map +1 -0
  43. package/package.json +41 -0
@@ -0,0 +1,117 @@
1
+ const FIELD_WEIGHTS = {
2
+ summary: 10,
3
+ tags: 8,
4
+ path: 6,
5
+ description: 4,
6
+ operationId: 2,
7
+ };
8
+ export function searchOperations(operations, options) {
9
+ const query = normalize(options.query);
10
+ const method = options.method?.toLowerCase();
11
+ const tag = options.tag ? normalize(options.tag) : undefined;
12
+ const limit = Math.min(Math.max(options.limit ?? 10, 1), 50);
13
+ return operations
14
+ .filter((entry) => !method || entry.method === method)
15
+ .filter((entry) => !tag || entry.tags.some((value) => normalize(value) === tag))
16
+ .map((entry) => scoreEntry(entry, query))
17
+ .filter((result) => query.length === 0 || result.score > 0)
18
+ .sort((a, b) => b.score - a.score || a.id.localeCompare(b.id))
19
+ .slice(0, limit);
20
+ }
21
+ function scoreEntry(entry, query) {
22
+ const fields = {
23
+ summary: entry.summary ?? "",
24
+ tags: entry.tags.join(" "),
25
+ path: entry.path,
26
+ description: entry.description ?? "",
27
+ operationId: entry.operationId ?? "",
28
+ };
29
+ let score = 0;
30
+ const matchedFields = [];
31
+ for (const [field, weight] of Object.entries(FIELD_WEIGHTS)) {
32
+ const similarity = fieldScore(query, normalize(fields[field]));
33
+ if (similarity > 0) {
34
+ score += similarity * weight;
35
+ matchedFields.push(field);
36
+ }
37
+ }
38
+ const queryCoverage = calculateQueryCoverage(query, Object.values(fields));
39
+ score *= queryCoverage ** 3;
40
+ const result = {
41
+ id: entry.id,
42
+ method: entry.method.toUpperCase(),
43
+ path: entry.path,
44
+ tags: entry.tags,
45
+ score: Number(score.toFixed(3)),
46
+ queryCoverage: Number(queryCoverage.toFixed(3)),
47
+ matchedFields,
48
+ };
49
+ if (entry.summary !== undefined)
50
+ result.summary = entry.summary;
51
+ if (entry.description !== undefined)
52
+ result.description = entry.description;
53
+ return result;
54
+ }
55
+ function calculateQueryCoverage(query, fields) {
56
+ if (!query)
57
+ return 1;
58
+ const queryGrams = new Set(toGrams(query));
59
+ if (queryGrams.size === 0)
60
+ return 0;
61
+ const fieldGrams = new Set(fields.flatMap((field) => toGrams(normalize(field))));
62
+ let matches = 0;
63
+ for (const gram of queryGrams) {
64
+ if (fieldGrams.has(gram))
65
+ matches += 1;
66
+ }
67
+ return matches / queryGrams.size;
68
+ }
69
+ function fieldScore(query, field) {
70
+ if (!query || !field)
71
+ return 0;
72
+ if (query === field)
73
+ return 1;
74
+ if (field.includes(query))
75
+ return 0.86 + Math.min(query.length / field.length, 1) * 0.1;
76
+ const terms = splitTerms(query);
77
+ const matchedTerms = terms.filter((term) => field.includes(term));
78
+ const termScore = terms.length > 0 ? matchedTerms.length / terms.length : 0;
79
+ const gramScore = diceCoefficient(toGrams(query), toGrams(field));
80
+ const score = Math.max(termScore * 0.8, gramScore * 0.7);
81
+ return score >= 0.08 ? score : 0;
82
+ }
83
+ export function normalize(value) {
84
+ return value
85
+ .normalize("NFKC")
86
+ .toLocaleLowerCase()
87
+ .replace(/[\s\p{P}\p{S}_]+/gu, "");
88
+ }
89
+ function splitTerms(value) {
90
+ const raw = value
91
+ .normalize("NFKC")
92
+ .toLocaleLowerCase()
93
+ .split(/[\s\p{P}\p{S}_]+/gu)
94
+ .filter(Boolean);
95
+ return raw.length > 1 ? raw.map(normalize).filter(Boolean) : toGrams(normalize(value));
96
+ }
97
+ function toGrams(value) {
98
+ const chars = Array.from(value);
99
+ if (chars.length <= 2)
100
+ return chars.length ? [chars.join("")] : [];
101
+ const grams = new Set();
102
+ for (let index = 0; index < chars.length - 1; index += 1) {
103
+ grams.add(chars.slice(index, index + 2).join(""));
104
+ }
105
+ for (let index = 0; index < chars.length - 2; index += 1) {
106
+ grams.add(chars.slice(index, index + 3).join(""));
107
+ }
108
+ return [...grams];
109
+ }
110
+ function diceCoefficient(left, right) {
111
+ if (left.length === 0 || right.length === 0)
112
+ return 0;
113
+ const rightSet = new Set(right);
114
+ const intersection = left.filter((value) => rightSet.has(value)).length;
115
+ return (2 * intersection) / (left.length + rightSet.size);
116
+ }
117
+ //# sourceMappingURL=search.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/search/search.ts"],"names":[],"mappings":"AAEA,MAAM,aAAa,GAAG;IACpB,OAAO,EAAE,EAAE;IACX,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;IACP,WAAW,EAAE,CAAC;IACd,WAAW,EAAE,CAAC;CACN,CAAC;AAEX,MAAM,UAAU,gBAAgB,CAC9B,UAA4B,EAC5B,OAAsB;IAEtB,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC;IAC7C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAE7D,OAAO,UAAU;SACd,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC;SACrD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC;SAC/E,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;SACxC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC;SAC1D,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;SAC7D,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;AACrB,CAAC;AAED,SAAS,UAAU,CAAC,KAAqB,EAAE,KAAa;IACtD,MAAM,MAAM,GAA+C;QACzD,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,EAAE;QAC5B,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;QAC1B,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,EAAE;QACpC,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,EAAE;KACrC,CAAC;IACF,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,MAAM,aAAa,GAAa,EAAE,CAAC;IAEnC,KAAK,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAEzD,EAAE,CAAC;QACF,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/D,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YACnB,KAAK,IAAI,UAAU,GAAG,MAAM,CAAC;YAC7B,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,MAAM,aAAa,GAAG,sBAAsB,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3E,KAAK,IAAI,aAAa,IAAI,CAAC,CAAC;IAE5B,MAAM,MAAM,GAAiB;QAC3B,EAAE,EAAE,KAAK,CAAC,EAAE;QACZ,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE;QAClC,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC/B,aAAa,EAAE,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC/C,aAAa;KACd,CAAC;IACF,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS;QAAE,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;IAChE,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS;QAAE,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IAC5E,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,sBAAsB,CAAC,KAAa,EAAE,MAAgB;IAC7D,IAAI,CAAC,KAAK;QAAE,OAAO,CAAC,CAAC;IACrB,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3C,IAAI,UAAU,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC;IACpC,MAAM,UAAU,GAAG,IAAI,GAAG,CACxB,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CACrD,CAAC;IACF,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QAC9B,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC;AACnC,CAAC;AAED,SAAS,UAAU,CAAC,KAAa,EAAE,KAAa;IAC9C,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK;QAAE,OAAO,CAAC,CAAC;IAC/B,IAAI,KAAK,KAAK,KAAK;QAAE,OAAO,CAAC,CAAC;IAC9B,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC;IAExF,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IAChC,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAClE,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5E,MAAM,SAAS,GAAG,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAClE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,GAAG,EAAE,SAAS,GAAG,GAAG,CAAC,CAAC;IACzD,OAAO,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,OAAO,KAAK;SACT,SAAS,CAAC,MAAM,CAAC;SACjB,iBAAiB,EAAE;SACnB,OAAO,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,UAAU,CAAC,KAAa;IAC/B,MAAM,GAAG,GAAG,KAAK;SACd,SAAS,CAAC,MAAM,CAAC;SACjB,iBAAiB,EAAE;SACnB,KAAK,CAAC,oBAAoB,CAAC;SAC3B,MAAM,CAAC,OAAO,CAAC,CAAC;IACnB,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;AACzF,CAAC;AAED,SAAS,OAAO,CAAC,KAAa;IAC5B,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACnE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACzD,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACpD,CAAC;IACD,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACzD,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACpD,CAAC;IACD,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC;AACpB,CAAC;AAED,SAAS,eAAe,CAAC,IAAc,EAAE,KAAe;IACtD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC;IACtD,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;IAChC,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;IACxE,OAAO,CAAC,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;AAC5D,CAAC"}
@@ -0,0 +1,21 @@
1
+ import type { OpenApiContext, SchemaFormatOptions, SearchOptions } from "./types.js";
2
+ export declare class OpenApiService {
3
+ readonly context: OpenApiContext;
4
+ constructor(context: OpenApiContext);
5
+ search(options: SearchOptions): import("./types.js").SearchResult[];
6
+ getApi(input: {
7
+ id?: string;
8
+ path?: string;
9
+ method?: string;
10
+ }, options?: SchemaFormatOptions): import("./types.js").JsonObject | undefined;
11
+ getSchema(name: string, options?: SchemaFormatOptions): {
12
+ name: string;
13
+ schema: unknown;
14
+ } | undefined;
15
+ listGroups(): {
16
+ name: string;
17
+ operationCount: number;
18
+ }[];
19
+ listSchemas(): string[];
20
+ }
21
+ //# sourceMappingURL=service.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAMrF,qBAAa,cAAc;IACb,QAAQ,CAAC,OAAO,EAAE,cAAc;IAA5C,YAAqB,OAAO,EAAE,cAAc,EAAI;IAEhD,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,+CAMlC;IAED,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;;;kBAKxD;IAED,UAAU;;;QAST;IAED,WAAW,aAEV;CACF"}
@@ -0,0 +1,40 @@
1
+ import { formatOperation } from "./formatter/operation.js";
2
+ import { findSchema, formatSchema, listSchemaNames } from "./formatter/schema.js";
3
+ import { findOperation } from "./openapi/operations.js";
4
+ import { searchOperations } from "./search/search.js";
5
+ export class OpenApiService {
6
+ context;
7
+ constructor(context) {
8
+ this.context = context;
9
+ }
10
+ search(options) {
11
+ return searchOperations(this.context.operations, options);
12
+ }
13
+ getApi(input, options = {}) {
14
+ const operation = findOperation(this.context.operations, input);
15
+ return operation
16
+ ? formatOperation(this.context.document, operation, options)
17
+ : undefined;
18
+ }
19
+ getSchema(name, options = {}) {
20
+ const schema = findSchema(this.context.document, name);
21
+ return schema === undefined
22
+ ? undefined
23
+ : { name, schema: formatSchema(this.context.document, schema, options) };
24
+ }
25
+ listGroups() {
26
+ const groups = new Map();
27
+ for (const operation of this.context.operations) {
28
+ const tags = operation.tags.length ? operation.tags : ["untagged"];
29
+ for (const tag of tags)
30
+ groups.set(tag, (groups.get(tag) ?? 0) + 1);
31
+ }
32
+ return [...groups.entries()]
33
+ .map(([name, operationCount]) => ({ name, operationCount }))
34
+ .sort((a, b) => a.name.localeCompare(b.name));
35
+ }
36
+ listSchemas() {
37
+ return listSchemaNames(this.context.document);
38
+ }
39
+ }
40
+ //# sourceMappingURL=service.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AACA,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;AAEtD,MAAM,OAAO,cAAc;IACJ,OAAO;IAA5B,YAAqB,OAAuB;uBAAvB,OAAO;IAAmB,CAAC;IAEhD,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"}
@@ -0,0 +1,46 @@
1
+ import type { OpenAPI } from "@scalar/openapi-types";
2
+ export type JsonObject = Record<string, unknown>;
3
+ export type HttpMethod = "get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace" | "query";
4
+ export interface OperationEntry {
5
+ id: string;
6
+ method: HttpMethod;
7
+ path: string;
8
+ summary?: string;
9
+ description?: string;
10
+ operationId?: string;
11
+ tags: string[];
12
+ operation: JsonObject;
13
+ pathItem: JsonObject;
14
+ }
15
+ export interface SearchOptions {
16
+ query: string;
17
+ method?: string;
18
+ tag?: string;
19
+ limit?: number;
20
+ }
21
+ export interface SearchResult {
22
+ id: string;
23
+ method: string;
24
+ path: string;
25
+ summary?: string;
26
+ description?: string;
27
+ tags: string[];
28
+ score: number;
29
+ queryCoverage: number;
30
+ matchedFields: string[];
31
+ }
32
+ export interface OpenApiContext {
33
+ document: OpenAPI.Document;
34
+ source: string;
35
+ version: string;
36
+ operations: OperationEntry[];
37
+ validationWarnings: Array<{
38
+ message: string;
39
+ count: number;
40
+ }>;
41
+ }
42
+ export interface SchemaFormatOptions {
43
+ maxDepth?: number;
44
+ maxProperties?: number;
45
+ }
46
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +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;CAC/D;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}
package/dist/types.js ADDED
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}
package/package.json ADDED
@@ -0,0 +1,41 @@
1
+ {
2
+ "name": "openapi-docs-mcp",
3
+ "version": "0.1.0",
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
+ }