fxctx

package

v0.0.14 Latest Latest Go to latest Published: Dec 22, 2024 License: MIT Imports: 8 Imported by: 6

Details

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

Repository

github.com/strowk/foxy-contexts

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func AsPrompt(f any) any
func AsResource(f any) any
func AsResourceProvider(f any) any
func AsTool(f any) any
func ProvideCompleteMux() fx.Option
func ProvidePromptMux() fx.Option
func ProvideResourceMux() fx.Option
func ProvideToolMux() fx.Option
type CompletMuxParams
type CompleteMux
- func NewCompleteMux(params CompletMuxParams) CompleteMux
type Completer
type CompleterFunc
type Prompt
- func NewPrompt(p mcp.Prompt, get func(*mcp.GetPromptRequest) (*mcp.GetPromptResult, error)) Prompt
type PromptMux
- func NewPromptMux(prompts []Prompt) PromptMux
type Resource
- func NewResource(mcpResource mcp.Resource, ...) Resource
type ResourceMux
- func NewResourceMux(resources []Resource, resourceProviders []ResourceProvider) ResourceMux
type ResourceProvider
- func NewResourceProvider(getResources func() ([]mcp.Resource, error), ...) ResourceProvider
type Tool
- func NewTool(mcpTool *mcp.Tool, ...) Tool
type ToolMux
- func NewToolMux(tools []Tool) ToolMux
type ToolResponse

Constants ¶

View Source

const (
	ListResourcesFailed = iota - 32099
	ReadResourceFailed
	GetPromptFailed
	ToolNotFound
	CompleteFailed
)

Variables ¶

View Source

var (
	ErrMissingRefType        = errors.New("missing ref type")
	ErrUnknownValueOfRefType = errors.New("unknown value of ref type")
	ErrUnknownTypeOfRef      = errors.New("unknown type of ref")
)

View Source

var (
	ErrNoSuchArgument = errors.New("no such argument to complete for prompt")
)

View Source

var (
	ErrToolNotFound = errors.New("tool not found")
)

Functions ¶

func AsPrompt ¶

func AsPrompt(f any) any

func AsResource ¶

func AsResource(f any) any

func AsResourceProvider ¶

func AsResourceProvider(f any) any

func AsTool ¶

func AsTool(f any) any

func ProvideCompleteMux ¶ added in v0.0.6

func ProvideCompleteMux() fx.Option

func ProvidePromptMux ¶

func ProvidePromptMux() fx.Option

func ProvideResourceMux ¶

func ProvideResourceMux() fx.Option

func ProvideToolMux ¶

func ProvideToolMux() fx.Option

Types ¶

type CompletMuxParams ¶ added in v0.0.6

type CompletMuxParams struct {
	fx.In

	ResourceMux ResourceMux `optional:"true"`
	PromptMux   PromptMux   `optional:"true"`
}

type CompleteMux ¶ added in v0.0.6

type CompleteMux interface {
	Complete(*mcp.CompleteRequest) (*mcp.CompleteResult, error)
	RegisterHandlers(s server.Server)
}

func NewCompleteMux ¶ added in v0.0.6

func NewCompleteMux(params CompletMuxParams) CompleteMux

type Completer ¶ added in v0.0.6

type Completer interface {
	Complete(*mcp.CompleteRequest, string) (*mcp.CompleteResult, error)
}

type CompleterFunc ¶ added in v0.0.6

type CompleterFunc = func(arg *mcp.PromptArgument, value string) (*mcp.CompleteResult, error)

type Prompt ¶

type Prompt interface {
	GetMcpPrompt() mcp.Prompt
	Get(*mcp.GetPromptRequest) (*mcp.GetPromptResult, error)
	Complete(*mcp.CompleteRequest) (*mcp.CompleteResult, error)
	WithCompleter(CompleterFunc) Prompt
}

func NewPrompt ¶

func NewPrompt(
	p mcp.Prompt,
	get func(*mcp.GetPromptRequest) (*mcp.GetPromptResult, error),
) Prompt

type PromptMux ¶

type PromptMux interface {
	Completer
	ListPrompts() []mcp.Prompt
	RegisterHandlers(s server.Server)
}

func NewPromptMux ¶

func NewPromptMux(prompts []Prompt) PromptMux

type Resource ¶

type Resource interface {
	GetResource() mcp.Resource
	ReadResource(uri string) (*mcp.ReadResourceResult, error)
}

func NewResource ¶

func NewResource(
	mcpResource mcp.Resource,
	callback func(uri string) (*mcp.ReadResourceResult, error)) Resource

type ResourceMux ¶

type ResourceMux interface {
	Completer
	GetResources() ([]mcp.Resource, error)
	ReadResource(uri string) (*mcp.ReadResourceResult, error)
	RegisterHandlers(s server.Server)
}

func NewResourceMux ¶

func NewResourceMux(
	resources []Resource,
	resourceProviders []ResourceProvider,
) ResourceMux

type ResourceProvider ¶

type ResourceProvider interface {
	GetResources() ([]mcp.Resource, error)
	ReadResource(uri string) (*mcp.ReadResourceResult, error)
}

func NewResourceProvider ¶

func NewResourceProvider(
	getResources func() ([]mcp.Resource, error),
	readResource func(uri string) (*mcp.ReadResourceResult, error),
) ResourceProvider

type Tool ¶

type Tool interface {
	GetMcpTool() *mcp.Tool
	Callback(args map[string]interface{}) *mcp.CallToolResult
}

func NewTool ¶

func NewTool(
	mcpTool *mcp.Tool,
	callback func(args map[string]interface{}) *mcp.CallToolResult) Tool

type ToolMux ¶

type ToolMux interface {
	GetMcpTools() []mcp.Tool
	CallToolNamed(name string, args map[string]interface{}) (*mcp.CallToolResult, error)
	RegisterHandlers(s server.Server)
}

func NewToolMux ¶

func NewToolMux(
	tools []Tool,
) ToolMux

type ToolResponse ¶

type ToolResponse struct {
	Meta    map[string]interface{}
	Content []interface{}
	IsError *bool
}

Source Files ¶

View all Source files

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