commands

Documentation

Overview

Package commands implements individual commands for the MCP CLI.

Package commands implements individual commands for the MCP CLI.

Index

• Constants
• Variables
• func AliasCmd() *cobra.Command
• func CallCmd() *cobra.Command
• func ConfigsCmd() *cobra.Command
• func FormatAndPrintResponse(cmd *cobra.Command, resp map[string]any, err error) error
• func GetPromptCmd() *cobra.Command
• func GuardCmd() *cobra.Command
• func IsHTTP(str string) bool
• func IsValidFormat(format string) bool
• func LoadProxyConfig() (map[string]map[string]string, error)
• func MockCmd() *cobra.Command
• func NewCmd() *cobra.Command
• func ProcessFlags(args []string) []string
• func PromptsCmd() *cobra.Command
• func ProxyCmd() *cobra.Command
• func ProxyStartCmd() *cobra.Command
• func ProxyToolCmd() *cobra.Command
• func ReadResourceCmd() *cobra.Command
• func ResourcesCmd() *cobra.Command
• func RootCmd() *cobra.Command
• func SaveProxyConfig(config map[string]map[string]string) error
• func ShellCmd() *cobra.Command
• func ToolsCmd() *cobra.Command
• func VersionCmd() *cobra.Command
• type ConfigAlias
• type ConfigsFile
• type MockTransport
  • func (m *MockTransport) Execute(method string, params any) (map[string]any, error)
• type ServerConfig

Constants

const (
	FlagAllow      = "--allow"
	FlagAllowShort = "-a"
	FlagDeny       = "--deny"
	FlagDenyShort  = "-d"
)

Guard flags.

const (
	FlagFormat      = "--format"
	FlagFormatShort = "-f"
	FlagParams      = "--params"
	FlagParamsShort = "-p"
	FlagHelp        = "--help"
	FlagHelpShort   = "-h"
	FlagServerLogs  = "--server-logs"
)

flags.

const (
	EntityTypeTool   = "tool"
	EntityTypePrompt = "prompt"
	EntityTypeRes    = "resource"
)

entity types.

Variables

var (
	// FormatOption is the format option for the command, valid values are "table", "json", and
	// "pretty".
	// Default is "table".
	FormatOption = "table"
	// ParamsString is the params for the command.
	ParamsString string
	// ShowServerLogs is a flag to show server logs.
	ShowServerLogs bool
)

var ConfigFileOption string

ConfigFileOption stores the path to the configuration file.

var CreateClientFunc = func(args []string, opts ...client.Option) (*client.Client, error) {
	if len(args) == 0 {
		return nil, ErrCommandRequired
	}

	opts = append(opts, client.SetShowServerLogs(ShowServerLogs))

	if len(args) == 1 {
		server, found := alias.GetServerCommand(args[0])
		if found {
			if IsHTTP(server) {
				return client.NewHTTP(server), nil
			}
			cmdParts := client.ParseCommandString(server)
			c := client.NewStdio(cmdParts, opts...)
			return c, nil
		}
	}

	if len(args) == 1 && IsHTTP(args[0]) {
		return client.NewHTTP(args[0]), nil
	}

	c := client.NewStdio(args, opts...)

	return c, nil
}

CreateClientFunc is the function used to create MCP clients. This can be replaced in tests to use a mock transport.

var EnvOption string

EnvOption stores the environment variables.

var (
	ErrCommandRequired = fmt.Errorf("command to execute is required when using stdio transport")
)

sentinel errors.

var HeadersOption string

HeadersOption stores the headers for URL-based servers.

var TemplatesPath = os.Getenv("HOME") + "/.mcpt/templates"

TemplatesPath information placeholder.

var URLOption string

URLOption stores the URL for URL-based servers.

var Version = "dev"

Version information placeholder.

Functions

func AliasCmd

func AliasCmd() *cobra.Command

AliasCmd creates the alias command.

func CallCmd

func CallCmd() *cobra.Command

CallCmd creates the call command.

func ConfigsCmd

func ConfigsCmd() *cobra.Command

ConfigsCmd creates the configs command.

func FormatAndPrintResponse

func FormatAndPrintResponse(cmd *cobra.Command, resp map[string]any, err error) error

FormatAndPrintResponse formats and prints an MCP response in the format specified by FormatOption.

func GetPromptCmd

func GetPromptCmd() *cobra.Command

GetPromptCmd creates the get-prompt command.

func GuardCmd

func GuardCmd() *cobra.Command

GuardCmd creates the guard command to filter tools, prompts, and resources.

func IsHTTP

func IsHTTP(str string) bool

IsHTTP returns true if the string is a valid HTTP URL.

func IsValidFormat

func IsValidFormat(format string) bool

IsValidFormat returns true if the format is valid.

func LoadProxyConfig

func LoadProxyConfig() (map[string]map[string]string, error)

LoadProxyConfig loads the proxy configuration from the config file.

func MockCmd

func MockCmd() *cobra.Command

MockCmd creates the mock command.

func NewCmd

func NewCmd() *cobra.Command

NewCmd returns a new 'new' command for scaffolding MCP projects.

func ProcessFlags

func ProcessFlags(args []string) []string

ProcessFlags processes command line flags, sets the format option, and returns the remaining arguments. Supported format options: json, pretty, and table.

For example, if the input arguments are ["tools", "--format", "pretty", "npx", "-y", "@modelcontextprotocol/server-filesystem", "~"], it would return ["npx", "-y", "@modelcontextprotocol/server-filesystem", "~"] and set the format option to "pretty".

func PromptsCmd

func PromptsCmd() *cobra.Command

PromptsCmd creates the prompts command.

func ProxyCmd

func ProxyCmd() *cobra.Command

ProxyCmd creates the proxy command.

func ProxyStartCmd

func ProxyStartCmd() *cobra.Command

ProxyStartCmd creates the proxy start command.

func ProxyToolCmd

func ProxyToolCmd() *cobra.Command

ProxyToolCmd creates the proxy tool command.

func ReadResourceCmd

func ReadResourceCmd() *cobra.Command

ReadResourceCmd creates the read-resource command.

func ResourcesCmd

func ResourcesCmd() *cobra.Command

ResourcesCmd creates the resources command.

func RootCmd

func RootCmd() *cobra.Command

RootCmd creates the root command.

func SaveProxyConfig

func SaveProxyConfig(config map[string]map[string]string) error

SaveProxyConfig saves the proxy configuration to the config file.

func ShellCmd

func ShellCmd() *cobra.Command

ShellCmd creates the shell command.

func ToolsCmd

func ToolsCmd() *cobra.Command

ToolsCmd creates the tools command.

func VersionCmd

func VersionCmd() *cobra.Command

VersionCmd creates the version command.

Types

type ConfigAlias

type ConfigAlias struct {
	Path     string `json:"path"`
	JSONPath string `json:"jsonPath"`
	Source   string `json:"source,omitempty"`
}

ConfigAlias represents a configuration alias.

type ConfigsFile

type ConfigsFile struct {
	Aliases map[string]ConfigAlias `json:"aliases"`
}

ConfigsFile represents the structure of the configs file.

type MockTransport

type MockTransport struct {
	ExecuteFunc func(method string, params any) (map[string]any, error)
}

MockTransport implements the transport.Transport interface for testing.

func (*MockTransport) Execute

func (m *MockTransport) Execute(method string, params any) (map[string]any, error)

Execute calls the mock implementation.

type ServerConfig

type ServerConfig struct {
	Headers     map[string]string      `json:"headers,omitempty"`
	Env         map[string]string      `json:"env,omitempty"`
	Config      map[string]interface{} `json:"config,omitempty"`
	Source      string                 `json:"source"`
	Type        string                 `json:"type,omitempty"`
	Command     string                 `json:"command,omitempty"`
	URL         string                 `json:"url,omitempty"`
	Path        string                 `json:"path,omitempty"`
	Name        string                 `json:"name,omitempty"`
	Description string                 `json:"description,omitempty"`
	Args        []string               `json:"args,omitempty"`
}

ServerConfig represents a configuration for a server.