server

package

v0.1.1 Latest Latest Go to latest Published: Nov 28, 2024 License: MIT Imports: 10 Imported by: 1,020

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/mark3labs/mcp-go

Links

Open Source Insights

Documentation ¶

Index ¶

func ServeStdio(server *DefaultServer) error
type CallToolFunc
type CompleteFunc
type DefaultServer
- func NewDefaultServer(name, version string) *DefaultServer
- func (s *DefaultServer) HandleCallTool(f CallToolFunc)
- func (s *DefaultServer) HandleComplete(f CompleteFunc)
- func (s *DefaultServer) HandleGetPrompt(f GetPromptFunc)
- func (s *DefaultServer) HandleInitialize(f InitializeFunc)
- func (s *DefaultServer) HandleListPrompts(f ListPromptsFunc)
- func (s *DefaultServer) HandleListResources(f ListResourcesFunc)
- func (s *DefaultServer) HandleListTools(f ListToolsFunc)
- func (s *DefaultServer) HandlePing(f PingFunc)
- func (s *DefaultServer) HandleReadResource(f ReadResourceFunc)
- func (s *DefaultServer) HandleSetLevel(f SetLevelFunc)
- func (s *DefaultServer) HandleSubscribe(f SubscribeFunc)
- func (s *DefaultServer) HandleUnsubscribe(f UnsubscribeFunc)
- func (s *DefaultServer) Request(ctx context.Context, method string, params json.RawMessage) (interface{}, error)
type GetPromptFunc
type InitializeFunc
type JSONRPCRequest
type JSONRPCResponse
type ListPromptsFunc
type ListResourcesFunc
type ListToolsFunc
type MCPServer
type PingFunc
type ReadResourceFunc
type SetLevelFunc
type StdioServer
type SubscribeFunc
type UnsubscribeFunc

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ServeStdio ¶

func ServeStdio(server *DefaultServer) error

ServeStdio creates a stdio server wrapper around an existing DefaultServer

Types ¶

type CallToolFunc ¶

type CallToolFunc func(ctx context.Context, name string, arguments map[string]interface{}) (*mcp.CallToolResult, error)

type CompleteFunc ¶

type CompleteFunc func(ctx context.Context, ref interface{}, argument mcp.CompleteArgument) (*mcp.CompleteResult, error)

type DefaultServer ¶

type DefaultServer struct {
	// contains filtered or unexported fields
}

func NewDefaultServer ¶

func NewDefaultServer(name, version string) *DefaultServer

NewDefaultServer creates a new server with default handlers

func (*DefaultServer) HandleCallTool ¶

func (s *DefaultServer) HandleCallTool(
	f CallToolFunc,
)

func (*DefaultServer) HandleComplete ¶

func (s *DefaultServer) HandleComplete(
	f CompleteFunc,
)

func (*DefaultServer) HandleGetPrompt ¶

func (s *DefaultServer) HandleGetPrompt(
	f GetPromptFunc,
)

func (*DefaultServer) HandleInitialize ¶

func (s *DefaultServer) HandleInitialize(
	f InitializeFunc,
)

Handler registration methods

func (*DefaultServer) HandleListPrompts ¶

func (s *DefaultServer) HandleListPrompts(
	f ListPromptsFunc,
)

func (*DefaultServer) HandleListResources ¶

func (s *DefaultServer) HandleListResources(
	f ListResourcesFunc,
)

func (*DefaultServer) HandleListTools ¶

func (s *DefaultServer) HandleListTools(
	f ListToolsFunc,
)

func (*DefaultServer) HandlePing ¶

func (s *DefaultServer) HandlePing(
	f PingFunc,
)

func (*DefaultServer) HandleReadResource ¶

func (s *DefaultServer) HandleReadResource(
	f ReadResourceFunc,
)

func (*DefaultServer) HandleSetLevel ¶

func (s *DefaultServer) HandleSetLevel(
	f SetLevelFunc,
)

func (*DefaultServer) HandleSubscribe ¶

func (s *DefaultServer) HandleSubscribe(
	f SubscribeFunc,
)

func (*DefaultServer) HandleUnsubscribe ¶

func (s *DefaultServer) HandleUnsubscribe(
	f UnsubscribeFunc,
)

func (*DefaultServer) Request ¶

func (s *DefaultServer) Request(
	ctx context.Context,
	method string,
	params json.RawMessage,
) (interface{}, error)

Request is the main entrypoint of the server

type GetPromptFunc ¶

type GetPromptFunc func(ctx context.Context, name string, arguments map[string]string) (*mcp.GetPromptResult, error)

type InitializeFunc ¶

type InitializeFunc func(ctx context.Context, capabilities mcp.ClientCapabilities, clientInfo mcp.Implementation, protocolVersion string) (*mcp.InitializeResult, error)

type JSONRPCRequest ¶

type JSONRPCRequest struct {
	JSONRPC string          `json:"jsonrpc"`
	ID      interface{}     `json:"id"`
	Method  string          `json:"method"`
	Params  json.RawMessage `json:"params"`
}

JSONRPCRequest represents a JSON-RPC 2.0 request

type JSONRPCResponse ¶

type JSONRPCResponse struct {
	JSONRPC string      `json:"jsonrpc"`
	ID      interface{} `json:"id,omitempty"`
	Result  interface{} `json:"result,omitempty"`
	Error   *struct {
		Code    int    `json:"code"`
		Message string `json:"message"`
	} `json:"error,omitempty"`
}

JSONRPCResponse represents a JSON-RPC 2.0 response

type ListPromptsFunc ¶

type ListPromptsFunc func(ctx context.Context, cursor *string) (*mcp.ListPromptsResult, error)

type ListResourcesFunc ¶

type ListResourcesFunc func(ctx context.Context, cursor *string) (*mcp.ListResourcesResult, error)

type ListToolsFunc ¶

type ListToolsFunc func(ctx context.Context, cursor *string) (*mcp.ListToolsResult, error)

type MCPServer ¶

type MCPServer interface {
	HandleInitialize(InitializeFunc)
	HandlePing(PingFunc)
	HandleListResources(ListResourcesFunc)
	HandleReadResource(ReadResourceFunc)
	HandleSubscribe(SubscribeFunc)
	HandleUnsubscribe(UnsubscribeFunc)
	HandleListPrompts(ListPromptsFunc)
	HandleGetPrompt(GetPromptFunc)
	HandleListTools(ListToolsFunc)
	HandleCallTool(CallToolFunc)
	HandleSetLevel(SetLevelFunc)
	HandleComplete(CompleteFunc)
}

type PingFunc ¶

type PingFunc func(ctx context.Context) error

type ReadResourceFunc ¶

type ReadResourceFunc func(ctx context.Context, uri string) (*mcp.ReadResourceResult, error)

type SetLevelFunc ¶

type SetLevelFunc func(ctx context.Context, level mcp.LoggingLevel) error

type StdioServer ¶

type StdioServer struct {
	// contains filtered or unexported fields
}

StdioServer wraps a DefaultServer and handles stdio communication

type SubscribeFunc ¶

type SubscribeFunc func(ctx context.Context, uri string) error

type UnsubscribeFunc ¶

type UnsubscribeFunc func(ctx context.Context, uri string) error

Source Files ¶

View all Source files

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