Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func InstallMCPForClient ¶
func InstallMCPForClient(opts InstallOptions) error
InstallMCPForClient installs an MCP server configuration for the specified client. This is a generic, configurable function exported for use by external projects via pkg/mcpinstall. Required options: ServerName, Command, Args must all be provided.
Types ¶
type ArgsLenAtDashProvider ¶
type ArgsLenAtDashProvider interface {
ArgsLenAtDash() int
}
ArgsLenAtDashProvider defines the interface for getting ArgsLenAtDash
type ClientInfo ¶
type ClientInfo struct {
// Name is the human-readable display name (e.g., "Claude Code", "Cursor")
Name string
// ClientName is the identifier to use in InstallOptions.ClientName (e.g., "claude-code", "cursor")
ClientName string
}
ClientInfo contains information about a supported MCP client.
func SupportedClients ¶
func SupportedClients() []ClientInfo
SupportedClients returns information about all supported MCP clients.
type ClientOption ¶
type ClientOption struct {
Name string // Display name
ClientName string // Client name to pass to installMCPForClient
}
ClientOption represents a client choice for interactive selection
type CreateRoleResult ¶
type CreateRoleResult struct {
RoleName string `json:"role_name"`
ReadOnly bool `json:"read_only,omitempty"`
StatementTimeout string `json:"statement_timeout,omitempty"`
FromRoles []string `json:"from_roles,omitempty"`
}
CreateRoleResult represents the output of a create role operation
type InstallOptions ¶
type InstallOptions struct {
// ClientName is the name of the client to configure (required)
ClientName string
// ServerName is the name to register the MCP server as (required)
ServerName string
// Command is the path to the MCP server binary (required)
Command string
// Args are the arguments to pass to the MCP server binary (required)
Args []string
// CreateBackup creates a backup of existing config files before modification
CreateBackup bool
// CustomConfigPath overrides the default config file location
CustomConfigPath string
}
InstallOptions configures the MCP server installation behavior
type MCPServerConfig ¶
MCPServerConfig represents the MCP server configuration
type OutputService ¶
type OutputService struct {
api.Service
common.ConnectionDetails
ConnectionString string `json:"connection_string,omitempty"`
ConsoleURL string `json:"console_url,omitempty"`
}
OutputService represents a service with computed fields for output
type VersionOutput ¶
type VersionOutput struct {
Version string `json:"version"`
BuildTime string `json:"build_time"`
GitCommit string `json:"git_commit"`
GoVersion string `json:"go_version"`
Platform string `json:"platform"`
LatestVersion string `json:"latest_version,omitempty"`
UpdateAvailable *bool `json:"update_available,omitempty"`
}
Source Files
¶
- auth.go
- auth_login.go
- auth_logout.go
- auth_status.go
- completion_helper.go
- config.go
- config_reset.go
- config_set.go
- config_show.go
- config_unset.go
- db.go
- db_connect.go
- db_connection_string.go
- db_create.go
- db_create_role.go
- db_save_password.go
- db_schema.go
- db_test_connection.go
- flag_helper.go
- logger_helper.go
- mcp.go
- mcp_get.go
- mcp_install.go
- mcp_list.go
- mcp_start.go
- mcp_start_http.go
- mcp_start_stdio.go
- password_helper.go
- project.go
- project_helper.go
- project_use.go
- root.go
- service.go
- service_create.go
- service_delete.go
- service_fork.go
- service_get.go
- service_list.go
- service_logs.go
- service_metrics.go
- service_metrics_available_series.go
- service_metrics_series.go
- service_resize.go
- service_start.go
- service_stop.go
- service_update_password.go
- upgrade.go
- version.go