oas2mcp.models.mcp

MCP preparation models.

Purpose:

Define structured intermediate models used to classify normalized OpenAPI operations into MCP-oriented candidates before any agent enhancement step.

Design:

• Keep the first pass deterministic and lightweight.

• Represent only the metadata needed before runtime/server generation.

• Make these models suitable as structured output targets for later agents.

Examples

candidate = McpCandidate(
    operation_key="GET /pets/{petId}",
    kind="tool",
    title="Get pet by ID",
)

Attributes

McpCandidateKind
McpSafetyLevel

Classes

McpBundle	A collection of MCP candidates for one catalog.
McpCandidate	A deterministic MCP candidate derived from one operation.
McpPromptTemplate	A suggested prompt template derived from an API operation.

Module Contents

class oas2mcp.models.mcp.McpBundle(/, **data: Any)

Bases: oas2mcp.models.normalized.NormalizedBaseModel

A collection of MCP candidates for one catalog.

Parameters:

None.

Returns:

None.

Raises:

None. –

Examples

bundle = McpBundle(
    catalog_name="Petstore",
    candidates=[],
)

candidates: list[McpCandidate] = None

catalog_name: str

catalog_slug: str

class oas2mcp.models.mcp.McpCandidate(/, **data: Any)

Bases: oas2mcp.models.normalized.NormalizedBaseModel

A deterministic MCP candidate derived from one operation.

Parameters:

None.

Returns:

None.

Raises:

None. –

Examples

candidate = McpCandidate(
    operation_key="GET /pets/{petId}",
    kind="tool",
    title="Get pet by ID",
    description="Retrieve a pet by its ID.",
)

auth_notes: str | None = None

auth_scheme_names: list[str] = None

description: str

kind: McpCandidateKind

notes: list[str] = None

operation_key: str

operation_slug: str

prompt_templates: list[McpPromptTemplate] = None

requires_confirmation: bool = False

resource_uri: str | None = None

safety_level: McpSafetyLevel

title: str

tool_name: str | None = None

class oas2mcp.models.mcp.McpPromptTemplate(/, **data: Any)

Bases: oas2mcp.models.normalized.NormalizedBaseModel

A suggested prompt template derived from an API operation.

Parameters:

None.

Returns:

None.

Raises:

None. –

Examples

prompt = McpPromptTemplate(
    name="explain-get-pet-by-id",
    title="Explain get pet by ID",
    description="Summarize how to use this endpoint.",
)

arguments: list[str] = None

description: str

meta: dict[str, Any] = None

name: str

tags: list[str] = None

template: str | None = None

title: str

version: str | None = None

oas2mcp.models.mcp.McpCandidateKind

oas2mcp.models.mcp.McpSafetyLevel