mcpserver

Documentation

Index

• Variables
• func AddDefaultTools(ts ...*Tool)
• func ClearDefaultTools()
• func UsageCLI() string
• func UsageHTTP() string
• type Prompt
  • func NewStaticPrompt(name string, description string, content string) *Prompt
  • func (p *Prompt) Handler(as *app.State, logger util.Logger) server.PromptHandlerFunc
  • func (p *Prompt) IconSafe() string
  • func (p *Prompt) ToMCP() (mcp.Prompt, error)
• type PromptHandler
• type Prompts
  • func (r Prompts) Get(n string) *Prompt
• type Resource
  • func NewBlobResource(name string, description string, uri string, mimeType string, content []byte) *Resource
  • func NewTextResource(name string, description string, uri string, mimeType string, content string) *Resource
  • func (r *Resource) Extension() string
  • func (r *Resource) Handler(as *app.State, logger util.Logger) server.ResourceHandlerFunc
  • func (r *Resource) IconSafe() string
  • func (r *Resource) ToMCP() (mcp.Resource, error)
• type Resources
  • func (r Resources) Get(n string) *Resource
• type Server
  • func CurrentDefaultServer() *Server
  • func GetDefaultServer(ctx context.Context, as *app.State, logger util.Logger) (*Server, error)
  • func NewServer(ctx context.Context, as *app.State, logger util.Logger) (*Server, error)
  • func (s *Server) AddPrompts(as *app.State, logger util.Logger, prompts ...*Prompt) error
  • func (s *Server) AddResources(as *app.State, logger util.Logger, resources ...*Resource) error
  • func (s *Server) AddTools(as *app.State, logger util.Logger, tools ...*Tool) error
  • func (s *Server) ServeCLI(ctx context.Context) error
  • func (s *Server) ServeHTTP(ctx context.Context, w http.ResponseWriter, r *http.Request, ...)
• type Tool
  • func (t *Tool) Handler(as *app.State, logger util.Logger) server.ToolHandlerFunc
  • func (t *Tool) IconSafe() string
  • func (t *Tool) ToMCP() (mcp.Tool, error)
• type ToolHandler
• type Tools
  • func (t Tools) Get(n string) *Tool

Variables

var (
	AllTools     = Tools{ListProjectsTool, GetProjectTool}
	AllResources = Resources{ProjectForgeResource}
	AllPrompts   = Prompts{ProjectPrompt}
)

var ExampleTool = &Tool{
	Name:        "example_mcp_server",
	Description: "Returns a random integer",
	Args:        util.FieldDescs{{Key: "max", Description: "Maximum possible random int (exclusive), defaults to 100"}},
	Fn:          exampleHandler,
}

var GetProjectTool = &Tool{
	Name:        "get_project",
	Description: "Get details of a specific project managed by " + util.AppName,
	Args: util.FieldDescs{
		{Key: "id", Description: "Optional project id. If omitted, all projects will be returned"},
	},
	Fn: projectsHandler,
}

var ListProjectsTool = &Tool{
	Name:        "list_projects",
	Description: "List the projects managed by " + util.AppName,
	Fn:          projectsHandler,
}

var ProjectForgeResource = &Resource{
	Name:        "projectforge",
	Description: "Description, purpose, and basic usage instructions for Project Forge (this MCP server)",
	URI:         "project://projectforge",
	MIMEType:    "text/markdown",
	Content:     "# Project Forge\n\n[Project Forge](https://projectforge.dev) is an application that allows you to generate, manage, and grow web applications built using the Go programming language.",
}

var ProjectPrompt = &Prompt{
	Name:        "project_usage",
	Description: "A simple prompt that helps the system build, test, and work with an application managed by Project Forge" + util.AppName,
	Fn: func(ctx context.Context, as *app.State, req mcp.GetPromptRequest, args util.ValueMap, logger util.Logger) (string, error) {
		return `This application is written using Go, and is a web application managed by Project Forge.`, nil
	},
}

Functions

func AddDefaultTools

func AddDefaultTools(ts ...*Tool)

func ClearDefaultTools

func ClearDefaultTools()

func UsageCLI

func UsageCLI() string

func UsageHTTP

func UsageHTTP() string

Types

type Prompt

type Prompt struct {
	Name        string          `json:"name"`
	Description string          `json:"description,omitempty"`
	Icon        string          `json:"icon,omitempty"`
	Args        util.FieldDescs `json:"args,omitempty"`
	Fn          PromptHandler   `json:"-"`
}

func NewStaticPrompt

func NewStaticPrompt(name string, description string, content string) *Prompt

func (*Prompt) Handler

func (p *Prompt) Handler(as *app.State, logger util.Logger) server.PromptHandlerFunc

func (*Prompt) IconSafe

func (p *Prompt) IconSafe() string

func (*Prompt) ToMCP

func (p *Prompt) ToMCP() (mcp.Prompt, error)

type PromptHandler

type PromptHandler func(ctx context.Context, as *app.State, req mcp.GetPromptRequest, args util.ValueMap, logger util.Logger) (string, error)

type Prompts

type Prompts []*Prompt

func (Prompts) Get

func (r Prompts) Get(n string) *Prompt

type Resource

type Resource struct {
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
	Icon        string `json:"icon,omitempty"`
	URI         string `json:"uri"`
	MIMEType    string `json:"mimeType"`
	Content     string `json:"content"`
	Binary      bool   `json:"binary,omitempty"`
}

func NewBlobResource

func NewBlobResource(name string, description string, uri string, mimeType string, content []byte) *Resource

func NewTextResource

func NewTextResource(name string, description string, uri string, mimeType string, content string) *Resource

func (*Resource) Extension

func (r *Resource) Extension() string

func (*Resource) Handler

func (r *Resource) Handler(as *app.State, logger util.Logger) server.ResourceHandlerFunc

func (*Resource) IconSafe

func (r *Resource) IconSafe() string

func (*Resource) ToMCP

func (r *Resource) ToMCP() (mcp.Resource, error)

type Resources

type Resources []*Resource

func (Resources) Get

func (r Resources) Get(n string) *Resource

type Server

type Server struct {
	MCP       *server.MCPServer `json:"-"`
	State     *app.State        `json:"-"`
	Resources Resources         `json:"resources"`
	Prompts   Prompts           `json:"prompts"`
	Tools     Tools             `json:"tools"`
	HTTP      http.Handler      `json:"-"`
}

func CurrentDefaultServer

func CurrentDefaultServer() *Server

func GetDefaultServer

func GetDefaultServer(ctx context.Context, as *app.State, logger util.Logger) (*Server, error)

func NewServer

func NewServer(ctx context.Context, as *app.State, logger util.Logger) (*Server, error)

func (*Server) AddPrompts

func (s *Server) AddPrompts(as *app.State, logger util.Logger, prompts ...*Prompt) error

func (*Server) AddResources

func (s *Server) AddResources(as *app.State, logger util.Logger, resources ...*Resource) error

func (*Server) AddTools

func (s *Server) AddTools(as *app.State, logger util.Logger, tools ...*Tool) error

func (*Server) ServeCLI

func (s *Server) ServeCLI(ctx context.Context) error

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(ctx context.Context, w http.ResponseWriter, r *http.Request, logger util.Logger)

type Tool

type Tool struct {
	Name        string          `json:"name"`
	Description string          `json:"description,omitempty"`
	Icon        string          `json:"icon,omitempty"`
	Args        util.FieldDescs `json:"args,omitempty"`
	Fn          ToolHandler     `json:"-"`
}

func (*Tool) Handler

func (t *Tool) Handler(as *app.State, logger util.Logger) server.ToolHandlerFunc

func (*Tool) IconSafe

func (t *Tool) IconSafe() string

func (*Tool) ToMCP

func (t *Tool) ToMCP() (mcp.Tool, error)

type ToolHandler

type ToolHandler func(ctx context.Context, as *app.State, req mcp.CallToolRequest, args util.ValueMap, logger util.Logger) (string, error)

type Tools

type Tools []*Tool

func (Tools) Get

func (t Tools) Get(n string) *Tool