ServerList

object
serversarray[object]required

API response format with separated server data and registry metadata

Show Child Parameters
metadataobject
Show Child Parameters
Example

Package

object
registryTypestringrequired

Registry type indicating how to download packages (e.g., ‘npm’, ‘pypi’, ‘oci’, ‘nuget’, ‘mcpb’)

Example:npm

registryBaseUrlstring(uri)

Base URL of the package registry

Example:https://registry.npmjs.org

identifierstringrequired

Package identifier - either a package name (for registries) or URL (for direct downloads)

Example:@modelcontextprotocol/server-brave-search

versionstring

Package version. Must be a specific version. Version ranges are rejected (e.g., ‘^1.2.3’, ‘~1.2.3’, ‘>=1.2.3’, ‘1.x’, ‘1.*’).

>= 1 characters

Example:1.0.2

fileSha256string

SHA-256 hash of the package file for integrity verification. Required for MCPB packages and optional for other package types. Authors are responsible for generating correct SHA-256 hashes when creating server.json. If present, MCP clients must validate the downloaded file matches the hash before running packages to ensure file integrity.

Match pattern:^[a-f0-9]{64}$

Example:fe333e598595000ae021bd27117db32ec69af6987f507ba7a63c90638ff633ce

runtimeHintstring

A hint to help clients determine the appropriate runtime for the package. This field should be provided when runtimeArguments are present.

Example:npx

transportAny Of
required
StdioTransportobject

Transport protocol configuration for the package

Show Child Parameters
runtimeArgumentsAny Of
array

Warning: Arguments construct command-line parameters that may contain user-provided input. This creates potential command injection risks if clients execute commands in a shell environment. For example, a malicious argument value like ‘;rm -rf ~/Development’ could execute dangerous commands. Clients should prefer non-shell execution methods (e.g., posix_spawn) when possible to eliminate injection risks entirely. Where not possible, clients should obtain consent from users or agents to run the resolved command before execution.

PositionalArgumentAny Of
PositionalArgumentobject

A positional input is a value inserted verbatim into the command line.

Show Child Parameters
packageArgumentsAny Of
array

Warning: Arguments construct command-line parameters that may contain user-provided input. This creates potential command injection risks if clients execute commands in a shell environment. For example, a malicious argument value like ‘;rm -rf ~/Development’ could execute dangerous commands. Clients should prefer non-shell execution methods (e.g., posix_spawn) when possible to eliminate injection risks entirely. Where not possible, clients should obtain consent from users or agents to run the resolved command before execution.

PositionalArgumentAny Of
PositionalArgumentobject

A positional input is a value inserted verbatim into the command line.

Show Child Parameters
environmentVariablesarray

A mapping of environment variables to be set when running the package.

Show Child Parameters
Example

Input

object
descriptionstring

A description of the input, which clients can use to provide context to the user.

isRequiredboolean

Default:false

formatstring

Specifies the input format. Supported values include filepath, which should be interpreted as a file on the user’s filesystem.

When the input is converted to a string, booleans should be represented by the strings “true” and “false”, and numbers should be represented as decimal values.

Allowed values:stringnumberbooleanfilepath

Default:string

valuestring

The value for the input. If this is not set, the user may be prompted to provide a value. If a value is set, it should not be configurable by end users.

Identifiers wrapped in {curly_braces} will be replaced with the corresponding properties from the input variables map. If an identifier in braces is not found in variables, or if variables is not provided, the {curly_braces} substring should remain unchanged.

isSecretboolean

Indicates whether the input is a secret value (e.g., password, token). If true, clients should handle the value securely.

Default:false

defaultstring

The default value for the input. This should be a valid value for the input. If you want to provide input examples or guidance, use the placeholder field instead.

placeholderstring

A placeholder for the input to be displaying during configuration. This is used to provide examples or guidance about the expected form or content of the input.

choicesarray[string]

A list of possible values for the input. If provided, the user must select one of these values.

Example:[]

Example

InputWithVariables

descriptionstring

A description of the input, which clients can use to provide context to the user.

isRequiredboolean

Default:false

formatstring

Specifies the input format. Supported values include filepath, which should be interpreted as a file on the user’s filesystem.

When the input is converted to a string, booleans should be represented by the strings “true” and “false”, and numbers should be represented as decimal values.

Allowed values:stringnumberbooleanfilepath

Default:string

valuestring

The value for the input. If this is not set, the user may be prompted to provide a value. If a value is set, it should not be configurable by end users.

Identifiers wrapped in {curly_braces} will be replaced with the corresponding properties from the input variables map. If an identifier in braces is not found in variables, or if variables is not provided, the {curly_braces} substring should remain unchanged.

isSecretboolean

Indicates whether the input is a secret value (e.g., password, token). If true, clients should handle the value securely.

Default:false

defaultstring

The default value for the input. This should be a valid value for the input. If you want to provide input examples or guidance, use the placeholder field instead.

placeholderstring

A placeholder for the input to be displaying during configuration. This is used to provide examples or guidance about the expected form or content of the input.

choicesarray[string]

A list of possible values for the input. If provided, the user must select one of these values.

Example:[]

variablesobject

A map of variable names to their values. Keys in the input value that are wrapped in {curly_braces} will be replaced with the corresponding variable values.

Example

PositionalArgument

A positional input is a value inserted verbatim into the command line.

Any Of
descriptionstring

A description of the input, which clients can use to provide context to the user.

isRequiredboolean

Default:false

formatstring

Specifies the input format. Supported values include filepath, which should be interpreted as a file on the user’s filesystem.

When the input is converted to a string, booleans should be represented by the strings “true” and “false”, and numbers should be represented as decimal values.

Allowed values:stringnumberbooleanfilepath

Default:string

valuestring

The value for the input. If this is not set, the user may be prompted to provide a value. If a value is set, it should not be configurable by end users.

Identifiers wrapped in {curly_braces} will be replaced with the corresponding properties from the input variables map. If an identifier in braces is not found in variables, or if variables is not provided, the {curly_braces} substring should remain unchanged.

isSecretboolean

Indicates whether the input is a secret value (e.g., password, token). If true, clients should handle the value securely.

Default:false

defaultstring

The default value for the input. This should be a valid value for the input. If you want to provide input examples or guidance, use the placeholder field instead.

placeholderstring

A placeholder for the input to be displaying during configuration. This is used to provide examples or guidance about the expected form or content of the input.

choicesarray[string]

A list of possible values for the input. If provided, the user must select one of these values.

Example:[]

variablesobject

A map of variable names to their values. Keys in the input value that are wrapped in {curly_braces} will be replaced with the corresponding variable values.

typestringrequired

Allowed values:positional

Example:positional

valueHintstringrequired

An identifier for the positional argument. It is not part of the command line. It may be used by client configuration as a label identifying the argument. It is also used to identify the value in transport URL variable substitution.

Example:file_path

isRepeatedboolean

Whether the argument can be repeated multiple times in the command line.

Default:false

Example