Documentation
¶
Overview ¶
Package mcp implements an in-process Model Context Protocol server.
The MCP server allows users to register custom tools that the agent can invoke during execution. Tools are registered via the SDK and exposed through the protocol controller's MCP message handler.
Index ¶
- func ErrorResult(message string) *mcp.CallToolResult
- func ImageResult(data []byte, mimeType string) *mcp.CallToolResult
- func NewTool(name, description string, inputSchema *jsonschema.Schema) *mcp.Tool
- func ParseArguments(req *mcp.CallToolRequest) (map[string]any, error)
- func SimpleSchema(props map[string]string) *jsonschema.Schema
- func TextResult(text string) *mcp.CallToolResult
- type HTTPServerConfig
- type SDKServer
- func (s *SDKServer) AddTool(tool *mcp.Tool, handler mcp.ToolHandler)
- func (s *SDKServer) CallTool(ctx context.Context, name string, input map[string]any) (map[string]any, error)
- func (s *SDKServer) Capabilities() map[string]any
- func (s *SDKServer) ListTools() []map[string]any
- func (s *SDKServer) Name() string
- func (s *SDKServer) ServerInfo() map[string]any
- func (s *SDKServer) Version() string
- type SSEServerConfig
- type SdkServerConfig
- type ServerConfig
- type ServerInstance
- type ServerStatus
- type ServerType
- type Status
- type StdioServerConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ErrorResult ¶
func ErrorResult(message string) *mcp.CallToolResult
ErrorResult creates a CallToolResult indicating an error.
func ImageResult ¶
func ImageResult(data []byte, mimeType string) *mcp.CallToolResult
ImageResult creates a CallToolResult with image content.
func NewTool ¶
func NewTool(name, description string, inputSchema *jsonschema.Schema) *mcp.Tool
NewTool creates an mcp.Tool with the given parameters.
func ParseArguments ¶
func ParseArguments(req *mcp.CallToolRequest) (map[string]any, error)
ParseArguments unmarshals CallToolRequest arguments into a map.
func SimpleSchema ¶
func SimpleSchema(props map[string]string) *jsonschema.Schema
SimpleSchema creates a jsonschema.Schema from a simple type map.
func TextResult ¶
func TextResult(text string) *mcp.CallToolResult
TextResult creates a CallToolResult with text content.
Types ¶
type HTTPServerConfig ¶
type HTTPServerConfig struct {
Type ServerType `json:"type"`
URL string `json:"url"`
Headers map[string]string `json:"headers,omitempty"`
}
HTTPServerConfig configures an HTTP-based MCP server.
func (*HTTPServerConfig) GetType ¶
func (m *HTTPServerConfig) GetType() ServerType
GetType implements ServerConfig.
type SDKServer ¶
type SDKServer struct {
// contains filtered or unexported fields
}
SDKServer wraps the official MCP SDK server for programmatic access.
func NewSDKServer ¶
NewSDKServer creates a new MCP SDK server wrapper.
func (*SDKServer) AddTool ¶
func (s *SDKServer) AddTool(tool *mcp.Tool, handler mcp.ToolHandler)
AddTool registers a tool with the server.
func (*SDKServer) CallTool ¶
func (s *SDKServer) CallTool( ctx context.Context, name string, input map[string]any, ) (map[string]any, error)
CallTool executes a tool by name with the given input.
func (*SDKServer) Capabilities ¶
Capabilities returns server capabilities for MCP initialize response.
func (*SDKServer) ServerInfo ¶
ServerInfo returns server information for MCP initialize response.
type SSEServerConfig ¶
type SSEServerConfig struct {
Type ServerType `json:"type"`
URL string `json:"url"`
Headers map[string]string `json:"headers,omitempty"`
}
SSEServerConfig configures a Server-Sent Events MCP server.
func (*SSEServerConfig) GetType ¶
func (m *SSEServerConfig) GetType() ServerType
GetType implements ServerConfig.
type SdkServerConfig ¶
type SdkServerConfig struct {
Type ServerType `json:"type"`
Name string `json:"name"`
Instance any `json:"-"`
}
SdkServerConfig configures an SDK-provided MCP server.
func (*SdkServerConfig) GetType ¶
func (m *SdkServerConfig) GetType() ServerType
GetType implements ServerConfig.
type ServerConfig ¶
type ServerConfig interface {
GetType() ServerType
}
ServerConfig is the interface for MCP server configurations.
type ServerInstance ¶
type ServerInstance interface {
// Name returns the server name.
Name() string
// Version returns the server version.
Version() string
// ListTools returns metadata for all registered tools.
ListTools() []map[string]any
// CallTool executes a tool by name with the given input.
CallTool(ctx context.Context, name string, input map[string]any) (map[string]any, error)
}
ServerInstance is the interface that SDK MCP servers must implement.
type ServerStatus ¶
ServerStatus represents the connection status of a single MCP server.
type ServerType ¶
type ServerType string
ServerType represents the type of MCP server.
const ( // ServerTypeStdio uses stdio for communication. ServerTypeStdio ServerType = "stdio" // ServerTypeSSE uses Server-Sent Events. ServerTypeSSE ServerType = "sse" // ServerTypeHTTP uses HTTP for communication. ServerTypeHTTP ServerType = "http" // ServerTypeSDK uses the SDK interface. ServerTypeSDK ServerType = "sdk" )
type Status ¶
type Status struct {
MCPServers []ServerStatus `json:"mcpServers"`
}
Status represents the connection status of all configured MCP servers.
type StdioServerConfig ¶
type StdioServerConfig struct {
Type *ServerType `json:"type,omitempty"`
Command string `json:"command"`
Args []string `json:"args,omitempty"`
Env map[string]string `json:"env,omitempty"`
}
StdioServerConfig configures a stdio-based MCP server.
func (*StdioServerConfig) GetType ¶
func (m *StdioServerConfig) GetType() ServerType
GetType implements ServerConfig.
Source Files