oas2mcp.generate.export

Export helpers for enhanced catalog artifacts.

Functions

build_catalog_prompt_definitions(...)

Build catalog-level prompt definitions for FastMCP registration.

build_catalog_resource_definitions(...)

Build catalog-level resources and resource templates.

build_fastmcp_config(→ dict[str, Any])

Build lightweight FastMCP bootstrap metadata.

build_fastmcp_name_map(→ dict[str, str])

Build operationId -> FastMCP component-name overrides.

build_operation_notes_map(→ dict[str, dict[str, Any]])

Build lightweight per-operation export metadata.

build_server_instructions(→ str)

Build concise FastMCP server instructions from the catalog summary.

export_enhanced_catalog_bundle(→ dict[str, pathlib.Path])

Write enhanced catalog artifacts to disk.

Module Contents

oas2mcp.generate.export.build_catalog_prompt_definitions(enhanced_catalog: oas2mcp.generate.models.EnhancedCatalog) → list[oas2mcp.generate.models.CatalogPromptDefinition][source][source]

Build catalog-level prompt definitions for FastMCP registration.

oas2mcp.generate.export.build_catalog_resource_definitions(enhanced_catalog: oas2mcp.generate.models.EnhancedCatalog) → list[oas2mcp.generate.models.CatalogResourceDefinition][source][source]

Build catalog-level resources and resource templates.

oas2mcp.generate.export.build_fastmcp_config(enhanced_catalog: oas2mcp.generate.models.EnhancedCatalog) → dict[str, Any][source][source]

Build lightweight FastMCP bootstrap metadata.

Parameters:

enhanced_catalog – The enhanced catalog.

Returns:

FastMCP bootstrap metadata.

Return type:

dict[str, Any]

Raises:

None. –

oas2mcp.generate.export.build_fastmcp_name_map(enhanced_catalog: oas2mcp.generate.models.EnhancedCatalog) → dict[str, str][source][source]

Build operationId -> FastMCP component-name overrides.

Parameters:

enhanced_catalog – The enhanced catalog.

Returns:

OpenAPI operationId to chosen FastMCP component name.

Return type:

dict[str, str]

Raises:

None. –

oas2mcp.generate.export.build_operation_notes_map(enhanced_catalog: oas2mcp.generate.models.EnhancedCatalog) → dict[str, dict[str, Any]][source][source]

Build lightweight per-operation export metadata.

Parameters:

enhanced_catalog – The enhanced catalog.

Returns:

Per-operation export metadata.

Return type:

dict[str, dict[str, Any]]

Raises:

None. –

oas2mcp.generate.export.build_server_instructions(enhanced_catalog: oas2mcp.generate.models.EnhancedCatalog) → str[source][source]

Build concise FastMCP server instructions from the catalog summary.

oas2mcp.generate.export.export_enhanced_catalog_bundle(*, enhanced_catalog: oas2mcp.generate.models.EnhancedCatalog, config: oas2mcp.generate.config.ExportConfig) → dict[str, pathlib.Path][source][source]

Write enhanced catalog artifacts to disk.

Parameters:

  • enhanced_catalog – The enhanced catalog to export.

  • config – Export configuration.

Returns:

A mapping of artifact names to written paths.

Return type:

dict[str, Path]

Raises:

None. –

Examples

outputs = export_enhanced_catalog_bundle(
    enhanced_catalog=enhanced_catalog,
    config=config,
)