tool_docs

type Docs ¶

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

Docs represents a tool for fetching and returning Firebolt documentation. It provides access to documentation articles that explain Firebolt concepts and functionality.

func NewDocs(docsFetcher DocsResourcesFetcher, disableResources bool) *Docs

func (t *Docs) Handler() mcp.ToolHandlerFor[Input, *Output]

func (t *Docs) Register(s *mcp.Server)

func (t *Docs) Tool() *mcp.Tool

type DocsResourcesFetcher ¶

type DocsResourcesFetcher interface {
	// FetchDocsResources retrieves documentation content for a specified article.
	// If article is empty, the implementation should determine an appropriate default behavior.
	FetchDocsResources(_ context.Context, article string) (*mcp.ReadResourceResult, error)
}

DocsResourcesFetcher defines the interface for retrieving documentation resources. Implementations should provide methods to fetch Firebolt documentation.

type Input ¶

type Input struct {
}

type Output ¶

type Output struct {
	Articles []mcp.Content `json:"articles"`
}