server

package

v0.44.3 Latest Latest Go to latest Published: Oct 26, 2026 License: MIT Imports: 25 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 ¶

func Disable(ctx context.Context, docker docker.Client, dockerCli command.Cli, ...) error
func Enable(ctx context.Context, docker docker.Client, dockerCli command.Cli, ...) error
func Init(_ context.Context, dir string, language string, templateName string) error
type ConfigStatus
- func (cs ConfigStatus) DisplayString() string
type Info
- func Inspect(ctx context.Context, dockerClient docker.Client, serverName string) (Info, error)
- func (s Info) ToJSON() ([]byte, error)
type ListEntry
- func List(ctx context.Context, docker docker.Client, policyClient policy.Client, ...) ([]ListEntry, error)
type Tool
type ToolArgument

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Disable ¶

func Disable(ctx context.Context, docker docker.Client, dockerCli command.Cli, serverNames []string, mcpOAuthDcrEnabled bool) error

func Enable ¶

func Enable(ctx context.Context, docker docker.Client, dockerCli command.Cli, serverNames []string, mcpOAuthDcrEnabled bool) error

func Init ¶ added in v0.25.0

func Init(_ context.Context, dir string, language string, templateName string) error

Init initializes a new MCP server project in the specified directory

Types ¶

type ConfigStatus ¶ added in v0.27.0

type ConfigStatus string

const (
	ConfigStatusNone     ConfigStatus = "none"     // No configuration needed
	ConfigStatusRequired ConfigStatus = "required" // Configuration required but not set
	ConfigStatusPartial  ConfigStatus = "partial"  // Some configuration set but not all
	ConfigStatusDone     ConfigStatus = "done"     // All configuration complete
)

func (ConfigStatus) DisplayString ¶ added in v0.27.0

func (cs ConfigStatus) DisplayString() string

DisplayString returns the display string for a ConfigStatus

type Info ¶

type Info struct {
	Tools  []Tool `json:"tools"`
	Readme string `json:"readme"`
	// Policy describes the policy decision for this server.
	Policy *policy.Decision `json:"policy,omitempty"`
}

func Inspect ¶

func Inspect(ctx context.Context, dockerClient docker.Client, serverName string) (Info, error)

func (Info) ToJSON ¶

func (s Info) ToJSON() ([]byte, error)

type ListEntry ¶ added in v0.27.0

type ListEntry struct {
	Name        string       `json:"name"`
	Description string       `json:"description"`
	Secrets     ConfigStatus `json:"secrets"`
	Config      ConfigStatus `json:"config"`
	OAuth       ConfigStatus `json:"oauth"`
	// Policy describes the policy decision for this server.
	Policy *policy.Decision `json:"policy,omitempty"`
}

func List ¶

func List(ctx context.Context, docker docker.Client, policyClient policy.Client, quiet bool) ([]ListEntry, error)

type Tool ¶ added in v0.16.0

type Tool struct {
	Name        string                     `json:"name"`
	Description string                     `json:"description"`
	Arguments   []ToolArgument             `json:"arguments,omitempty"`
	Annotations map[string]json.RawMessage `json:"annotations,omitempty"`
	Enabled     bool                       `json:"enabled"`
	// Policy describes the policy decision for this tool.
	Policy *policy.Decision `json:"policy,omitempty"`
}

type ToolArgument ¶ added in v0.16.0

type ToolArgument struct {
	Name string `json:"name"`
	Type string `json:"type"`
	Desc string `json:"desc"`
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
templates
basic command
chatgpt-app-basic command

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