openapi-mcp-generator
Version:
Generates MCP server code from OpenAPI specifications
46 lines (45 loc) • 1.72 kB
TypeScript
/**
* Security handling utilities for OpenAPI to MCP generator
*/
import { OpenAPIV3 } from 'openapi-types';
/**
* Get environment variable name for a security scheme
*
* @param schemeName Security scheme name
* @param type Type of security credentials
* @returns Environment variable name
*/
export declare function getEnvVarName(schemeName: string, type: 'API_KEY' | 'BEARER_TOKEN' | 'BASIC_USERNAME' | 'BASIC_PASSWORD' | 'OAUTH_CLIENT_ID' | 'OAUTH_CLIENT_SECRET' | 'OAUTH_TOKEN' | 'OAUTH_SCOPES' | 'OPENID_TOKEN'): string;
/**
* Generates code for handling API key security
*
* @param scheme API key security scheme
* @returns Generated code
*/
export declare function generateApiKeySecurityCode(scheme: OpenAPIV3.ApiKeySecurityScheme): string;
/**
* Generates code for handling HTTP security (Bearer/Basic)
*
* @returns Generated code
*/
export declare function generateHttpSecurityCode(): string;
/**
* Generates code for OAuth2 token acquisition
*
* @returns Generated code for OAuth2 token acquisition
*/
export declare function generateOAuth2TokenAcquisitionCode(): string;
/**
* Generates code for executing API tools with security handling
*
* @param securitySchemes Security schemes from OpenAPI spec
* @returns Generated code for the execute API tool function
*/
export declare function generateExecuteApiToolFunction(securitySchemes?: OpenAPIV3.ComponentsObject['securitySchemes']): string;
/**
* Gets security scheme documentation for README
*
* @param securitySchemes Security schemes from OpenAPI spec
* @returns Documentation for security schemes
*/
export declare function getSecuritySchemesDocs(securitySchemes?: OpenAPIV3.ComponentsObject['securitySchemes']): string;