Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

mcp_server

package

Go to main page

Versions in this module

v0

v0.9.339

Jan 14, 2026

v0.9.337

Jan 7, 2026

v0.9.315

Dec 5, 2025

v0.9.311

Dec 3, 2025

v0.9.266

Nov 30, 2025

Changes in this version

type Backend

+ ExecQuery func(ctx context.Context, query string) (map[string]any, error)

+ ValidateQuery func(ctx context.Context, query string) ([]map[string]any, error)

type ExampleBackend

+ func (b *ExampleBackend) ExecQuery(ctx context.Context, query string) (map[string]any, error)

+ func (b *ExampleBackend) ValidateQuery(ctx context.Context, query string) ([]map[string]any, error)

v0.9.250

Oct 26, 2025

Changes in this version

+ const DefaultHTTPServerAddress

+ const ExplainerFindRelationships

+ const ExplainerForeignKeyStackql

+ const ExplainerPromptWriteSafeSelectTool

+ const MCPClientTypeHTTP

+ const MCPClientTypeSTDIO

+ type Backend interface

+ Close func() error

+ DBIdentity func(ctx context.Context, args any) (map[string]any, error)

+ DescribeTable func(ctx context.Context, hI HierarchyInput) (string, error)

+ FindRelationships func(ctx context.Context, hI HierarchyInput) (string, error)

+ GetForeignKeys func(ctx context.Context, hI HierarchyInput) (string, error)

+ Greet func(ctx context.Context, args GreetInput) (string, error)

+ ListMethods func(ctx context.Context, hI HierarchyInput) (string, error)

+ ListProviders func(ctx context.Context) (string, error)

+ ListResources func(ctx context.Context, hI HierarchyInput) (string, error)

+ ListServices func(ctx context.Context, hI HierarchyInput) (string, error)

+ ListTablesJSON func(ctx context.Context, input ListTablesInput) ([]map[string]interface{}, error)

+ ListTablesJSONPage func(ctx context.Context, input ListTablesPageInput) (map[string]interface{}, error)

+ Ping func(ctx context.Context) error

+ PromptWriteSafeSelectTool func(ctx context.Context, args HierarchyInput) (string, error)

+ RunQuery func(ctx context.Context, args QueryInput) (string, error)

+ RunQueryJSON func(ctx context.Context, input QueryJSONInput) ([]map[string]interface{}, error)

+ ServerInfo func(ctx context.Context, args any) (ServerInfoOutput, error)

+ func NewExampleBackend(connectionString string) Backend

+ type BackendConfig struct

+ AppName string

+ ConnectionString string

+ ConnectionTimeout Duration

+ MaxConnections int

+ QueryTimeout Duration

+ Type string

+ type BackendError struct

+ Code string

+ Details map[string]interface{}

+ Message string

+ func (e *BackendError) Error() string

+ func (e *BackendError) Value() (driver.Value, error)

+ type ColumnInfo interface

+ GetName func() string

+ GetType func() string

+ IsNullable func() bool

+ func NewColumnInfo(name, colType string, nullable bool) ColumnInfo

+ type Config struct

+ Backend BackendConfig

+ Server ServerConfig

+ func DefaultConfig() *Config

+ func DefaultHTTPConfig() *Config

+ func DefaultSSEConfig() *Config

+ func LoadFromJSON(data []byte) (*Config, error)

+ func LoadFromYAML(data []byte) (*Config, error)

+ func (c *Config) GetBackendConnectionString() string

+ func (c *Config) GetServerAddress() string

+ func (c *Config) GetServerTransport() string

+ func (c *Config) IsTcpBackend() bool

+ func (c *Config) Validate() error

+ type Duration time.Duration

+ func (d *Duration) UnmarshalJSON(data []byte) error

+ func (d *Duration) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (d Duration) MarshalJSON() ([]byte, error)

+ func (d Duration) MarshalYAML() (interface{}, error)

+ type ExampleBackend struct

+ func (b *ExampleBackend) Close() error

+ func (b *ExampleBackend) DBIdentity(ctx context.Context, _ any) (map[string]any, error)

+ func (b *ExampleBackend) DescribeTable(ctx context.Context, hI HierarchyInput) (string, error)

+ func (b *ExampleBackend) FindRelationships(ctx context.Context, hI HierarchyInput) (string, error)

+ func (b *ExampleBackend) GetForeignKeys(ctx context.Context, hI HierarchyInput) (string, error)

+ func (b *ExampleBackend) Greet(ctx context.Context, args GreetInput) (string, error)

+ func (b *ExampleBackend) ListMethods(ctx context.Context, hI HierarchyInput) (string, error)

+ func (b *ExampleBackend) ListProviders(ctx context.Context) (string, error)

+ func (b *ExampleBackend) ListResources(ctx context.Context, hI HierarchyInput) (string, error)

+ func (b *ExampleBackend) ListServices(ctx context.Context, hI HierarchyInput) (string, error)

+ func (b *ExampleBackend) ListTables(ctx context.Context, hI HierarchyInput) (string, error)

+ func (b *ExampleBackend) ListTablesJSON(ctx context.Context, input ListTablesInput) ([]map[string]interface{}, error)

+ func (b *ExampleBackend) ListTablesJSONPage(ctx context.Context, input ListTablesPageInput) (map[string]interface{}, error)

+ func (b *ExampleBackend) Ping(ctx context.Context) error

+ func (b *ExampleBackend) PromptWriteSafeSelectTool(ctx context.Context, args HierarchyInput) (string, error)

+ func (b *ExampleBackend) ReadTableResource(ctx context.Context, hI HierarchyInput) ([]map[string]interface{}, error)

+ func (b *ExampleBackend) RunQuery(ctx context.Context, args QueryInput) (string, error)

+ func (b *ExampleBackend) RunQueryJSON(ctx context.Context, input QueryJSONInput) ([]map[string]interface{}, error)

+ func (b *ExampleBackend) ServerInfo(ctx context.Context, _ any) (ServerInfoOutput, error)

+ type Field interface

+ GetDescription func() string

+ GetName func() string

+ GetType func() string

+ IsRequired func() bool

+ func NewField(name, fieldType string, required bool, description string) Field

+ type GreetInput struct

+ Name string

+ type GreetingInput struct

+ Name string

+ type GreetingOutput struct

+ Greeting string

+ type HierarchyInput struct

+ Format string

+ Method string

+ Provider string

+ Resource string

+ RowLimit int

+ Service string

+ type ListSchemasInput struct

+ CaseSensitive bool

+ Format string

+ IncludeSystem bool

+ IncludeTemp bool

+ NameLike *string

+ RequireUsage bool

+ RowLimit int

+ type ListSchemasPageInput struct

+ CaseSensitive bool

+ Cursor *string

+ Format string

+ IncludeSystem bool

+ IncludeTemp bool

+ NameLike *string

+ PageSize int

+ RequireUsage bool

+ type ListTablesInput struct

+ CaseSensitive bool

+ Format string

+ Hierarchy *HierarchyInput

+ NameLike *string

+ RowLimit int

+ TableTypes []string

+ type ListTablesPageInput struct

+ CaseSensitive bool

+ Cursor *string

+ Format string

+ Hierarchy *HierarchyInput

+ NameLike *string

+ PageSize int

+ TableTypes []string

+ type MCPClient interface

+ CallToolText func(toolName string, args map[string]any) (string, error)

+ InspectTools func() ([]map[string]any, error)

+ func NewMCPClient(clientType string, baseURL string, clientCfgMap map[string]any, ...) (MCPClient, error)

+ type MCPServer interface

+ Start func(context.Context) error

+ Stop func() error

+ func NewAgnosticBackendServer(backend Backend, config *Config, logger *logrus.Logger) (MCPServer, error)

+ func NewExampleBackendServer(config *Config, logger *logrus.Logger) (MCPServer, error)

+ func NewMCPServerWithExampleBackend(config *Config) (MCPServer, error)

+ type Provider interface

+ GetName func() string

+ GetServices func() []Service

+ GetVersion func() string

+ func NewProvider(name, version string, services []Service) Provider

+ type QueryInput struct

+ Format string

+ RowLimit int

+ SQL string

+ type QueryJSONInput struct

+ RowLimit int

+ SQL string

+ type QueryResult interface

+ GetColumns func() []ColumnInfo

+ GetExecutionTime func() int64

+ GetRows func() [][]interface{}

+ GetRowsAffected func() int64

+ func NewQueryResult(columns []ColumnInfo, rows [][]interface{}, rowsAffected, executionTime int64) QueryResult

+ type Resource interface

+ GetFields func() []Field

+ GetMethods func() []string

+ GetName func() string

+ func NewResource(name string, methods []string, fields []Field) Resource

+ type SchemaProvider interface

+ GetProviders func() []Provider

+ func NewSchemaProvider(providers []Provider) SchemaProvider

+ type ServerConfig struct

+ Address string

+ Description string

+ IsReadOnly *bool

+ MaxConcurrentRequests int

+ Name string

+ RequestTimeout Duration

+ Scheme string

+ TLSCertFile string

+ TLSKeyFile string

+ Transport string

+ TransportCfg map[string]any

+ Version string

+ type ServerInfoOutput struct

+ Info string

+ IsReadOnly bool

+ Name string

+ type Service interface

+ GetName func() string

+ GetResources func() []Resource

+ func NewService(name string, resources []Resource) Service