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

NamedArgument

A command-line --flag={value}.

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:named

Example:named

namestringrequired

The flag name, including any leading dashes.

Example:--port

isRepeatedboolean

Whether the argument can be repeated multiple times.

Default:false

Example

KeyValueInput

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.

namestringrequired

Name of the header or environment variable.

Example:SOME_VARIABLE

Example

Argument

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.

Any Of
PositionalArgumentAny Of
PositionalArgumentobject

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

Show Child Parameters
Example

StdioTransport

object
typestringrequired

Transport type

Allowed values:stdio

Example:stdio

Example