haive.mcp.config

Configuration models for MCP Downloader.

This module defines the configuration models used throughout the MCP downloader system, including templates, server configurations, and installation methods.

Example

Creating a server template:
template = ServerTemplate(

name=”npm_official”, installation_method=InstallationMethod.NPM, command_pattern=”@modelcontextprotocol/server-{service}”, capabilities=[“tools”], category=”official”

)

Creating a server configuration:

config = ServerConfig(
name="filesystem",
template="npm_official",
source="npm",
variables={"service": "filesystem"},
tags={"official", "file-operations"}

)

Classes:

InstallationMethod: Enum of supported installation methods ServerTemplate: Template for server installation patterns ServerConfig: Configuration for a specific server DownloaderConfig: Overall downloader configuration

class config.DiscoveryConfig(*, sources=<factory>, patterns=<factory>, auto_discover=False, discovery_interval=24, max_servers=100)[source]

Configuration for server discovery.

Parameters:
sources

List of discovery source URLs

Type:

list[str]

patterns

Package naming patterns by registry

Type:

dict[str, list[str]]

auto_discover

Enable automatic discovery

Type:

bool

discovery_interval

Hours between discovery runs

Type:

int

max_servers

Maximum servers to discover per source

Type:

int

auto_discover: bool
discovery_interval: int
max_servers: int
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

patterns: dict[str, list[str]]
sources: list[str]
class config.DownloaderConfig(*, install_dir=<factory>, config_dir=<factory>, log_dir=<factory>, max_concurrent=5, retry_attempts=3, retry_delay=5, health_check_enabled=True, health_check_timeout=30, backup_enabled=True, backup_dir=<factory>, templates=<factory>, servers=<factory>, discovery=<factory>)[source]

Overall configuration for the MCP downloader.

Parameters:
install_dir

Directory for server installations

Type:

pathlib.Path

config_dir

Directory for configuration files

Type:

pathlib.Path

log_dir

Directory for log files

Type:

pathlib.Path

max_concurrent

Maximum concurrent downloads

Type:

int

retry_attempts

Number of retry attempts

Type:

int

retry_delay

Delay between retries in seconds

Type:

int

health_check_enabled

Enable health checks after install

Type:

bool

health_check_timeout

Health check timeout in seconds

Type:

int

backup_enabled

Enable configuration backups

Type:

bool

backup_dir

Directory for backups

Type:

pathlib.Path

templates

List of server templates

Type:

list[config.ServerTemplate]

servers

List of server configurations

Type:

list[config.ServerConfig]

discovery

Discovery configuration

Type:

config.DiscoveryConfig

Example

Full configuration:

backup_dir: Path
backup_enabled: bool
config_dir: Path
discovery: DiscoveryConfig
health_check_enabled: bool
health_check_timeout: int
install_dir: Path
log_dir: Path
max_concurrent: int
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

retry_attempts: int
retry_delay: int
servers: list[ServerConfig]
templates: list[ServerTemplate]
class config.InstallationMethod(*values)[source]

Supported installation methods for MCP servers.

NPM

Node Package Manager installation

PIP

Python Package Index installation

GIT

Git repository cloning

DOCKER

Docker image pull

BINARY

Binary executable download

CURL

Direct HTTP download

MANUAL

Manual installation process

SCRIPT

Custom script execution

BINARY = 'binary'
CURL = 'curl'
DOCKER = 'docker'
GIT = 'git'
MANUAL = 'manual'
NPM = 'npm'
PIP = 'pip'
SCRIPT = 'script'
class config.ServerConfig(*, name, template, source, variables=<factory>, enabled=True, priority=0, tags=<factory>, env_vars=<factory>, version=None)[source]

Configuration for a specific MCP server.

Server configurations define individual servers to be installed, referencing a template and providing server-specific variables.

Parameters:
name

Server name identifier

Type:

str

template

Template name to use

Type:

str

source

Source location (npm, git URL, etc.)

Type:

str

variables

Variables to substitute in template patterns

Type:

dict[str, Any]

enabled

Whether the server is enabled for installation

Type:

bool

priority

Installation priority (lower = higher priority)

Type:

int

tags

Set of tags for categorization

Type:

set[str]

env_vars

Additional environment variables

Type:

dict[str, str]

version

Specific version to install

Type:

str | None

Example

Filesystem server config:

enabled: bool
env_vars: dict[str, str]
model_config: ClassVar[ConfigDict] = {'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str
priority: int
source: str
tags: set[str]
template: str
variables: dict[str, Any]
version: str | None
class config.ServerTemplate(*, name, installation_method, command_pattern, args_pattern=<factory>, env_vars=<factory>, capabilities=<factory>, category='general', health_check=None, prerequisites=<factory>, post_install=<factory>, timeout=300)[source]

Template for MCP server installation patterns.

Templates define reusable installation patterns that can be applied to multiple servers with similar installation requirements.

Parameters:
name

Unique template identifier

Type:

str

installation_method

Method to use for installation

Type:

config.InstallationMethod

command_pattern

Pattern for the command to run the server

Type:

str

args_pattern

Default arguments for the command

Type:

list[str]

env_vars

Environment variables to set

Type:

dict[str, str]

capabilities

List of server capabilities

Type:

list[str]

category

Server category for organization

Type:

str

health_check

Command to verify server health

Type:

str | None

prerequisites

Required system dependencies

Type:

list[str]

post_install

Commands to run after installation

Type:

list[str]

timeout

Installation timeout in seconds

Type:

int

Example

NPM template:

args_pattern: list[str]
capabilities: list[str]
category: str
command_pattern: str
env_vars: dict[str, str]
health_check: str | None
installation_method: InstallationMethod
model_config: ClassVar[ConfigDict] = {'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str
post_install: list[str]
prerequisites: list[str]
timeout: int
config.load_config(config_file)[source]

Load configuration from YAML file.

Parameters:

config_file (Path) – Path to YAML configuration file

Returns:

Loaded configuration

Return type:

DownloaderConfig

Raises:

Example

Loading config:

config.save_config(config, config_file)[source]

Save configuration to YAML file.

Parameters:
Return type:

None

Example

Saving config: