Documentation
¶
Overview ¶
Package mcptest implements helper functions for testing MCP servers.
Index ¶
- type Server
- func (s *Server) AddPrompt(prompt mcp.Prompt, handler server.PromptHandlerFunc)
- func (s *Server) AddPrompts(prompts ...server.ServerPrompt)
- func (s *Server) AddResource(resource mcp.Resource, handler server.ResourceHandlerFunc)
- func (s *Server) AddResourceTemplate(template mcp.ResourceTemplate, handler server.ResourceTemplateHandlerFunc)
- func (s *Server) AddResourceTemplates(templates ...ServerResourceTemplate)
- func (s *Server) AddResources(resources ...server.ServerResource)
- func (s *Server) AddTool(tool mcp.Tool, handler server.ToolHandlerFunc)
- func (s *Server) AddTools(tools ...server.ServerTool)
- func (s *Server) Client() *client.Client
- func (s *Server) Close()
- func (s *Server) Start(ctx context.Context) error
- type ServerResourceTemplate
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server encapsulates an MCP server and manages resources like pipes and context.
func NewServer ¶
NewServer starts a new MCP server with the provided tools and returns the server instance.
func NewUnstartedServer ¶
NewUnstartedServer creates a new MCP server instance with the given name, but does not start the server. Useful for tests where you need to add tools before starting the server.
func (*Server) AddPrompt ¶ added in v0.32.0
func (s *Server) AddPrompt(prompt mcp.Prompt, handler server.PromptHandlerFunc)
AddPrompt adds a prompt to an unstarted server.
func (*Server) AddPrompts ¶ added in v0.32.0
func (s *Server) AddPrompts(prompts ...server.ServerPrompt)
AddPrompts adds multiple prompts to an unstarted server.
func (*Server) AddResource ¶ added in v0.32.0
func (s *Server) AddResource(resource mcp.Resource, handler server.ResourceHandlerFunc)
AddResource adds a resource to an unstarted server.
func (*Server) AddResourceTemplate ¶ added in v0.33.0
func (s *Server) AddResourceTemplate(template mcp.ResourceTemplate, handler server.ResourceTemplateHandlerFunc)
AddResourceTemplate adds a resource template to an unstarted server.
func (*Server) AddResourceTemplates ¶ added in v0.33.0
func (s *Server) AddResourceTemplates(templates ...ServerResourceTemplate)
AddResourceTemplates adds multiple resource templates to an unstarted server.
func (*Server) AddResources ¶ added in v0.32.0
func (s *Server) AddResources(resources ...server.ServerResource)
AddResources adds multiple resources to an unstarted server.
func (*Server) AddTool ¶
func (s *Server) AddTool(tool mcp.Tool, handler server.ToolHandlerFunc)
AddTool adds a tool to an unstarted server.
func (*Server) AddTools ¶
func (s *Server) AddTools(tools ...server.ServerTool)
AddTools adds multiple tools to an unstarted server.
func (*Server) Client ¶
Client returns an MCP client connected to the server. The client is already initialized, i.e. you do _not_ need to call Client.Initialize().
type ServerResourceTemplate ¶ added in v0.33.0
type ServerResourceTemplate struct {
Template mcp.ResourceTemplate
Handler server.ResourceTemplateHandlerFunc
}
ServerResourceTemplate combines a ResourceTemplate with its handler function.
Source Files