mcp

Documentation

Index

• type CallbackServer
  • func NewCallbackServer() (*CallbackServer, error)
  • func (cs *CallbackServer) GetRedirectURI() string
  • func (cs *CallbackServer) SetExpectedState(state string)
  • func (cs *CallbackServer) Shutdown(ctx context.Context) error
  • func (cs *CallbackServer) Start() error
  • func (cs *CallbackServer) WaitForCallback(ctx context.Context) (code, state string, err error)
• type GatewayToolset
  • func NewGatewayToolset(mcpServerName string, config any, toolFilter []string, ...) *GatewayToolset
  • func (t *GatewayToolset) Instructions() string
  • func (t *GatewayToolset) SetElicitationHandler(handler tools.ElicitationHandler)
  • func (t *GatewayToolset) SetOAuthSuccessHandler(handler func())
  • func (t *GatewayToolset) Start(ctx context.Context) error
  • func (t *GatewayToolset) Stop() error
  • func (t *GatewayToolset) Tools(ctx context.Context) ([]tools.Tool, error)
• type InMemoryTokenStore
  • func (s *InMemoryTokenStore) GetToken(resourceURL string) (*OAuthToken, error)
  • func (s *InMemoryTokenStore) RemoveToken(resourceURL string) error
  • func (s *InMemoryTokenStore) StoreToken(resourceURL string, token *OAuthToken) error
• type OAuthToken
  • func (t *OAuthToken) IsExpired() bool
• type OAuthTokenStore
  • func NewInMemoryTokenStore() OAuthTokenStore
• type Toolset
  • func NewRemoteToolset(url, transport string, headers map[string]string, toolFilter []string, ...) (*Toolset, error)
  • func NewToolsetCommand(command string, args, env, toolFilter []string) *Toolset
  • func (ts *Toolset) Instructions() string
  • func (ts *Toolset) SetElicitationHandler(handler tools.ElicitationHandler)
  • func (ts *Toolset) SetOAuthSuccessHandler(handler func())
  • func (ts *Toolset) Start(ctx context.Context) error
  • func (ts *Toolset) Stop() error
  • func (ts *Toolset) Tools(ctx context.Context) ([]tools.Tool, error)

Types

type CallbackServer

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

CallbackServer handles OAuth callback requests

func NewCallbackServer

func NewCallbackServer() (*CallbackServer, error)

NewCallbackServer creates a new OAuth callback server

func (*CallbackServer) GetRedirectURI

func (cs *CallbackServer) GetRedirectURI() string

func (*CallbackServer) SetExpectedState

func (cs *CallbackServer) SetExpectedState(state string)

func (*CallbackServer) Shutdown

func (cs *CallbackServer) Shutdown(ctx context.Context) error

func (*CallbackServer) Start

func (cs *CallbackServer) Start() error

func (*CallbackServer) WaitForCallback

func (cs *CallbackServer) WaitForCallback(ctx context.Context) (code, state string, err error)

type GatewayToolset

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

func NewGatewayToolset

func NewGatewayToolset(mcpServerName string, config any, toolFilter []string, envProvider environment.Provider) *GatewayToolset

func (*GatewayToolset) Instructions

func (t *GatewayToolset) Instructions() string

func (*GatewayToolset) SetElicitationHandler

func (t *GatewayToolset) SetElicitationHandler(handler tools.ElicitationHandler)

func (*GatewayToolset) SetOAuthSuccessHandler

func (t *GatewayToolset) SetOAuthSuccessHandler(handler func())

func (*GatewayToolset) Start

func (t *GatewayToolset) Start(ctx context.Context) error

func (*GatewayToolset) Stop

func (t *GatewayToolset) Stop() error

func (*GatewayToolset) Tools

func (t *GatewayToolset) Tools(ctx context.Context) ([]tools.Tool, error)

type InMemoryTokenStore

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

InMemoryTokenStore implements OAuthTokenStore in memory

func (*InMemoryTokenStore) GetToken

func (s *InMemoryTokenStore) GetToken(resourceURL string) (*OAuthToken, error)

func (*InMemoryTokenStore) RemoveToken

func (s *InMemoryTokenStore) RemoveToken(resourceURL string) error

func (*InMemoryTokenStore) StoreToken

func (s *InMemoryTokenStore) StoreToken(resourceURL string, token *OAuthToken) error

type OAuthToken

type OAuthToken struct {
	AccessToken  string    `json:"access_token"`
	TokenType    string    `json:"token_type"`
	ExpiresIn    int       `json:"expires_in,omitempty"`
	RefreshToken string    `json:"refresh_token,omitempty"`
	Scope        string    `json:"scope,omitempty"`
	ExpiresAt    time.Time `json:"expires_at,omitempty"`
}

func (*OAuthToken) IsExpired

func (t *OAuthToken) IsExpired() bool

IsExpired checks if the token is expired

type OAuthTokenStore

type OAuthTokenStore interface {
	// GetToken retrieves a token for the given resource URL
	GetToken(resourceURL string) (*OAuthToken, error)
	// StoreToken stores a token for the given resource URL
	StoreToken(resourceURL string, token *OAuthToken) error
	// RemoveToken removes a token for the given resource URL
	RemoveToken(resourceURL string) error
}

OAuthTokenStore manages OAuth tokens

func NewInMemoryTokenStore

func NewInMemoryTokenStore() OAuthTokenStore

NewInMemoryTokenStore creates a new in-memory token store

type Toolset

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

Toolset represents a set of MCP tools

func NewRemoteToolset

func NewRemoteToolset(url, transport string, headers map[string]string, toolFilter []string, redirectURI string) (*Toolset, error)

NewRemoteToolset creates a new MCP toolset from a remote MCP Server.

func NewToolsetCommand

func NewToolsetCommand(command string, args, env, toolFilter []string) *Toolset

NewToolsetCommand creates a new MCP toolset from a command.

func (*Toolset) Instructions

func (ts *Toolset) Instructions() string

func (*Toolset) SetElicitationHandler

func (ts *Toolset) SetElicitationHandler(handler tools.ElicitationHandler)

SetElicitationHandler sets the elicitation handler for remote MCP clients This allows the runtime to provide a handler that propagates elicitation requests

func (*Toolset) SetOAuthSuccessHandler

func (ts *Toolset) SetOAuthSuccessHandler(handler func())

func (*Toolset) Start

func (ts *Toolset) Start(ctx context.Context) error

func (*Toolset) Stop

func (ts *Toolset) Stop() error

func (*Toolset) Tools

func (ts *Toolset) Tools(ctx context.Context) ([]tools.Tool, error)