tools

type ListByIndexInput struct {
	ArticleIndex int `json:"article_index" jsonschema:"The article_index returned by the search tool for the article you want to list sections of."`
}

type ListByUrlInput struct {
	Url string `json:"url" jsonschema:"A zim:// URL found in previously read content. Format: zim://x/e/Article_Title[#section_anchor]."`
}

type ListOutput struct {
	Sections []ListSection `json:"sections" jsonschema:"List of section titles in the article."`
}

type ListSection struct {
	Title string `json:"title" jsonschema:"The title of the section."`
	Url   string `json:"url" jsonschema:"A zim:// URL to the section. Use this to read the section's content."`
	Size  int    `json:"size" jsonschema:"The size of the section in bytes."`
}

type ReadByIndexInput struct {
	ArticleIndex int `json:"article_index" jsonschema:"The article_index returned by the search tool for the article you want to read."`
}

type ReadByUrlInput struct {
	Url string `` /* 283-byte string literal not displayed */
}

type SearchInput struct {
	Query string `` /* 202-byte string literal not displayed */
}

type SearchOutput struct {
	Results    []SearchResult `` /* 127-byte string literal not displayed */
	TotalFound int            `` /* 129-byte string literal not displayed */
}

type SearchResult struct {
	Title        string  `json:"title" jsonschema:"Human-readable title of the matching article."`
	ArticleIndex int     `json:"article_index" jsonschema:"Numeric index for this article. Pass to the read-by-index tool to retrieve its content."`
	ArticleSize  int     `json:"article_size" jsonschema:"Size of the article in bytes."`
	Score        float32 `json:"score" jsonschema:"Relevance score of the article, higher is better."`
}

type Settings struct {
	VendorKey    string
	VendorName   string
	ZimFilePath  string
	RefreshIndex bool
	IndexesDir   string
}