@nocobase/plugin-mcp-server 2.1.0-alpha.10

package/dist/node_modules/openapi-mcp-generator/README.md

@@ -0,0 +1,261 @@
+# OpenAPI to MCP Generator (openapi-mcp-generator)
+
+[![npm version](https://img.shields.io/npm/v/openapi-mcp-generator.svg)](https://www.npmjs.com/package/openapi-mcp-generator)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![GitHub repository](https://img.shields.io/badge/GitHub-harsha--iiiv/openapi--mcp--generator-blue.svg)](https://github.com/harsha-iiiv/openapi-mcp-generator)
+
+Generate [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) servers from OpenAPI specifications.
+
+This CLI tool automates the generation of MCP-compatible servers that proxy requests to existing REST APIs—enabling AI agents and other MCP clients to seamlessly interact with your APIs using your choice of transport methods.
+
+---
+
+## ✨ Features
+
+- 🔧 **OpenAPI 3.0 Support**: Converts any OpenAPI 3.0+ spec into an MCP-compatible server.
+- 🔁 **Proxy Behavior**: Proxies calls to your original REST API while validating request structure and security.
+- 🔐 **Authentication Support**: API keys, Bearer tokens, Basic auth, and OAuth2 supported via environment variables.
+- 🧪 **Zod Validation**: Automatically generates Zod schemas from OpenAPI definitions for runtime input validation.
+- ⚙️ **Typed Server**: Fully typed, maintainable TypeScript code output.
+- 🔌 **Multiple Transports**: Communicate over stdio, SSE via Hono, or StreamableHTTP.
+- 🧰 **Project Scaffold**: Generates a complete Node.js project with `tsconfig.json`, `package.json`, and entry point.
+- 🧪 **Built-in HTML Test Clients**: Test API interactions visually in your browser (for web-based transports).
+
+---
+
+## 🚀 Installation
+
+```bash
+npm install -g openapi-mcp-generator
+```
+
+> You can also use `yarn global add openapi-mcp-generator` or `pnpm add -g openapi-mcp-generator`
+
+---
+
+## 🛠 Usage
+
+```bash
+# Generate an MCP server (stdio)
+openapi-mcp-generator --input path/to/openapi.json --output path/to/output/dir
+
+# Generate an MCP web server with SSE
+openapi-mcp-generator --input path/to/openapi.json --output path/to/output/dir --transport=web --port=3000
+
+# Generate an MCP StreamableHTTP server
+openapi-mcp-generator --input path/to/openapi.json --output path/to/output/dir --transport=streamable-http --port=3000
+```
+
+### CLI Options
+
+| Option              | Alias | Description                                                                                                                                    | Default                           |
+| ------------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
+| `--input`           | `-i`  | Path or URL to OpenAPI specification (YAML or JSON)                                                                                            | **Required**                      |
+| `--output`          | `-o`  | Directory to output the generated MCP project                                                                                                  | **Required**                      |
+| `--server-name`     | `-n`  | Name of the MCP server (`package.json:name`)                                                                                                   | OpenAPI title or `mcp-api-server` |
+| `--server-version`  | `-v`  | Version of the MCP server (`package.json:version`)                                                                                             | OpenAPI version or `1.0.0`        |
+| `--base-url`        | `-b`  | Base URL for API requests. Required if OpenAPI `servers` missing or ambiguous.                                                                 | Auto-detected if possible         |
+| `--transport`       | `-t`  | Transport mode: `"stdio"` (default), `"web"`, or `"streamable-http"`                                                                           | `"stdio"`                         |
+| `--port`            | `-p`  | Port for web-based transports                                                                                                                  | `3000`                            |
+| `--default-include` |       | Default behavior for x-mcp filtering. Accepts `true` or `false` (case-insensitive). `true` = include by default, `false` = exclude by default. | `true`                            |
+| `--force`           |       | Overwrite existing files in the output directory without confirmation                                                                          | `false`                           |
+
+## 📦 Programmatic API
+
+You can also use this package programmatically in your Node.js applications:
+
+```javascript
+import { getToolsFromOpenApi } from 'openapi-mcp-generator';
+
+// Extract MCP tool definitions from an OpenAPI spec
+const tools = await getToolsFromOpenApi('./petstore.json');
+
+// With options
+const filteredTools = await getToolsFromOpenApi('https://example.com/api-spec.json', {
+  baseUrl: 'https://api.example.com',
+  dereference: true,
+  excludeOperationIds: ['deletePet'],
+  filterFn: (tool) => tool.method.toLowerCase() === 'get',
+});
+```
+
+For full documentation of the programmatic API, see [PROGRAMMATIC_API.md](./PROGRAMMATIC_API.md).
+
+---
+
+## 🧱 Project Structure
+
+The generated project includes:
+
+```
+<output_directory>/
+├── .gitignore
+├── package.json
+├── tsconfig.json
+├── .env.example
+├── src/
+│   ├── index.ts
+│   └── [transport-specific-files]
+└── public/          # For web-based transports
+    └── index.html   # Test client
+```
+
+Core dependencies:
+
+- `@modelcontextprotocol/sdk` - MCP protocol implementation
+- `axios` - HTTP client for API requests
+- `zod` - Runtime validation
+- `json-schema-to-zod` - Convert JSON Schema to Zod
+- Transport-specific deps (Hono, uuid, etc.)
+
+---
+
+## 📡 Transport Modes
+
+### Stdio (Default)
+
+Communicates with MCP clients via standard input/output. Ideal for local development or integration with LLM tools.
+
+### Web Server with SSE
+
+Launches a fully functional HTTP server with:
+
+- Server-Sent Events (SSE) for bidirectional messaging
+- REST endpoint for client → server communication
+- In-browser test client UI
+- Multi-connection support
+- Built with lightweight Hono framework
+
+### StreamableHTTP
+
+Implements the MCP StreamableHTTP transport which offers:
+
+- Stateful JSON-RPC over HTTP POST requests
+- Session management using HTTP headers
+- Proper HTTP response status codes
+- Built-in error handling
+- Compatibility with MCP StreamableHTTPClientTransport
+- In-browser test client UI
+- Built with lightweight Hono framework
+
+### Transport Comparison
+
+| Feature            | stdio               | web (SSE)         | streamable-http    |
+| ------------------ | ------------------- | ----------------- | ------------------ |
+| Protocol           | JSON-RPC over stdio | JSON-RPC over SSE | JSON-RPC over HTTP |
+| Connection         | Persistent          | Persistent        | Request/response   |
+| Bidirectional      | Yes                 | Yes               | Yes (stateful)     |
+| Multiple clients   | No                  | Yes               | Yes                |
+| Browser compatible | No                  | Yes               | Yes                |
+| Firewall friendly  | No                  | Yes               | Yes                |
+| Load balancing     | No                  | Limited           | Yes                |
+| Status codes       | No                  | Limited           | Full HTTP codes    |
+| Headers            | No                  | Limited           | Full HTTP headers  |
+| Test client        | No                  | Yes               | Yes                |
+
+---
+
+## 🔐 Environment Variables for Authentication
+
+Configure auth credentials in your environment:
+
+| Auth Type  | Variable Format                                                                                    |
+| ---------- | -------------------------------------------------------------------------------------------------- |
+| API Key    | `API_KEY_<SCHEME_NAME>`                                                                            |
+| Bearer     | `BEARER_TOKEN_<SCHEME_NAME>`                                                                       |
+| Basic Auth | `BASIC_USERNAME_<SCHEME_NAME>`, `BASIC_PASSWORD_<SCHEME_NAME>`                                     |
+| OAuth2     | `OAUTH_CLIENT_ID_<SCHEME_NAME>`, `OAUTH_CLIENT_SECRET_<SCHEME_NAME>`, `OAUTH_SCOPES_<SCHEME_NAME>` |
+
+---
+
+## 🔎 Filtering Endpoints with OpenAPI Extensions
+
+You can control which operations are exposed as MCP tools using a vendor extension flag `x-mcp`. This extension is supported at the root, path, and operation levels. By default, endpoints are included unless explicitly excluded.
+
+- Extension: `x-mcp: true | false`
+- Default: `true` (include by default)
+- Precedence: operation > path > root (first non-undefined wins)
+- CLI option: `--default-include false` to change default to exclude by default
+
+Examples:
+
+```yaml
+# Optional root-level default
+x-mcp: true
+
+paths:
+  /pets:
+    x-mcp: false # exclude all ops under /pets
+    get:
+      x-mcp: true # include this operation anyway
+
+  /users/{id}:
+    get:
+      # no x-mcp -> included by default
+```
+
+This uses standard OpenAPI extensions (x-… fields). See the [OpenAPI Extensions guide](https://swagger.io/docs/specification/v3_0/openapi-extensions/) for details.
+
+Note: `x-mcp` must be a boolean or the strings `"true"`/`"false"` (case-insensitive). Other values are ignored in favor of higher-precedence or default behavior.
+
+---
+
+## ▶️ Running the Generated Server
+
+```bash
+cd path/to/output/dir
+npm install
+
+# Run in stdio mode
+npm start
+
+# Run in web server mode
+npm run start:web
+
+# Run in StreamableHTTP mode
+npm run start:http
+```
+
+### Testing Web-Based Servers
+
+For web and StreamableHTTP transports, a browser-based test client is automatically generated:
+
+1. Start the server using the appropriate command
+2. Open your browser to `http://localhost:<port>`
+3. Use the test client to interact with your MCP server
+
+---
+
+## ⚠️ Requirements
+
+- Node.js v20 or later
+
+---
+
+## Star History
+
+<a href="https://www.star-history.com/#harsha-iiiv/openapi-mcp-generator&Date">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=harsha-iiiv/openapi-mcp-generator&type=Date&theme=dark" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=harsha-iiiv/openapi-mcp-generator&type=Date" />
+   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=harsha-iiiv/openapi-mcp-generator&type=Date" />
+ </picture>
+</a>
+
+## 🤝 Contributing
+
+Contributions are welcome!
+
+1. Fork the repo
+2. Create a feature branch: `git checkout -b feature/amazing-feature`
+3. Run `npm run format.write` to format your code
+4. Commit your changes: `git commit -m "Add amazing feature"`
+5. Push and open a PR
+
+📌 Repository: [github.com/harsha-iiiv/openapi-mcp-generator](https://github.com/harsha-iiiv/openapi-mcp-generator)
+
+---
+
+## 📄 License
+
+MIT License — see [LICENSE](./LICENSE) for full details.

package/dist/node_modules/openapi-mcp-generator/bin/openapi-mcp-generator.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+import { program } from '../dist/index.js';
+
+// Parse CLI arguments and run the program
+program.parse(process.argv);

package/dist/node_modules/openapi-mcp-generator/dist/api.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Programmatic API for OpenAPI to MCP Generator
+ * Allows direct usage from other Node.js applications
+ */
+import { OpenAPIV3 } from 'openapi-types';
+import { McpToolDefinition } from './types/index.js';
+/**
+ * Options for generating the MCP tools
+ */
+export interface GetToolsOptions {
+    /** Optional base URL to override the one in the OpenAPI spec */
+    baseUrl?: string;
+    /** Whether to dereference the OpenAPI spec */
+    dereference?: boolean;
+    /** Array of operation IDs to exclude from the tools list */
+    excludeOperationIds?: string[];
+    /** Optional filter function to exclude tools based on custom criteria */
+    filterFn?: (tool: McpToolDefinition) => boolean;
+    /** Default behavior for x-mcp filtering (default: true = include by default) */
+    defaultInclude?: boolean;
+}
+/**
+ * Get a list of tools from an OpenAPI specification
+ *
+ * @param specPathOrUrl Path or URL to the OpenAPI specification
+ * @param options Options for generating the tools
+ * @returns Promise that resolves to an array of tool definitions
+ */
+export declare function getToolsFromOpenApi(specPathOrUrl: string | OpenAPIV3.Document, options?: GetToolsOptions): Promise<McpToolDefinition[]>;
+export { McpToolDefinition };

package/dist/node_modules/openapi-mcp-generator/dist/api.js

@@ -0,0 +1,56 @@
+/**
+ * Programmatic API for OpenAPI to MCP Generator
+ * Allows direct usage from other Node.js applications
+ */
+import SwaggerParser from '@apidevtools/swagger-parser';
+import { extractToolsFromApi } from './parser/extract-tools.js';
+import { determineBaseUrl } from './utils/url.js';
+function isOpenApiDocument(spec) {
+    return typeof spec === 'object' && spec !== null && 'openapi' in spec;
+}
+/**
+ * Get a list of tools from an OpenAPI specification
+ *
+ * @param specPathOrUrl Path or URL to the OpenAPI specification
+ * @param options Options for generating the tools
+ * @returns Promise that resolves to an array of tool definitions
+ */
+export async function getToolsFromOpenApi(specPathOrUrl, options = {}) {
+    try {
+        // Parse the OpenAPI spec
+        const api = isOpenApiDocument(specPathOrUrl)
+            ? specPathOrUrl
+            : options.dereference
+                ? (await SwaggerParser.dereference(specPathOrUrl))
+                : (await SwaggerParser.parse(specPathOrUrl));
+        // Extract tools from the API
+        const allTools = extractToolsFromApi(api, options.defaultInclude ?? true);
+        // Add base URL to each tool
+        const baseUrl = determineBaseUrl(api, options.baseUrl);
+        // Apply filters to exclude specified operationIds and custom filter function
+        let filteredTools = allTools;
+        // Filter by excluded operation IDs if provided
+        if (options.excludeOperationIds && options.excludeOperationIds.length > 0) {
+            const excludeSet = new Set(options.excludeOperationIds);
+            filteredTools = filteredTools.filter((tool) => !excludeSet.has(tool.operationId));
+        }
+        // Apply custom filter function if provided
+        if (options.filterFn) {
+            filteredTools = filteredTools.filter(options.filterFn);
+        }
+        // Return the filtered tools with base URL added
+        return filteredTools.map((tool) => ({
+            ...tool,
+            baseUrl: baseUrl || '',
+        }));
+    }
+    catch (error) {
+        // Provide more context for the error
+        if (error instanceof Error) {
+            // Preserve original stack/context
+            throw new Error(`Failed to extract tools from OpenAPI: ${error.message}`, { cause: error });
+        }
+        throw error;
+    }
+}
+//# sourceMappingURL=api.js.map

package/dist/node_modules/openapi-mcp-generator/dist/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,aAAa,MAAM,6BAA6B,CAAC;AAExD,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAsBlD,SAAS,iBAAiB,CAAC,IAAiC;IAC1D,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,SAAS,IAAI,IAAI,CAAC;AACxE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,aAA0C,EAC1C,UAA2B,EAAE;IAE7B,IAAI,CAAC;QACH,yBAAyB;QACzB,MAAM,GAAG,GAAG,iBAAiB,CAAC,aAAa,CAAC;YAC1C,CAAC,CAAC,aAAa;YACf,CAAC,CAAC,OAAO,CAAC,WAAW;gBACnB,CAAC,CAAE,CAAC,MAAM,aAAa,CAAC,WAAW,CAAC,aAAa,CAAC,CAAwB;gBAC1E,CAAC,CAAE,CAAC,MAAM,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAwB,CAAC;QAEzE,6BAA6B;QAC7B,MAAM,QAAQ,GAAG,mBAAmB,CAAC,GAAG,EAAE,OAAO,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC;QAE1E,4BAA4B;QAC5B,MAAM,OAAO,GAAG,gBAAgB,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAEvD,6EAA6E;QAC7E,IAAI,aAAa,GAAG,QAAQ,CAAC;QAE7B,+CAA+C;QAC/C,IAAI,OAAO,CAAC,mBAAmB,IAAI,OAAO,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1E,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;YACxD,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QACpF,CAAC;QAED,2CAA2C;QAC3C,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrB,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACzD,CAAC;QAED,gDAAgD;QAChD,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAClC,GAAG,IAAI;YACP,OAAO,EAAE,OAAO,IAAI,EAAE;SACvB,CAAC,CAAC,CAAC;IACN,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,qCAAqC;QACrC,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,kCAAkC;YAClC,MAAM,IAAI,KAAK,CAAC,yCAAyC,KAAK,CAAC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAC9F,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/node_modules/openapi-mcp-generator/dist/generator/config-files.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Generator for configuration files for MCP servers
+ */
+/**
+ * Generates the content of tsconfig.json for the MCP server
+ *
+ * @returns JSON string for tsconfig.json
+ */
+export declare function generateTsconfigJson(): string;
+/**
+ * Generates the content of .gitignore for the MCP server
+ *
+ * @returns Content for .gitignore
+ */
+export declare function generateGitignore(): string;
+/**
+ * Generates the content of .eslintrc.json for the MCP server
+ *
+ * @returns JSON string for .eslintrc.json
+ */
+export declare function generateEslintConfig(): string;
+/**
+ * Generates the content of jest.config.js for the MCP server
+ *
+ * @returns Content for jest.config.js
+ */
+export declare function generateJestConfig(): string;
+/**
+ * Generates the content of .prettierrc for the MCP server
+ *
+ * @returns JSON string for .prettierrc
+ */
+export declare function generatePrettierConfig(): string;

package/dist/node_modules/openapi-mcp-generator/dist/generator/config-files.js

@@ -0,0 +1,168 @@
+/**
+ * Generator for configuration files for MCP servers
+ */
+/**
+ * Generates the content of tsconfig.json for the MCP server
+ *
+ * @returns JSON string for tsconfig.json
+ */
+export function generateTsconfigJson() {
+    const tsconfigData = {
+        compilerOptions: {
+            esModuleInterop: true,
+            skipLibCheck: true,
+            target: 'ES2022',
+            allowJs: true,
+            resolveJsonModule: true,
+            moduleDetection: 'force',
+            strict: true,
+            noImplicitAny: true,
+            strictNullChecks: true,
+            module: 'Node16',
+            moduleResolution: 'Node16',
+            noEmit: false,
+            outDir: './build',
+            declaration: true,
+            sourceMap: true,
+            forceConsistentCasingInFileNames: true,
+        },
+        include: ['src/**/*'],
+        exclude: ['node_modules', 'build', '**/*.test.ts'],
+    };
+    return JSON.stringify(tsconfigData, null, 2);
+}
+/**
+ * Generates the content of .gitignore for the MCP server
+ *
+ * @returns Content for .gitignore
+ */
+export function generateGitignore() {
+    return `# Dependencies
+node_modules
+.pnp
+.pnp.js
+
+# Build outputs
+dist
+build
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Reports
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Coverage
+coverage
+*.lcov
+.nyc_output
+
+# Build artifacts
+.grunt
+bower_components
+jspm_packages/
+web_modules/
+.lock-wscript
+
+# Editor settings
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+.idea
+*.sublime-workspace
+*.sublime-project
+
+# Caches
+.eslintcache
+.stylelintcache
+.node_repl_history
+.browserslistcache
+
+# Environment variables
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# OS specific
+.DS_Store
+Thumbs.db
+`;
+}
+/**
+ * Generates the content of .eslintrc.json for the MCP server
+ *
+ * @returns JSON string for .eslintrc.json
+ */
+export function generateEslintConfig() {
+    const eslintConfig = {
+        parser: '@typescript-eslint/parser',
+        extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+        plugins: ['@typescript-eslint'],
+        env: {
+            node: true,
+            es2022: true,
+        },
+        rules: {
+            'no-console': ['error', { allow: ['error', 'warn'] }],
+            '@typescript-eslint/explicit-function-return-type': 'off',
+            '@typescript-eslint/no-explicit-any': 'off',
+            '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+        },
+    };
+    return JSON.stringify(eslintConfig, null, 2);
+}
+/**
+ * Generates the content of jest.config.js for the MCP server
+ *
+ * @returns Content for jest.config.js
+ */
+export function generateJestConfig() {
+    return `export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  extensionsToTreatAsEsm: ['.ts'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        useESM: true,
+      },
+    ],
+  },
+};
+`;
+}
+/**
+ * Generates the content of .prettierrc for the MCP server
+ *
+ * @returns JSON string for .prettierrc
+ */
+export function generatePrettierConfig() {
+    const prettierConfig = {
+        semi: true,
+        trailingComma: 'es5',
+        singleQuote: true,
+        printWidth: 100,
+        tabWidth: 2,
+    };
+    return JSON.stringify(prettierConfig, null, 2);
+}
+//# sourceMappingURL=config-files.js.map

package/dist/node_modules/openapi-mcp-generator/dist/generator/config-files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-files.js","sourceRoot":"","sources":["../../src/generator/config-files.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;GAIG;AACH,MAAM,UAAU,oBAAoB;IAClC,MAAM,YAAY,GAAG;QACnB,eAAe,EAAE;YACf,eAAe,EAAE,IAAI;YACrB,YAAY,EAAE,IAAI;YAClB,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,IAAI;YACb,iBAAiB,EAAE,IAAI;YACvB,eAAe,EAAE,OAAO;YACxB,MAAM,EAAE,IAAI;YACZ,aAAa,EAAE,IAAI;YACnB,gBAAgB,EAAE,IAAI;YACtB,MAAM,EAAE,QAAQ;YAChB,gBAAgB,EAAE,QAAQ;YAC1B,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,SAAS;YACjB,WAAW,EAAE,IAAI;YACjB,SAAS,EAAE,IAAI;YACf,gCAAgC,EAAE,IAAI;SACvC;QACD,OAAO,EAAE,CAAC,UAAU,CAAC;QACrB,OAAO,EAAE,CAAC,cAAc,EAAE,OAAO,EAAE,cAAc,CAAC;KACnD,CAAC;IAEF,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB;IAC/B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgER,CAAC;AACF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB;IAClC,MAAM,YAAY,GAAG;QACnB,MAAM,EAAE,2BAA2B;QACnC,OAAO,EAAE,CAAC,oBAAoB,EAAE,uCAAuC,CAAC;QACxE,OAAO,EAAE,CAAC,oBAAoB,CAAC;QAC/B,GAAG,EAAE;YACH,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,IAAI;SACb;QACD,KAAK,EAAE;YACL,YAAY,EAAE,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;YACrD,kDAAkD,EAAE,KAAK;YACzD,oCAAoC,EAAE,KAAK;YAC3C,mCAAmC,EAAE,CAAC,OAAO,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;SAC5E;KACF,CAAC;IAEF,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB;IAChC,OAAO;;;;;;;;;;;;;;;;CAgBR,CAAC;AACF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB;IACpC,MAAM,cAAc,GAAG;QACrB,IAAI,EAAE,IAAI;QACV,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,IAAI;QACjB,UAAU,EAAE,GAAG;QACf,QAAQ,EAAE,CAAC;KACZ,CAAC;IAEF,OAAO,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACjD,CAAC"}

package/dist/node_modules/openapi-mcp-generator/dist/generator/env-file.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generator for .env file and .env.example file
+ */
+import { OpenAPIV3 } from 'openapi-types';
+/**
+ * Generates the content of .env.example file for the MCP server
+ *
+ * @param securitySchemes Security schemes from the OpenAPI spec
+ * @returns Content for .env.example file
+ */
+export declare function generateEnvExample(securitySchemes?: OpenAPIV3.ComponentsObject['securitySchemes']): string;
+/**
+ * Generates dotenv configuration code for the MCP server
+ *
+ * @returns Code for loading environment variables
+ */
+export declare function generateDotenvConfig(): string;

package/dist/node_modules/openapi-mcp-generator/dist/generator/env-file.js

@@ -0,0 +1,89 @@
+import { getEnvVarName } from '../utils/security.js';
+/**
+ * Generates the content of .env.example file for the MCP server
+ *
+ * @param securitySchemes Security schemes from the OpenAPI spec
+ * @returns Content for .env.example file
+ */
+export function generateEnvExample(securitySchemes) {
+    let content = `# MCP Server Environment Variables
+# Copy this file to .env and fill in the values
+
+# Server configuration
+PORT=3000
+LOG_LEVEL=info
+# If you have a server outside the servers list from OpenAPI, define it here.
+# Otherwise, omit this.
+API_BASE_URL=your_api_base_url_here
+
+`;
+    // Add security scheme environment variables with examples
+    if (securitySchemes && Object.keys(securitySchemes).length > 0) {
+        content += `# API Authentication\n`;
+        for (const [name, schemeOrRef] of Object.entries(securitySchemes)) {
+            if ('$ref' in schemeOrRef) {
+                content += `# ${name} - Referenced security scheme (reference not resolved)\n`;
+                continue;
+            }
+            const scheme = schemeOrRef;
+            if (scheme.type === 'apiKey') {
+                const varName = getEnvVarName(name, 'API_KEY');
+                content += `${varName}=your_api_key_here\n`;
+            }
+            else if (scheme.type === 'http') {
+                if (scheme.scheme?.toLowerCase() === 'bearer') {
+                    const varName = getEnvVarName(name, 'BEARER_TOKEN');
+                    content += `${varName}=your_bearer_token_here\n`;
+                }
+                else if (scheme.scheme?.toLowerCase() === 'basic') {
+                    const usernameVar = getEnvVarName(name, 'BASIC_USERNAME');
+                    const passwordVar = getEnvVarName(name, 'BASIC_PASSWORD');
+                    content += `${usernameVar}=your_username_here\n`;
+                    content += `${passwordVar}=your_password_here\n`;
+                }
+            }
+            else if (scheme.type === 'oauth2') {
+                content += `# OAuth2 authentication (${scheme.flows ? Object.keys(scheme.flows).join(', ') : 'unknown'} flow)\n`;
+                const varName = `OAUTH_TOKEN_${name.replace(/[^a-zA-Z0-9]/g, '_').toUpperCase()}`;
+                content += `${varName}=your_oauth_token_here\n`;
+            }
+        }
+    }
+    else {
+        content += `# No API authentication required\n`;
+    }
+    content += `\n# Add any other environment variables your API might need\n`;
+    return content;
+}
+/**
+ * Generates dotenv configuration code for the MCP server
+ *
+ * @returns Code for loading environment variables
+ */
+export function generateDotenvConfig() {
+    return `
+/**
+ * Load environment variables from .env file
+ */
+import dotenv from 'dotenv';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// Load environment variables from .env file
+const result = dotenv.config({ path: path.resolve(__dirname, '../.env') });
+
+if (result.error) {
+  console.warn('Warning: No .env file found or error loading .env file.');
+  console.warn('Using default environment variables.');
+}
+
+export const config = {
+  port: process.env.PORT || '3000',
+  logLevel: process.env.LOG_LEVEL || 'info',
+};
+`;
+}
+//# sourceMappingURL=env-file.js.map

package/dist/node_modules/openapi-mcp-generator/dist/generator/env-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"env-file.js","sourceRoot":"","sources":["../../src/generator/env-file.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAChC,eAA+D;IAE/D,IAAI,OAAO,GAAG;;;;;;;;;;CAUf,CAAC;IAEA,0DAA0D;IAC1D,IAAI,eAAe,IAAI,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/D,OAAO,IAAI,wBAAwB,CAAC;QAEpC,KAAK,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC;YAClE,IAAI,MAAM,IAAI,WAAW,EAAE,CAAC;gBAC1B,OAAO,IAAI,KAAK,IAAI,0DAA0D,CAAC;gBAC/E,SAAS;YACX,CAAC;YAED,MAAM,MAAM,GAAG,WAAW,CAAC;YAE3B,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBAC/C,OAAO,IAAI,GAAG,OAAO,sBAAsB,CAAC;YAC9C,CAAC;iBAAM,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBAClC,IAAI,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,QAAQ,EAAE,CAAC;oBAC9C,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;oBACpD,OAAO,IAAI,GAAG,OAAO,2BAA2B,CAAC;gBACnD,CAAC;qBAAM,IAAI,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,OAAO,EAAE,CAAC;oBACpD,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;oBAC1D,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;oBAC1D,OAAO,IAAI,GAAG,WAAW,uBAAuB,CAAC;oBACjD,OAAO,IAAI,GAAG,WAAW,uBAAuB,CAAC;gBACnD,CAAC;YACH,CAAC;iBAAM,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACpC,OAAO,IAAI,4BAA4B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU,CAAC;gBACjH,MAAM,OAAO,GAAG,eAAe,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;gBAClF,OAAO,IAAI,GAAG,OAAO,0BAA0B,CAAC;YAClD,CAAC;QACH,CAAC;IACH,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,oCAAoC,CAAC;IAClD,CAAC;IAED,OAAO,IAAI,+DAA+D,CAAC;IAE3E,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB;IAClC,OAAO;;;;;;;;;;;;;;;;;;;;;;;CAuBR,CAAC;AACF,CAAC"}