client

Documentation

Overview

Package client provides utilities for managing client configurations and interacting with MCP servers.

Index

• Variables
• func CheckAndPerformAutoDiscoveryMigration()
• func Upsert(cf ConfigFile, name string, url string, transportType string) error
• type Client
• type ConfigFile
  • func CreateClientConfig(clientType MCPClient) (*ConfigFile, error)
  • func FindClientConfig(clientType MCPClient) (*ConfigFile, error)
  • func FindRegisteredClientConfigs(ctx context.Context) ([]ConfigFile, error)
• type ConfigUpdater
• type Extension
• type JSONConfigUpdater
  • func (jcu *JSONConfigUpdater) Remove(serverName string) error
  • func (jcu *JSONConfigUpdater) Upsert(serverName string, data MCPServer) error
• type MCPClient
• type MCPClientStatus
  • func GetClientStatus(ctx context.Context) ([]MCPClientStatus, error)
• type MCPServer
• type MCPServerConfig
• type Manager
  • func NewManager(ctx context.Context) (Manager, error)
• type RegisteredClient

Variables

var (
	// ErrConfigFileNotFound is returned when a client configuration file is not found
	ErrConfigFileNotFound = fmt.Errorf("client config file not found")
)

Functions

func CheckAndPerformAutoDiscoveryMigration

func CheckAndPerformAutoDiscoveryMigration()

CheckAndPerformAutoDiscoveryMigration checks if auto-discovery migration is needed and performs it This is called once at application startup

func Upsert

func Upsert(cf ConfigFile, name string, url string, transportType string) error

Upsert updates/inserts an MCP server in a client configuration file It is a wrapper around the ConfigUpdater.Upsert method. Because the ConfigUpdater is different for each client type, we need to handle the different types of McpServer objects. For example, VSCode and ClaudeCode allows for a `type` field, but Cursor and others do not. This allows us to build up more complex MCP server configurations for different clients without leaking them into the CMD layer.

Types

type Client

type Client struct {
	Name MCPClient `json:"name"`
}

Client represents a registered ToolHive client.

type ConfigFile

type ConfigFile struct {
	Path          string
	ClientType    MCPClient
	ConfigUpdater ConfigUpdater
	Extension     Extension
}

ConfigFile represents a client configuration file

func CreateClientConfig

func CreateClientConfig(clientType MCPClient) (*ConfigFile, error)

CreateClientConfig creates a new client configuration file for a given client type.

func FindClientConfig

func FindClientConfig(clientType MCPClient) (*ConfigFile, error)

FindClientConfig returns the client configuration file for a given client type.

func FindRegisteredClientConfigs

func FindRegisteredClientConfigs(ctx context.Context) ([]ConfigFile, error)

FindRegisteredClientConfigs finds all registered client configs and creates them if they don't exist.

type ConfigUpdater

type ConfigUpdater interface {
	Upsert(serverName string, data MCPServer) error
	Remove(serverName string) error
}

ConfigUpdater defines the interface for types which can edit MCP client config files.

type Extension

type Extension string

Extension is extension of the client config file.

const (
	// JSON represents a JSON extension.
	JSON Extension = "json"
)

type JSONConfigUpdater

type JSONConfigUpdater struct {
	Path                 string
	MCPServersPathPrefix string
}

JSONConfigUpdater is a ConfigUpdater that is responsible for updating JSON config files.

func (*JSONConfigUpdater) Remove

func (jcu *JSONConfigUpdater) Remove(serverName string) error

Remove removes an MCP server from the MCP client config file

func (*JSONConfigUpdater) Upsert

func (jcu *JSONConfigUpdater) Upsert(serverName string, data MCPServer) error

Upsert inserts or updates an MCP server in the MCP client config file

type MCPClient

type MCPClient string

MCPClient is an enum of supported MCP clients.

const (
	// RooCode represents the Roo Code extension for VS Code.
	RooCode MCPClient = "roo-code"
	// Cline represents the Cline extension for VS Code.
	Cline MCPClient = "cline"
	// Cursor represents the Cursor editor.
	Cursor MCPClient = "cursor"
	// VSCodeInsider represents the VS Code Insiders editor.
	VSCodeInsider MCPClient = "vscode-insider"
	// VSCode represents the standard VS Code editor.
	VSCode MCPClient = "vscode"
	// ClaudeCode represents the Claude Code CLI.
	ClaudeCode MCPClient = "claude-code"
	// Windsurf represents the Windsurf IDE.
	Windsurf MCPClient = "windsurf"
	// WindsurfJetBrains represents the Windsurf plugin for JetBrains.
	WindsurfJetBrains MCPClient = "windsurf-jetbrains"
	// AmpCli represents the Sourcegraph Amp CLI.
	AmpCli MCPClient = "amp-cli"
	// AmpVSCode represents the Sourcegraph Amp extension for VS Code.
	AmpVSCode MCPClient = "amp-vscode"
	// AmpCursor represents the Sourcegraph Amp extension for Cursor.
	AmpCursor MCPClient = "amp-cursor"
	// AmpVSCodeInsider represents the Sourcegraph Amp extension for VS Code Insiders.
	AmpVSCodeInsider MCPClient = "amp-vscode-insider"
	// AmpWindsurf represents the Sourcegraph Amp extension for Windsurf.
	AmpWindsurf MCPClient = "amp-windsurf"
)

type MCPClientStatus

type MCPClientStatus struct {
	// ClientType is the type of MCP client
	ClientType MCPClient `json:"client_type"`

	// Installed indicates whether the client is installed on the system
	Installed bool `json:"installed"`

	// Registered indicates whether the client is registered in the ToolHive configuration
	Registered bool `json:"registered"`
}

MCPClientStatus represents the status of a supported MCP client

func GetClientStatus

func GetClientStatus(ctx context.Context) ([]MCPClientStatus, error)

GetClientStatus returns the installation status of all supported MCP clients

type MCPServer

type MCPServer struct {
	Url       string `json:"url,omitempty"`
	ServerUrl string `json:"serverUrl,omitempty"`
	Type      string `json:"type,omitempty"`
}

MCPServer represents an MCP server in a MCP client config file

type MCPServerConfig

type MCPServerConfig struct {
	URL string `json:"url,omitempty"`
}

MCPServerConfig represents an MCP server configuration in a client config file

type Manager

type Manager interface {
	// ListClients returns a list of all registered clients with their group information.
	ListClients(ctx context.Context) ([]RegisteredClient, error)
	// RegisterClients registers multiple clients with ToolHive for the specified workloads.
	RegisterClients(clients []Client, workloads []core.Workload) error
	// UnregisterClients unregisters multiple clients from ToolHive for the specified workloads.
	UnregisterClients(ctx context.Context, clients []Client, workloads []core.Workload) error
	// AddServerToClients adds an MCP server to the appropriate client configurations.
	AddServerToClients(ctx context.Context, serverName, serverURL, transportType, group string) error
	// RemoveServerFromClients removes an MCP server from the appropriate client configurations.
	RemoveServerFromClients(ctx context.Context, serverName, group string) error
}

Manager is the interface for managing registered ToolHive clients.

func NewManager

func NewManager(ctx context.Context) (Manager, error)

NewManager creates a new client manager instance.

type RegisteredClient

type RegisteredClient struct {
	Name   MCPClient `json:"name"`
	Groups []string  `json:"groups"`
}

RegisteredClient represents a registered client with its associated groups.