catalog

package

v0.24.0 Latest Latest Go to latest Published: Oct 17, 2025 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/docker/mcp-gateway

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Add(args ParsedAddArgs, force bool) error
func Bootstrap(ctx context.Context, outputPath string) error
func Create(name string) error
func DownloadFile(ctx context.Context, url string) ([]byte, error)
func Export(_ context.Context, catalogName, outputPath string) error
func Fork(src, dst string) error
func GetDockerCatalogURL(mcpOAuthDcrEnabled bool) string
func Import(ctx context.Context, nameOrURL string) error
func Init(ctx context.Context) error
func Ls(ctx context.Context, format Format) error
func ReadCatalogFile(name string) ([]byte, error)
func Reset(context.Context) error
func Rm(name string) error
func Show(ctx context.Context, name string, format Format, mcpOAuthDcrEnabled bool) error
func SupportedFormats() string
func Update(ctx context.Context, args []string, mcpOAuthDcrEnabled bool) error
func ValidateArgs(args ParsedAddArgs) error
func WriteCatalogFile(name string, content []byte) error
func WriteConfig(cfg *Config) error
type Catalog
type Config
- func ReadConfig() (*Config, error)
- func ReadConfigWithDefaultCatalog(ctx context.Context) (*Config, error)
type Format
- func (e *Format) Set(v string) error
- func (e *Format) String() string
- func (e *Format) Type() string
type MetaData
type ParsedAddArgs
- func ParseAddArgs(dst, src, catalogFile string) *ParsedAddArgs
type Registry
type Tile

Constants ¶

View Source

const (
	DockerCatalogName     = "docker-mcp"
	DockerCatalogURLV2    = "https://desktop.docker.com/mcp/catalog/v2/catalog.yaml"
	DockerCatalogURLV3    = "https://desktop.docker.com/mcp/catalog/v3/catalog.yaml"
	DockerCatalogFilename = "docker-mcp.yaml"

	// Docker server names for bootstrap command
	DockerHubServerName = "dockerhub"
	DockerCLIServerName = "docker"
)

Variables ¶

This section is empty.

Functions ¶

func Add ¶ added in v0.11.0

func Add(args ParsedAddArgs, force bool) error

func Bootstrap ¶ added in v0.14.0

func Bootstrap(ctx context.Context, outputPath string) error

Bootstrap creates a starter catalog file with Docker and Docker Hub server entries as examples

func Create ¶ added in v0.11.0

func Create(name string) error

func DownloadFile ¶

func DownloadFile(ctx context.Context, url string) ([]byte, error)

func Export ¶ added in v0.14.0

func Export(_ context.Context, catalogName, outputPath string) error

Export exports a configured catalog to a file This function only allows exporting user-managed catalogs, not the Docker catalog

func Fork ¶ added in v0.11.0

func Fork(src, dst string) error

func GetDockerCatalogURL ¶ added in v0.24.0

func GetDockerCatalogURL(mcpOAuthDcrEnabled bool) string

GetDockerCatalogURL returns the appropriate Docker catalog URL based on the mcp-oauth-dcr flag

func Import ¶ added in v0.11.0

func Import(ctx context.Context, nameOrURL string) error

func Init ¶ added in v0.11.0

func Init(ctx context.Context) error

func Ls ¶ added in v0.11.0

func Ls(ctx context.Context, format Format) error

func ReadCatalogFile ¶

func ReadCatalogFile(name string) ([]byte, error)

func Reset ¶ added in v0.11.0

func Reset(context.Context) error

func Rm ¶ added in v0.11.0

func Rm(name string) error

func Show ¶ added in v0.11.0

func Show(ctx context.Context, name string, format Format, mcpOAuthDcrEnabled bool) error

func SupportedFormats ¶ added in v0.11.0

func SupportedFormats() string

func Update ¶ added in v0.11.0

func Update(ctx context.Context, args []string, mcpOAuthDcrEnabled bool) error

func ValidateArgs ¶ added in v0.11.0

func ValidateArgs(args ParsedAddArgs) error

func WriteCatalogFile ¶

func WriteCatalogFile(name string, content []byte) error

func WriteConfig ¶

func WriteConfig(cfg *Config) error

Types ¶

type Catalog ¶

type Catalog struct {
	DisplayName string `json:"displayName"`
	URL         string `json:"url,omitempty"`
	LastUpdate  string `json:"lastUpdate,omitempty"`
}

type Config ¶

type Config struct {
	Catalogs map[string]Catalog `json:"catalogs"`
}

func ReadConfig ¶

func ReadConfig() (*Config, error)

func ReadConfigWithDefaultCatalog ¶

func ReadConfigWithDefaultCatalog(ctx context.Context) (*Config, error)

type Format ¶

type Format string

const (
	JSON Format = "json"
	YAML Format = "yaml"
)

func (*Format) Set ¶

func (e *Format) Set(v string) error

func (*Format) String ¶

func (e *Format) String() string

func (*Format) Type ¶

func (e *Format) Type() string

Type is only used in help text

type MetaData ¶

type MetaData struct {
	Name        string `yaml:"name,omitempty"`
	DisplayName string `yaml:"displayName,omitempty"`
}

type ParsedAddArgs ¶

type ParsedAddArgs struct {
	Src       string
	Dst       string
	SeverName string
}

func ParseAddArgs ¶ added in v0.11.0

func ParseAddArgs(dst, src, catalogFile string) *ParsedAddArgs

type Registry ¶

type Registry struct {
	Registry map[string]Tile `yaml:"registry"`
}

type Tile ¶

type Tile struct {
	Description string `yaml:"description"`
	ReadmeURL   string `yaml:"readme"`
	ToolsURL    string `yaml:"toolsUrl"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL