yera.apps.builtin.mcp_setup.interaction

Interactive MCP configuration for Yera's setup application.

Symbols

class HeaderAuthEntry — Authenticate to an MCP server with static HTTP headers.
class MCPHeaderEntry — One HTTP header sent with every request to an MCP server.
class MCPServerDisable — Request that an MCP server be disabled for one profile.
class MCPServerEnable — Request that an existing MCP server be enabled for a profile.
class MCPServerEntry — An MCP server entered by hand during setup.
class MCPServerRemoval — A confirmed request to delete one globally configured MCP server.
class MCPSetupNavigation — Control navigation through the MCP Setup interaction.
class NoAuthEntry — Connect to an MCP server without authentication.
class OAuthEntry — Authenticate to an MCP server by signing in through the browser.
def present_mcp_device_authorization — Present OAuth device-verification instructions in setup.
def process_mcp_servers — Prompt for MCP servers to enable in a profile.
def select_mcp_server — Ask the user what MCP server operation to perform.

HeaderAuthEntry

Inherits: yr.Struct

Authenticate to an MCP server with static HTTP headers.

Fields

type
type: Literal['headers'] = 'headers'
headers
type: list[yera.apps.builtin.mcp_setup.interaction.MCPHeaderEntry] (required)

Headers sent with every request.

MCPHeaderEntry

Inherits: yr.Struct

One HTTP header sent with every request to an MCP server.

Fields

name
type: str (required)

HTTP header name.

value
type: pydantic.types.SecretStr (required)

Secret header value, kept only in Yera's secret store.

MCPServerDisable

Request that an MCP server be disabled for one profile.

Fields

name
type: str (required)

Name of the server to disable.

Methods


MCPServerDisable.__init__

__init__(
    name: str,
) → None

MCPServerEnable

Request that an existing MCP server be enabled for a profile.

Fields

name
type: str (required)

Name of the globally configured MCP server to enable.

Methods


MCPServerEnable.__init__

__init__(
    name: str,
) → None

MCPServerEntry

Inherits: yr.Struct

An MCP server entered by hand during setup.

Fields

name
type: str (required)

how you'll refer to it, e.g. github

url
type: str (required)

the server's Streamable HTTP endpoint

auth
type: Union[yera.apps.builtin.mcp_setup.interaction.NoAuthEntry, yera.apps.builtin.mcp_setup.interaction.HeaderAuthEntry, yera.apps.builtin.mcp_setup.interaction.OAuthEntry] = NoAuthEntry(type='none')

How Yera authenticates to the server.

MCPServerRemoval

A confirmed request to delete one globally configured MCP server.

Fields

name
type: str (required)

Name of the server to delete from every profile.

Methods


MCPServerRemoval.__init__

__init__(
    name: str,
) → None

MCPSetupNavigation

Inherits: Enum

Control navigation through the MCP Setup interaction.

Attributes

BACK

Return from a nested route to the root menu.

DONE

Exit MCP Setup.

NoAuthEntry

Inherits: yr.Struct

Connect to an MCP server without authentication.

Fields

type
type: Literal['none'] = 'none'

OAuthEntry

Inherits: yr.Struct

Authenticate to an MCP server by signing in through the browser.

Fields

type
type: Literal['oauth'] = 'oauth'

present_mcp_device_authorization

present_mcp_device_authorization(
    request: OAuthDeviceAuthorizationRequest,
) → None

Present OAuth device-verification instructions in setup.

Parameters

request
type: OAuthDeviceAuthorizationRequest

Non-secret verification context from the provider.

process_mcp_servers

process_mcp_servers(
    profile: Profile,
) → None

Prompt for MCP servers to enable in a profile.

Parameters

profile
type: Profile

Profile being assembled by the setup application.

select_mcp_server

select_mcp_server(
    profile: Profile,
) → MCPSetupResult

Ask the user what MCP server operation to perform.

Parameters

profile
type: Profile

Profile for which servers are being configured.

Returns

type: MCPSetupResult

The selected operation or an explicit navigation result.

Raises

RuntimeError

If a selected catalogue entry cannot be resolved.