swagger-doc-explorer-mcp 0.0.1

package/dist/tools/schemas.js

@@ -0,0 +1,142 @@
+import { z } from "zod";
+import { isLoaded, getSchemas, getSchemaDetail, getSpec } from "../services/swagger-service.js";
+import { formatSchema } from "../formatters.js";
+export function registerSchemasTools(server) {
+    server.registerTool("swagger_list_schemas", {
+        title: "List Component Schemas",
+        description: `List all component schemas (data models) defined in the loaded OpenAPI spec.
+
+Use this tool to get an overview of all data models used by the API, including their types and number of properties.
+
+Args:
+  - spec_name (string): Name of the previously loaded spec
+  - limit (number): Maximum results to return (default: 50)
+  - offset (number): Number of results to skip (default: 0)
+
+Returns:
+  {
+    "total": number,             // Total number of schemas
+    "count": number,             // Number of results in this response
+    "offset": number,            // Current pagination offset
+    "schemas": [{ "name", "type", "description", "properties" }],
+    "has_more": boolean,
+    "next_offset": number
+  }
+
+Examples:
+  - Use when: "What data models are defined?" -> params with spec_name="<name>"
+  - Use when: "Show me all schemas" -> params with spec_name="<name>"
+
+Error Handling:
+  - Returns error if the spec name has not been loaded yet`,
+        inputSchema: z.object({
+            spec_name: z.string().min(1).describe("Name of the previously loaded OpenAPI/Swagger spec (use swagger_list_loaded to see available names)"),
+            limit: z.number().int().min(1).max(200).default(50).describe("Maximum results to return (default: 50)"),
+            offset: z.number().int().min(0).default(0).describe("Number of results to skip for pagination (default: 0)"),
+        }).strict(),
+        annotations: {
+            readOnlyHint: true,
+            destructiveHint: false,
+            idempotentHint: true,
+            openWorldHint: false,
+        },
+    }, async (params) => {
+        try {
+            if (!isLoaded(params.spec_name)) {
+                return { content: [{ type: "text", text: `Error: Spec '${params.spec_name}' has not been loaded yet. Use swagger_load_spec to load it first.` }] };
+            }
+            const allSchemas = getSchemas(params.spec_name);
+            const total = allSchemas.length;
+            const paginated = allSchemas.slice(params.offset, params.offset + params.limit);
+            if (paginated.length === 0) {
+                const msg = total === 0 ? "No schemas defined in this spec." : `No more schemas to show (offset ${params.offset} of ${total}).`;
+                return { content: [{ type: "text", text: msg }] };
+            }
+            const hasMore = total > params.offset + paginated.length;
+            const store = getSpec(params.spec_name);
+            const output = {
+                total, count: paginated.length, offset: params.offset,
+                schemas: paginated, has_more: hasMore,
+                ...(hasMore ? { next_offset: params.offset + paginated.length } : {}),
+            };
+            const lines = [
+                `# ${store?.spec.info.title || "API"} - Component Schemas`,
+                "",
+                `**${total} total schemas** (showing ${paginated.length})`,
+                "",
+                "| Name | Type | Properties | Description |",
+                "|------|------|------------|-------------|",
+            ];
+            for (const schema of paginated) {
+                lines.push(`| \`${schema.name}\` | ${schema.type || "object"} | ${schema.properties} | ${(schema.description || "").slice(0, 80)} |`);
+            }
+            if (hasMore) {
+                lines.push(`\n> Showing ${paginated.length} of ${total} schemas. Use offset=${params.offset + paginated.length} to see more.`);
+            }
+            lines.push("\nUse `swagger_get_schema` to see full details of a specific schema.");
+            return {
+                content: [{ type: "text", text: lines.join("\n") }],
+                structuredContent: output,
+            };
+        }
+        catch (error) {
+            return { content: [{ type: "text", text: error instanceof Error ? error.message : String(error) }] };
+        }
+    });
+    server.registerTool("swagger_get_schema", {
+        title: "Get Schema Details",
+        description: `Get detailed information about a specific component schema (data model), including all properties, types, constraints, and examples.
+
+Use this tool to drill down into a specific data model after using swagger_list_schemas.
+
+Args:
+  - spec_name (string): Name of the previously loaded spec
+  - schema_name (string): Name of the schema/model (e.g., "Pet", "User", "Order", "Error")
+
+Returns:
+  Formatted output with the full schema definition including type, properties, required fields, enums, constraints, and examples.
+
+Examples:
+  - Use when: "Show me the Pet model" -> params with spec_name="<name>", schema_name="Pet"
+  - Use when: "What fields does the User schema have?" -> params with spec_name="<name>", schema_name="User"
+
+Error Handling:
+  - Returns error if the spec name has not been loaded
+  - Returns error if the schema name is not found, suggesting available schemas`,
+        inputSchema: z.object({
+            spec_name: z.string().min(1).describe("Name of the previously loaded OpenAPI/Swagger spec (use swagger_list_loaded to see available names)"),
+            schema_name: z.string().min(1).describe("Name of the schema/model (e.g., 'Pet', 'User', 'Order', 'Error'). Case-sensitive."),
+        }).strict(),
+        annotations: {
+            readOnlyHint: true,
+            destructiveHint: false,
+            idempotentHint: true,
+            openWorldHint: false,
+        },
+    }, async (params) => {
+        try {
+            if (!isLoaded(params.spec_name)) {
+                return { content: [{ type: "text", text: `Error: Spec '${params.spec_name}' has not been loaded yet. Use swagger_load_spec to load it first.` }] };
+            }
+            const schema = getSchemaDetail(params.spec_name, params.schema_name);
+            if (!schema) {
+                const allSchemas = getSchemas(params.spec_name);
+                const suggestions = allSchemas.slice(0, 10).map((s) => s.name);
+                return {
+                    content: [{
+                            type: "text",
+                            text: `Error: Schema '${params.schema_name}' not found.\n\nAvailable schemas:\n${suggestions.map((name) => `  - ${name}`).join("\n")}${allSchemas.length > 10 ? "\n  ... and more" : ""}`,
+                        }],
+                };
+            }
+            return {
+                content: [{ type: "text", text: [`# Schema: ${params.schema_name}`, "", "```", formatSchema(schema), "```"].join("\n") }],
+                structuredContent: schema,
+            };
+        }
+        catch (error) {
+            return { content: [{ type: "text", text: error instanceof Error ? error.message : String(error) }] };
+        }
+    });
+}
+//# sourceMappingURL=schemas.js.map

package/dist/tools/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../src/tools/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAChG,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD,MAAM,UAAU,oBAAoB,CAAC,MAAiB;IACpD,MAAM,CAAC,YAAY,CACjB,sBAAsB,EACtB;QACE,KAAK,EAAE,wBAAwB;QAC/B,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;2DAwBwC;QACrD,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;YACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,qGAAqG,CAAC;YAC5I,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,yCAAyC,CAAC;YACvG,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,uDAAuD,CAAC;SAC7G,CAAC,CAAC,MAAM,EAAE;QACX,WAAW,EAAE;YACX,YAAY,EAAE,IAAI;YAClB,eAAe,EAAE,KAAK;YACtB,cAAc,EAAE,IAAI;YACpB,aAAa,EAAE,KAAK;SACrB;KACF,EACD,KAAK,EAAE,MAAM,EAAE,EAAE;QACf,IAAI,CAAC;YACH,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;gBAChC,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,MAAM,CAAC,SAAS,oEAAoE,EAAE,CAAC,EAAE,CAAC;YACrJ,CAAC;YAED,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAChD,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC;YAChC,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YAEhF,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC3B,MAAM,GAAG,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,kCAAkC,CAAC,CAAC,CAAC,mCAAmC,MAAM,CAAC,MAAM,OAAO,KAAK,IAAI,CAAC;gBAChI,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;YACpD,CAAC;YAED,MAAM,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;YACzD,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAExC,MAAM,MAAM,GAAG;gBACb,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrD,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO;gBACrC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACtE,CAAC;YAEF,MAAM,KAAK,GAAG;gBACZ,KAAK,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,sBAAsB;gBAC1D,EAAE;gBACF,KAAK,KAAK,6BAA6B,SAAS,CAAC,MAAM,GAAG;gBAC1D,EAAE;gBACF,4CAA4C;gBAC5C,4CAA4C;aAC7C,CAAC;YACF,KAAK,MAAM,MAAM,IAAI,SAAS,EAAE,CAAC;gBAC/B,KAAK,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,IAAI,QAAQ,MAAM,CAAC,IAAI,IAAI,QAAQ,MAAM,MAAM,CAAC,UAAU,MAAM,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;YACxI,CAAC;YACD,IAAI,OAAO,EAAE,CAAC;gBACZ,KAAK,CAAC,IAAI,CAAC,eAAe,SAAS,CAAC,MAAM,OAAO,KAAK,wBAAwB,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,eAAe,CAAC,CAAC;YACjI,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,sEAAsE,CAAC,CAAC;YAEnF,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnD,iBAAiB,EAAE,MAAM;aAC1B,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;QACvG,CAAC;IACH,CAAC,CACF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,oBAAoB,EACpB;QACE,KAAK,EAAE,oBAAoB;QAC3B,WAAW,EAAE;;;;;;;;;;;;;;;;;gFAiB6D;QAC1E,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;YACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,qGAAqG,CAAC;YAC5I,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,mFAAmF,CAAC;SAC7H,CAAC,CAAC,MAAM,EAAE;QACX,WAAW,EAAE;YACX,YAAY,EAAE,IAAI;YAClB,eAAe,EAAE,KAAK;YACtB,cAAc,EAAE,IAAI;YACpB,aAAa,EAAE,KAAK;SACrB;KACF,EACD,KAAK,EAAE,MAAM,EAAE,EAAE;QACf,IAAI,CAAC;YACH,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;gBAChC,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,MAAM,CAAC,SAAS,oEAAoE,EAAE,CAAC,EAAE,CAAC;YACrJ,CAAC;YAED,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;YACrE,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAChD,MAAM,WAAW,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBAC/D,OAAO;oBACL,OAAO,EAAE,CAAC;4BACR,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,kBAAkB,MAAM,CAAC,WAAW,uCAAuC,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,EAAE;yBAC1L,CAAC;iBACH,CAAC;YACJ,CAAC;YAED,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,aAAa,MAAM,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzH,iBAAiB,EAAE,MAAM;aAC1B,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;QACvG,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC"}

package/dist/tools/search.d.ts

@@ -0,0 +1,3 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+export declare function registerSearchTools(server: McpServer): void;
+//# sourceMappingURL=search.d.ts.map

package/dist/tools/search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../src/tools/search.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAGzE,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,SAAS,QA2GpD"}

package/dist/tools/search.js

@@ -0,0 +1,100 @@
+import { z } from "zod";
+import { isLoaded, searchSpec } from "../services/swagger-service.js";
+export function registerSearchTools(server) {
+    server.registerTool("swagger_search", {
+        title: "Search API Spec",
+        description: `Search across all endpoints and schemas in a loaded OpenAPI spec for a given query string.
+
+Searches through endpoint paths, operation summaries, operationIds, descriptions, tags, schema names, and property names.
+
+Args:
+  - spec_name (string): Name of the previously loaded spec
+  - query (string): Search term to find in endpoint paths, summaries, operationIds, tags, schema names, and property descriptions
+
+Returns:
+  {
+    "total": number,             // Total number of matches
+    "results": [
+      {
+        "type": "endpoint" | "schema" | "property",
+        "path": string,          // URL path (for endpoints)
+        "method": string,        // HTTP method (for endpoints)
+        "schemaName": string,    // Schema name (for schemas/properties)
+        "propertyName": string,  // Property name (for properties)
+        "match": string,         // Human-readable match description
+        "summary": string        // Brief description
+      }
+    ]
+  }
+
+Examples:
+  - Use when: "Search for anything about pets" -> params with spec_name="<name>", query="pet"
+  - Use when: "Find endpoints related to users" -> params with spec_name="<name>", query="user"
+
+Error Handling:
+  - Returns error if the spec name has not been loaded`,
+        inputSchema: z.object({
+            spec_name: z.string().min(1).describe("Name of the previously loaded OpenAPI/Swagger spec (use swagger_list_loaded to see available names)"),
+            query: z.string().min(1).max(200).describe("Search term to find in endpoint paths, summaries, operationIds, tags, schema names, and property descriptions"),
+        }).strict(),
+        annotations: {
+            readOnlyHint: true,
+            destructiveHint: false,
+            idempotentHint: true,
+            openWorldHint: false,
+        },
+    }, async (params) => {
+        try {
+            if (!isLoaded(params.spec_name)) {
+                return { content: [{ type: "text", text: `Error: Spec '${params.spec_name}' has not been loaded yet. Use swagger_load_spec to load it first.` }] };
+            }
+            const results = searchSpec(params.spec_name, params.query);
+            if (results.length === 0) {
+                return {
+                    content: [{
+                            type: "text",
+                            text: `No results found for '${params.query}'. Try a different search term or browse the spec with swagger_list_paths and swagger_list_schemas.`,
+                        }],
+                };
+            }
+            const endpoints = results.filter((r) => r.type === "endpoint");
+            const schemas = results.filter((r) => r.type === "schema");
+            const properties = results.filter((r) => r.type === "property");
+            const lines = [
+                `# Search Results for '${params.query}'`,
+                "",
+                `Found ${results.length} matches`,
+                "",
+            ];
+            if (endpoints.length > 0) {
+                lines.push(`## Endpoints (${endpoints.length})`);
+                for (const ep of endpoints) {
+                    lines.push(`- **${ep.method?.toUpperCase()}** \`${ep.path}\` - ${ep.summary || ""}`);
+                }
+                lines.push("");
+            }
+            if (schemas.length > 0) {
+                lines.push(`## Schemas (${schemas.length})`);
+                for (const s of schemas) {
+                    lines.push(`- **${s.schemaName}** - ${s.summary || ""}`);
+                }
+                lines.push("");
+            }
+            if (properties.length > 0) {
+                lines.push(`## Properties (${properties.length})`);
+                for (const p of properties) {
+                    lines.push(`- \`${p.schemaName}.${p.propertyName}\` - ${p.summary || ""}`);
+                }
+                lines.push("");
+            }
+            return {
+                content: [{ type: "text", text: lines.join("\n") }],
+                structuredContent: { total: results.length, query: params.query, results },
+            };
+        }
+        catch (error) {
+            return { content: [{ type: "text", text: error instanceof Error ? error.message : String(error) }] };
+        }
+    });
+}
+//# sourceMappingURL=search.js.map

package/dist/tools/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/tools/search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAEtE,MAAM,UAAU,mBAAmB,CAAC,MAAiB;IACnD,MAAM,CAAC,YAAY,CACjB,gBAAgB,EAChB;QACE,KAAK,EAAE,iBAAiB;QACxB,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uDA6BoC;QACjD,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;YACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,qGAAqG,CAAC;YAC5I,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,+GAA+G,CAAC;SAC5J,CAAC,CAAC,MAAM,EAAE;QACX,WAAW,EAAE;YACX,YAAY,EAAE,IAAI;YAClB,eAAe,EAAE,KAAK;YACtB,cAAc,EAAE,IAAI;YACpB,aAAa,EAAE,KAAK;SACrB;KACF,EACD,KAAK,EAAE,MAAM,EAAE,EAAE;QACf,IAAI,CAAC;YACH,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;gBAChC,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,MAAM,CAAC,SAAS,oEAAoE,EAAE,CAAC,EAAE,CAAC;YACrJ,CAAC;YAED,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;YAE3D,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO;oBACL,OAAO,EAAE,CAAC;4BACR,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,yBAAyB,MAAM,CAAC,KAAK,qGAAqG;yBACjJ,CAAC;iBACH,CAAC;YACJ,CAAC;YAED,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;YAC/D,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;YAC3D,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;YAEhE,MAAM,KAAK,GAAG;gBACZ,yBAAyB,MAAM,CAAC,KAAK,GAAG;gBACxC,EAAE;gBACF,SAAS,OAAO,CAAC,MAAM,UAAU;gBACjC,EAAE;aACH,CAAC;YAEF,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACzB,KAAK,CAAC,IAAI,CAAC,iBAAiB,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;gBACjD,KAAK,MAAM,EAAE,IAAI,SAAS,EAAE,CAAC;oBAC3B,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,IAAI,QAAQ,EAAE,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC,CAAC;gBACvF,CAAC;gBACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACjB,CAAC;YAED,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,KAAK,CAAC,IAAI,CAAC,eAAe,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;gBAC7C,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;oBACxB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,QAAQ,CAAC,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC,CAAC;gBAC3D,CAAC;gBACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACjB,CAAC;YAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,KAAK,CAAC,IAAI,CAAC,kBAAkB,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;gBACnD,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;oBAC3B,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,YAAY,QAAQ,CAAC,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC,CAAC;gBAC7E,CAAC;gBACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACjB,CAAC;YAED,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnD,iBAAiB,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE;aAC3E,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;QACvG,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,139 @@
+export interface SpecStore {
+    spec: OpenApiSpec;
+    name: string;
+    source: string;
+    loadedAt: string;
+}
+export interface OpenApiSpec {
+    openapi?: string;
+    swagger?: string;
+    info: {
+        title: string;
+        version: string;
+        description?: string;
+    };
+    paths: Record<string, PathItem>;
+    components?: {
+        schemas?: Record<string, SchemaObject>;
+    };
+    definitions?: Record<string, SchemaObject>;
+    tags?: Array<{
+        name: string;
+        description?: string;
+    }>;
+    servers?: Array<{
+        url: string;
+        description?: string;
+    }>;
+    host?: string;
+    basePath?: string;
+    schemes?: string[];
+}
+export interface PathItem {
+    summary?: string;
+    description?: string;
+    get?: OperationObject;
+    post?: OperationObject;
+    put?: OperationObject;
+    patch?: OperationObject;
+    delete?: OperationObject;
+    options?: OperationObject;
+    head?: OperationObject;
+    parameters?: ParameterObject[];
+}
+export interface OperationObject {
+    summary?: string;
+    description?: string;
+    operationId?: string;
+    tags?: string[];
+    parameters?: ParameterObject[];
+    requestBody?: RequestBodyObject;
+    responses?: Record<string, ResponseObject>;
+    deprecated?: boolean;
+    security?: Array<Record<string, string[]>>;
+}
+export interface ParameterObject {
+    name: string;
+    in: "query" | "path" | "header" | "cookie";
+    description?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    allowEmptyValue?: boolean;
+    schema?: SchemaObject;
+    type?: string;
+    items?: SchemaObject;
+    enum?: string[];
+    example?: unknown;
+}
+export interface RequestBodyObject {
+    description?: string;
+    required?: boolean;
+    content: Record<string, MediaTypeObject>;
+}
+export interface MediaTypeObject {
+    schema?: SchemaObject;
+    example?: unknown;
+    examples?: Record<string, unknown>;
+}
+export interface ResponseObject {
+    description: string;
+    content?: Record<string, MediaTypeObject>;
+    headers?: Record<string, ParameterObject>;
+}
+export interface SchemaObject {
+    [key: string]: unknown;
+    type?: string;
+    format?: string;
+    properties?: Record<string, SchemaObject>;
+    items?: SchemaObject;
+    required?: string[];
+    enum?: string[];
+    description?: string;
+    example?: unknown;
+    default?: unknown;
+    nullable?: boolean;
+    oneOf?: SchemaObject[];
+    anyOf?: SchemaObject[];
+    allOf?: SchemaObject[];
+    $ref?: string;
+    additionalProperties?: boolean | SchemaObject;
+    minLength?: number;
+    maxLength?: number;
+    minimum?: number;
+    maximum?: number;
+    pattern?: string;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    xml?: Record<string, unknown>;
+    externalDocs?: {
+        url: string;
+        description?: string;
+    };
+    title?: string;
+    deprecated?: boolean;
+}
+export type HttpMethod = "get" | "post" | "put" | "patch" | "delete" | "options" | "head";
+export interface EndpointSummary {
+    path: string;
+    method: HttpMethod;
+    summary: string;
+    operationId?: string;
+    tags: string[];
+    deprecated: boolean;
+}
+export interface SchemaSummary {
+    name: string;
+    type?: string;
+    description?: string;
+    properties: number;
+}
+export interface SearchResult {
+    type: "endpoint" | "schema" | "property";
+    path?: string;
+    method?: HttpMethod;
+    schemaName?: string;
+    propertyName?: string;
+    match: string;
+    summary?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAChC,UAAU,CAAC,EAAE;QACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;KACxC,CAAC;IACF,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC3C,IAAI,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACrD,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACvD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,eAAe,CAAC;IACtB,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,GAAG,CAAC,EAAE,eAAe,CAAC;IACtB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;IAC/B,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC3C,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC1C,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;IACvB,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;IACvB,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oBAAoB,CAAC,EAAE,OAAO,GAAG,YAAY,CAAC;IAC9C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,YAAY,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACrD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;AAE1F,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,UAAU,GAAG,QAAQ,GAAG,UAAU,CAAC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "swagger-doc-explorer-mcp",
+  "version": "0.0.1",
+  "description": "MCP server for progressive exploration of Swagger/OpenAPI documentation",
+  "type": "module",
+  "main": "dist/index.js",
+  "bin": {
+    "swagger-doc-explorer-mcp": "dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "start": "node dist/index.js",
+    "start:http": "SWAGGER_HTTP_PORT=3000 node dist/index.js",
+    "dev": "tsx watch src/index.ts",
+    "dev:http": "SWAGGER_HTTP_PORT=3000 tsx src/index.ts",
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "test": "node --import tsx --test test/**/*.test.ts",
+    "prepublishOnly": "npm run build && npm test"
+  },
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "swagger",
+    "openapi",
+    "api-explorer",
+    "documentation"
+  ],
+  "author": "anuoua",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anuoua/swagger-doc-explorer-mcp.git"
+  },
+  "homepage": "https://github.com/anuoua/swagger-doc-explorer-mcp#readme",
+  "bugs": {
+    "url": "https://github.com/anuoua/swagger-doc-explorer-mcp/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "packageManager": "pnpm@10.30.3",
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.6.1",
+    "axios": "^1.7.9",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2"
+  }
+}