oas2mcp.generate.export
=======================

.. py:module:: oas2mcp.generate.export

.. autoapi-nested-parse::

   Export helpers for enhanced catalog artifacts.



Functions
---------

.. autoapisummary::

   oas2mcp.generate.export.build_catalog_prompt_definitions
   oas2mcp.generate.export.build_catalog_resource_definitions
   oas2mcp.generate.export.build_fastmcp_config
   oas2mcp.generate.export.build_fastmcp_name_map
   oas2mcp.generate.export.build_operation_notes_map
   oas2mcp.generate.export.build_server_instructions
   oas2mcp.generate.export.export_enhanced_catalog_bundle


Module Contents
---------------

.. py:function:: build_catalog_prompt_definitions(enhanced_catalog: oas2mcp.generate.models.EnhancedCatalog) -> list[oas2mcp.generate.models.CatalogPromptDefinition]

   Build catalog-level prompt definitions for FastMCP registration.


.. py:function:: build_catalog_resource_definitions(enhanced_catalog: oas2mcp.generate.models.EnhancedCatalog) -> list[oas2mcp.generate.models.CatalogResourceDefinition]

   Build catalog-level resources and resource templates.


.. py:function:: build_fastmcp_config(enhanced_catalog: oas2mcp.generate.models.EnhancedCatalog) -> dict[str, Any]

   Build lightweight FastMCP bootstrap metadata.

   :param enhanced_catalog: The enhanced catalog.

   :returns: FastMCP bootstrap metadata.
   :rtype: dict[str, Any]

   :raises None.:


.. py:function:: build_fastmcp_name_map(enhanced_catalog: oas2mcp.generate.models.EnhancedCatalog) -> dict[str, str]

   Build operationId -> FastMCP component-name overrides.

   :param enhanced_catalog: The enhanced catalog.

   :returns: OpenAPI operationId to chosen FastMCP component name.
   :rtype: dict[str, str]

   :raises None.:


.. py:function:: build_operation_notes_map(enhanced_catalog: oas2mcp.generate.models.EnhancedCatalog) -> dict[str, dict[str, Any]]

   Build lightweight per-operation export metadata.

   :param enhanced_catalog: The enhanced catalog.

   :returns: Per-operation export metadata.
   :rtype: dict[str, dict[str, Any]]

   :raises None.:


.. py:function:: build_server_instructions(enhanced_catalog: oas2mcp.generate.models.EnhancedCatalog) -> str

   Build concise FastMCP server instructions from the catalog summary.


.. py:function:: export_enhanced_catalog_bundle(*, enhanced_catalog: oas2mcp.generate.models.EnhancedCatalog, config: oas2mcp.generate.config.ExportConfig) -> dict[str, pathlib.Path]

   Write enhanced catalog artifacts to disk.

   :param enhanced_catalog: The enhanced catalog to export.
   :param config: Export configuration.

   :returns: A mapping of artifact names to written paths.
   :rtype: dict[str, Path]

   :raises None.:

   .. rubric:: Examples

   .. code-block:: python

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