oas2mcp.viewers.summary¶

Rich summary viewers for normalized OpenAPI catalogs.

Purpose:

Render ApiCatalog and ApiOperation objects in a readable terminal format using Rich.

Design:

Focus on inspection and debugging rather than mutation.
Present both an overview of the whole catalog and a detailed view for one operation.
Keep rendering functions composable and CLI-friendly.

Examples

from rich.console import Console

from oas2mcp.viewers.summary import render_catalog_summary

render_catalog_summary(catalog, console=Console())

Functions¶

`build_component_counts_table`(→ rich.table.Table)	Build a Rich table summarizing component counts.
`build_info_panel`(→ rich.panel.Panel)	Build a Rich info panel from the catalog metadata.
`build_operation_counts_table`(→ rich.table.Table)	Build a Rich table of operation counts by HTTP method.
`build_operation_security_table`(→ rich.table.Table)	Build a Rich table for operation security requirements.
`build_operations_table`(→ rich.table.Table)	Build a Rich table summarizing normalized operations.
`build_overview_panel`(→ rich.panel.Panel)	Build a Rich overview panel for an `ApiCatalog`.
`build_parameters_table`(→ rich.table.Table)	Build a Rich table for normalized parameters.
`build_paths_table`(→ rich.table.Table)	Build a Rich table summarizing normalized path items.
`build_request_body_table`(→ rich.table.Table)	Build a Rich table for an operation request body.
`build_responses_table`(→ rich.table.Table)	Build a Rich table for normalized responses.
`build_security_schemes_table`(→ rich.table.Table)	Build a Rich table summarizing security schemes.
`build_servers_table`(→ rich.table.Table)	Build a Rich table summarizing catalog servers.
`build_tags_table`(→ rich.table.Table)	Build a Rich table summarizing catalog tags.
`render_catalog_summary`(→ None)	Render a full Rich summary for an `ApiCatalog`.
`render_operation_detail`(→ None)	Render a detailed Rich view for one operation.

Module Contents¶

oas2mcp.viewers.summary.build_component_counts_table(catalog: oas2mcp.models.normalized.ApiCatalog) → rich.table.Table[source][source]¶

Build a Rich table summarizing component counts.

Parameters:: catalog – The normalized API catalog.
Returns:: A Rich Table.
Raises:: None. –

Examples

table = build_component_counts_table(catalog)

oas2mcp.viewers.summary.build_info_panel(catalog: oas2mcp.models.normalized.ApiCatalog) → rich.panel.Panel[source][source]¶

Build a Rich info panel from the catalog metadata.

Parameters:: catalog – The normalized API catalog.
Returns:: A Rich Panel.
Raises:: None. –

Examples

panel = build_info_panel(catalog)

oas2mcp.viewers.summary.build_operation_counts_table(catalog: oas2mcp.models.normalized.ApiCatalog) → rich.table.Table[source][source]¶

Build a Rich table of operation counts by HTTP method.

Parameters:: catalog – The normalized API catalog.
Returns:: A Rich Table.
Raises:: None. –

Examples

table = build_operation_counts_table(catalog)

oas2mcp.viewers.summary.build_operation_security_table(operation: oas2mcp.models.normalized.ApiOperation) → rich.table.Table[source][source]¶

Build a Rich table for operation security requirements.

Parameters:: operation – The operation to display.
Returns:: A Rich Table.
Raises:: None. –

Examples

table = build_operation_security_table(operation)

oas2mcp.viewers.summary.build_operations_table(catalog: oas2mcp.models.normalized.ApiCatalog, *, max_operations: int) → rich.table.Table[source][source]¶

Build a Rich table summarizing normalized operations.

Parameters:

catalog – The normalized API catalog.
max_operations – Maximum number of operations to display.

Returns:

A Rich Table.

Raises:

None. –

Examples

table = build_operations_table(catalog, max_operations=25)

oas2mcp.viewers.summary.build_overview_panel(catalog: oas2mcp.models.normalized.ApiCatalog) → rich.panel.Panel[source][source]¶

Build a Rich overview panel for an ApiCatalog.

Parameters:: catalog – The normalized API catalog.
Returns:: A Rich Panel.
Raises:: None. –

Examples

panel = build_overview_panel(catalog)

oas2mcp.viewers.summary.build_parameters_table(parameters: collections.abc.Iterable[oas2mcp.models.normalized.ApiParameter]) → rich.table.Table[source][source]¶

Build a Rich table for normalized parameters.

Parameters:: parameters – The parameters to display.
Returns:: A Rich Table.
Raises:: None. –

Examples

table = build_parameters_table(operation.parameters)

oas2mcp.viewers.summary.build_paths_table(catalog: oas2mcp.models.normalized.ApiCatalog, *, max_paths: int) → rich.table.Table[source][source]¶

Build a Rich table summarizing normalized path items.

Parameters:

catalog – The normalized API catalog.
max_paths – Maximum number of paths to display.

Returns:

A Rich Table.

Raises:

None. –

Examples

table = build_paths_table(catalog, max_paths=25)

oas2mcp.viewers.summary.build_request_body_table(operation: oas2mcp.models.normalized.ApiOperation) → rich.table.Table[source][source]¶

Build a Rich table for an operation request body.

Parameters:: operation – The operation to display.
Returns:: A Rich Table.
Raises:: None. –

Examples

table = build_request_body_table(operation)

oas2mcp.viewers.summary.build_responses_table(operation: oas2mcp.models.normalized.ApiOperation) → rich.table.Table[source][source]¶

Build a Rich table for normalized responses.

Parameters:: operation – The operation to display.
Returns:: A Rich Table.
Raises:: None. –

Examples

table = build_responses_table(operation)

oas2mcp.viewers.summary.build_security_schemes_table(catalog: oas2mcp.models.normalized.ApiCatalog) → rich.table.Table[source][source]¶

Build a Rich table summarizing security schemes.

Parameters:: catalog – The normalized API catalog.
Returns:: A Rich Table.
Raises:: None. –

Examples

table = build_security_schemes_table(catalog)

oas2mcp.viewers.summary.build_servers_table(catalog: oas2mcp.models.normalized.ApiCatalog) → rich.table.Table[source][source]¶

Build a Rich table summarizing catalog servers.

Parameters:: catalog – The normalized API catalog.
Returns:: A Rich Table.
Raises:: None. –

Examples

table = build_servers_table(catalog)

oas2mcp.viewers.summary.build_tags_table(catalog: oas2mcp.models.normalized.ApiCatalog) → rich.table.Table[source][source]¶

Build a Rich table summarizing catalog tags.

Parameters:: catalog – The normalized API catalog.
Returns:: A Rich Table.
Raises:: None. –

Examples

table = build_tags_table(catalog)

oas2mcp.viewers.summary.render_catalog_summary(catalog: oas2mcp.models.normalized.ApiCatalog, *, console: rich.console.Console | None = None, max_paths: int = _DEFAULT_MAX_PATHS, max_operations: int = _DEFAULT_MAX_OPERATIONS) → None[source][source]¶

Render a full Rich summary for an ApiCatalog.

Parameters:

catalog – The normalized API catalog to display.
console – Optional Rich console instance.
max_paths – Maximum number of paths to display in the paths table.
max_operations – Maximum number of operations to display in the operations table.

Returns:

None.

Raises:

None. –

Examples

from rich.console import Console

render_catalog_summary(
    catalog,
    console=Console(),
)

oas2mcp.viewers.summary.render_operation_detail(operation: oas2mcp.models.normalized.ApiOperation, *, console: rich.console.Console | None = None) → None[source][source]¶

Render a detailed Rich view for one operation.

Parameters:

operation – The normalized operation to display.
console – Optional Rich console instance.

Returns:

None.

Raises:

None. –

Examples

from rich.console import Console

render_operation_detail(
    catalog.operations[0],
    console=Console(),
)