Skip to content

mcp_registry_client.models

Pydantic models for MCP registry API responses.

EnvironmentVariable

Bases: BaseModel

Environment variable configuration for a package.

Source code in mcp_registry_client/models.py 
29
30
31
32
33
34
35
36
37
38
class EnvironmentVariable(BaseModel):
    """Environment variable configuration for a package."""

    name: str
    description: str | None = None
    is_required: bool | None = None
    is_secret: bool | None = None
    format_: str | None = Field(None, alias='format')

    model_config = {'populate_by_name': True}

OfficialMeta

Bases: BaseModel

Official registry metadata.

Source code in mcp_registry_client/models.py 
78
79
80
81
82
83
84
85
86
class OfficialMeta(BaseModel):
    """Official registry metadata."""

    id_: str = Field(alias='id')
    published_at: datetime
    updated_at: datetime
    is_latest: bool

    model_config = {'populate_by_name': True}

Package

Bases: BaseModel

Package information for an MCP server.

Source code in mcp_registry_client/models.py 
64
65
66
67
68
69
70
71
72
73
74
75
class Package(BaseModel):
    """Package information for an MCP server."""

    registry_type: str
    identifier: str
    version: str
    registry_base_url: HttpUrl | None = None
    runtime_hint: str | None = None
    file_sha256: str | None = None
    transport: Transport | None = None
    environment_variables: list[EnvironmentVariable] | None = None
    package_arguments: list[PackageArgument] | None = None

PackageArgument

Bases: BaseModel

Package argument configuration.

Source code in mcp_registry_client/models.py 
41
42
43
44
45
46
47
48
49
50
51
52
class PackageArgument(BaseModel):
    """Package argument configuration."""

    name: str | None = None  # Made optional to handle missing names
    type_: str = Field(alias='type')
    description: str | None = None
    format_: str | None = Field(None, alias='format')
    is_required: bool | None = None
    default: str | int | bool | None = None
    value: str | None = None

    model_config = {'populate_by_name': True}

RegistryError

Bases: BaseModel

Error response from the registry API.

Source code in mcp_registry_client/models.py 
119
120
121
122
123
124
class RegistryError(BaseModel):
    """Error response from the registry API."""

    error: str
    message: str | None = None
    details: dict[str, Any] | None = None

Remote

Bases: BaseModel

Remote endpoint configuration for an MCP server.

Source code in mcp_registry_client/models.py 
20
21
22
23
24
25
26
class Remote(BaseModel):
    """Remote endpoint configuration for an MCP server."""

    type_: str = Field(alias='type')
    url: HttpUrl

    model_config = {'populate_by_name': True}

Repository

Bases: BaseModel

Repository information for an MCP server.

Source code in mcp_registry_client/models.py 
 9
10
11
12
13
14
15
16
17
class Repository(BaseModel):
    """Repository information for an MCP server."""

    url: str
    source: str
    id_: str | None = Field(None, alias='id')
    subfolder: str | None = None

    model_config = {'populate_by_name': True}

SearchResponse

Bases: BaseModel

Response from the servers search endpoint.

Source code in mcp_registry_client/models.py 
113
114
115
116
class SearchResponse(BaseModel):
    """Response from the servers search endpoint."""

    servers: list[Server]

Server

Bases: BaseModel

MCP server definition.

Source code in mcp_registry_client/models.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
class Server(BaseModel):
    """MCP server definition."""

    schema_: HttpUrl | None = Field(None, alias='$schema')
    name: str
    description: str
    status: str | None = None
    repository: Repository
    version: str
    remotes: list[Remote] | None = None
    packages: list[Package] | None = None
    meta: ServerMeta = Field(alias='_meta')

    model_config = {'populate_by_name': True}

ServerMeta

Bases: BaseModel

Server metadata container.

Source code in mcp_registry_client/models.py 
89
90
91
92
93
94
class ServerMeta(BaseModel):
    """Server metadata container."""

    official: OfficialMeta = Field(alias='io.modelcontextprotocol.registry/official')

    model_config = {'populate_by_name': True}

Transport

Bases: BaseModel

Transport configuration for a package.

Source code in mcp_registry_client/models.py 
55
56
57
58
59
60
61
class Transport(BaseModel):
    """Transport configuration for a package."""

    type_: str = Field(alias='type')
    url: str | None = None  # Changed from HttpUrl to str to handle templates

    model_config = {'populate_by_name': True}