Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DocsLLM ¶
type DocsLLM struct {
// contains filtered or unexported fields
}
func NewDocsLLM ¶
func NewDocsLLM(docsFetcher LLMDocsResourcesFetcher, disableResources bool) *DocsLLM
NewDocsLLM creates a new instance of the DocsLLM tool.
func (*DocsLLM) Handler ¶
func (t *DocsLLM) Handler() mcp.ToolHandlerFor[Input, *Output]
Handler processes tool invocation requests and returns the requested documentation article. It fetches documentation in Markdown format from docs prepared specifically for LLMs.
type LLMDocsResourcesFetcher ¶
type LLMDocsResourcesFetcher interface {
// FetchLLMDocsResources retrieves documentation content (targeted for LLMs) for a specified article.
// If the articleURL is empty, the implementation should return the documentation index.
FetchLLMDocsResources(ctx context.Context, articleURL *string) (*mcp.ReadResourceResult, error)
}
LLMDocsResourcesFetcher defines the interface for retrieving documentation resources targeted for LLMs. Implementations should provide methods to fetch Firebolt documentation.
Source Files
Click to show internal directories.
Click to hide internal directories.