@llmindset/hf-mcp 0.1.16 → 0.1.18

package/dist/docs-search/doc-fetch.d.ts

@@ -0,0 +1,24 @@
+import { z } from 'zod';
+export declare const DOC_FETCH_CONFIG: {
+    readonly name: "fetch_hf_doc";
+    readonly description: "Fetch a document from the Hugging Face documentation library.";
+    readonly schema: z.ZodObject<{
+        doc_url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        doc_url: string;
+    }, {
+        doc_url: string;
+    }>;
+    readonly annotations: {
+        readonly title: "Fetch a document from the Hugging Face library";
+        readonly destructiveHint: false;
+        readonly readOnlyHint: true;
+        readonly openWorldHint: true;
+    };
+};
+export type DocFetchParams = z.infer<typeof DOC_FETCH_CONFIG.schema>;
+export declare class DocFetchTool {
+    processUrl(hfUrl: string): string;
+    fetch(url: string): Promise<string>;
+}
+//# sourceMappingURL=doc-fetch.d.ts.map

package/dist/docs-search/doc-fetch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-fetch.d.ts","sourceRoot":"","sources":["../../src/docs-search/doc-fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;CAgBnB,CAAC;AAEX,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAkBrE,qBAAa,YAAY;IAIxB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAiC3B,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAgBzC"}

package/dist/docs-search/doc-fetch.js

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+import { DOC_MAPPINGS } from './doc-mappings.js';
+export const DOC_FETCH_CONFIG = {
+    name: 'fetch_hf_doc',
+    description: 'Fetch a document from the Hugging Face documentation library.',
+    schema: z.object({
+        doc_url: z
+            .string()
+            .min(28, 'Url should start with https://huggingface.co/docs/')
+            .max(200, 'Query too long')
+            .describe('Hugging Face documentation URL'),
+    }),
+    annotations: {
+        title: 'Fetch a document from the Hugging Face library',
+        destructiveHint: false,
+        readOnlyHint: true,
+        openWorldHint: true,
+    },
+};
+export class DocFetchTool {
+    processUrl(hfUrl) {
+        if (!hfUrl.startsWith('https://huggingface.co/docs/')) {
+            throw new Error('That was not a valid Hugging Face document URL');
+        }
+        const urlPath = hfUrl.replace('https://huggingface.co/docs/', '').split('#')[0] || '';
+        const parts = urlPath.split('/');
+        const packageName = parts[0] || '';
+        let fetchUrl = hfUrl;
+        const mapping = DOC_MAPPINGS[packageName];
+        if (mapping) {
+            const remainingPath = parts.slice(1).join('/');
+            const filePath = remainingPath ? `${remainingPath}.md` : 'index.md';
+            const githubUrl = `https://raw.githubusercontent.com/${mapping.repo_id}/refs/heads/main/${mapping.doc_folder}/${filePath}`;
+            fetchUrl = githubUrl;
+        }
+        console.error(fetchUrl);
+        return fetchUrl;
+    }
+    async fetch(url) {
+        try {
+            const githubUrl = this.processUrl(url);
+            const response = await fetch(githubUrl);
+            if (!response.ok) {
+                throw new Error(`Failed to fetch document: ${response.status} ${response.statusText}`);
+            }
+            const content = await response.text();
+            return content;
+        }
+        catch (error) {
+            throw new Error(`Failed to fetch document: ${error instanceof Error ? error.message : 'Unknown error'}`);
+        }
+    }
+}
+//# sourceMappingURL=doc-fetch.js.map

package/dist/docs-search/doc-fetch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-fetch.js","sourceRoot":"","sources":["../../src/docs-search/doc-fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC/B,IAAI,EAAE,cAAc;IACpB,WAAW,EAAE,+DAA+D;IAC5E,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QAChB,OAAO,EAAE,CAAC;aACR,MAAM,EAAE;aACR,GAAG,CAAC,EAAE,EAAE,oDAAoD,CAAC;aAC7D,GAAG,CAAC,GAAG,EAAE,gBAAgB,CAAC;aAC1B,QAAQ,CAAC,gCAAgC,CAAC;KAC5C,CAAC;IACF,WAAW,EAAE;QACZ,KAAK,EAAE,gDAAgD;QACvD,eAAe,EAAE,KAAK;QACtB,YAAY,EAAE,IAAI;QAClB,aAAa,EAAE,IAAI;KACnB;CACQ,CAAC;AAoBX,MAAM,OAAO,YAAY;IAIxB,UAAU,CAAC,KAAa;QAEvB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,8BAA8B,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACnE,CAAC;QAGD,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAGtF,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAGnC,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC;QAC1C,IAAI,OAAO,EAAE,CAAC;YACb,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC/C,MAAM,QAAQ,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,aAAa,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC;YAGpE,MAAM,SAAS,GAAG,qCAAqC,OAAO,CAAC,OAAO,oBAAoB,OAAO,CAAC,UAAU,IAAI,QAAQ,EAAE,CAAC;YAC3H,QAAQ,GAAG,SAAS,CAAC;QACtB,CAAC;QAGD,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC;IACjB,CAAC;IAKD,KAAK,CAAC,KAAK,CAAC,GAAW;QACtB,IAAI,CAAC;YACJ,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAEvC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,CAAC;YAExC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,6BAA6B,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;YACxF,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACtC,OAAO,OAAO,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,6BAA6B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC;QAC1G,CAAC;IACF,CAAC;CACD"}

package/dist/docs-search/doc-fetch.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=doc-fetch.test.d.ts.map

package/dist/docs-search/doc-fetch.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-fetch.test.d.ts","sourceRoot":"","sources":["../../src/docs-search/doc-fetch.test.ts"],"names":[],"mappings":""}

package/dist/docs-search/doc-fetch.test.js

@@ -0,0 +1,52 @@
+import { describe, it, expect } from 'vitest';
+import { DocFetchTool } from './doc-fetch.js';
+describe('DocFetchTool', () => {
+    const tool = new DocFetchTool();
+    describe('URL conversion', () => {
+        it('should convert basic HF docs URL to GitHub URL', () => {
+            const hfUrl = 'https://huggingface.co/docs/dataset-viewer/index';
+            const expectedUrl = 'https://raw.githubusercontent.com/huggingface/dataset-viewer/refs/heads/main/docs/source/index.md';
+            const result = tool.processUrl(hfUrl);
+            expect(result).toBe(expectedUrl);
+        });
+        it('should handle URLs with fragments by removing them', () => {
+            const hfUrl = 'https://huggingface.co/docs/huggingface_hub/guides/upload#faster-uploads';
+            const expectedUrl = 'https://raw.githubusercontent.com/huggingface/huggingface_hub/refs/heads/main/docs/source/en/guides/upload.md';
+            const result = tool.processUrl(hfUrl);
+            expect(result).toBe(expectedUrl);
+        });
+        it('should handle transformers documentation', () => {
+            const hfUrl = 'https://huggingface.co/docs/transformers/model_doc/bert';
+            const expectedUrl = 'https://raw.githubusercontent.com/huggingface/transformers/refs/heads/main/docs/source/en/model_doc/bert.md';
+            const result = tool.processUrl(hfUrl);
+            expect(result).toBe(expectedUrl);
+        });
+        it('should handle diffusers documentation', () => {
+            const hfUrl = 'https://huggingface.co/docs/diffusers/api/pipelines/stable_diffusion';
+            const expectedUrl = 'https://raw.githubusercontent.com/huggingface/diffusers/refs/heads/main/docs/source/en/api/pipelines/stable_diffusion.md';
+            const result = tool.processUrl(hfUrl);
+            expect(result).toBe(expectedUrl);
+        });
+        it('should handle timm documentation with custom package name', () => {
+            const hfUrl = 'https://huggingface.co/docs/timm/models';
+            const expectedUrl = 'https://raw.githubusercontent.com/huggingface/pytorch-image-models/refs/heads/main/hfdocs/source/models.md';
+            const result = tool.processUrl(hfUrl);
+            expect(result).toBe(expectedUrl);
+        });
+        it('should default to index.md when no path is provided', () => {
+            const hfUrl = 'https://huggingface.co/docs/transformers';
+            const expectedUrl = 'https://raw.githubusercontent.com/huggingface/transformers/refs/heads/main/docs/source/en/index.md';
+            const result = tool.processUrl(hfUrl);
+            expect(result).toBe(expectedUrl);
+        });
+        it('should throw error for URLs not starting with correct prefix', () => {
+            const invalidUrl = 'https://example.com/docs/something';
+            expect(() => tool.processUrl(invalidUrl)).toThrow('That was not a valid Hugging Face document URL');
+        });
+        it('should throw error for unknown package names', () => {
+            const unknownPackageUrl = 'https://huggingface.co/docs/unknown-package/guide';
+            expect(tool.processUrl(unknownPackageUrl)).toBe('https://huggingface.co/docs/unknown-package/guide');
+        });
+    });
+});
+//# sourceMappingURL=doc-fetch.test.js.map

package/dist/docs-search/doc-fetch.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-fetch.test.js","sourceRoot":"","sources":["../../src/docs-search/doc-fetch.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC7B,MAAM,IAAI,GAAG,IAAI,YAAY,EAAE,CAAC;IAEhC,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC/B,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACzD,MAAM,KAAK,GAAG,kDAAkD,CAAC;YACjE,MAAM,WAAW,GAChB,mGAAmG,CAAC;YAErG,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC7D,MAAM,KAAK,GAAG,0EAA0E,CAAC;YACzF,MAAM,WAAW,GAChB,+GAA+G,CAAC;YAEjH,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;YACnD,MAAM,KAAK,GAAG,yDAAyD,CAAC;YACxE,MAAM,WAAW,GAChB,6GAA6G,CAAC;YAE/G,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAChD,MAAM,KAAK,GAAG,sEAAsE,CAAC;YACrF,MAAM,WAAW,GAChB,0HAA0H,CAAC;YAE5H,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACpE,MAAM,KAAK,GAAG,yCAAyC,CAAC;YACxD,MAAM,WAAW,GAChB,4GAA4G,CAAC;YAE9G,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC9D,MAAM,KAAK,GAAG,0CAA0C,CAAC;YACzD,MAAM,WAAW,GAChB,oGAAoG,CAAC;YAEtG,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;YACvE,MAAM,UAAU,GAAG,oCAAoC,CAAC;YAExD,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,gDAAgD,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACvD,MAAM,iBAAiB,GAAG,mDAAmD,CAAC;YAE9E,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,mDAAmD,CAAC,CAAC;QACtG,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/docs-search/doc-mappings.d.ts

@@ -0,0 +1,7 @@
+interface DocMapping {
+    repo_id: string;
+    doc_folder: string;
+}
+export declare const DOC_MAPPINGS: Record<string, DocMapping>;
+export {};
+//# sourceMappingURL=doc-mappings.d.ts.map

package/dist/docs-search/doc-mappings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-mappings.d.ts","sourceRoot":"","sources":["../../src/docs-search/doc-mappings.ts"],"names":[],"mappings":"AAAA,UAAU,UAAU;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAyEnD,CAAC"}

package/dist/docs-search/doc-mappings.js

@@ -0,0 +1,75 @@
+export const DOC_MAPPINGS = {
+    'tokenizers': {
+        repo_id: 'huggingface/tokenizers',
+        doc_folder: 'docs/source-doc-builder'
+    },
+    'diffusers': {
+        repo_id: 'huggingface/diffusers',
+        doc_folder: 'docs/source/en'
+    },
+    'accelerate': {
+        repo_id: 'huggingface/accelerate',
+        doc_folder: 'docs/source'
+    },
+    'huggingface_hub': {
+        repo_id: 'huggingface/huggingface_hub',
+        doc_folder: 'docs/source/en'
+    },
+    'transformers': {
+        repo_id: 'huggingface/transformers',
+        doc_folder: 'docs/source/en'
+    },
+    'hub': {
+        repo_id: 'huggingface/hub-docs',
+        doc_folder: 'docs/hub'
+    },
+    'huggingface.js': {
+        repo_id: 'huggingface/huggingface.js',
+        doc_folder: 'docs'
+    },
+    'transformers.js': {
+        repo_id: 'huggingface/transformers.js',
+        doc_folder: 'docs/source'
+    },
+    'smolagents': {
+        repo_id: 'huggingface/smolagents',
+        doc_folder: 'docs/source/en'
+    },
+    'peft': {
+        repo_id: 'huggingface/peft',
+        doc_folder: 'docs/source'
+    },
+    'trl': {
+        repo_id: 'huggingface/trl',
+        doc_folder: 'docs/source'
+    },
+    'bitsandbytes': {
+        repo_id: 'bitsandbytes-foundation/bitsandbytes',
+        doc_folder: 'docs/source'
+    },
+    'lerobot': {
+        repo_id: 'huggingface/lerobot',
+        doc_folder: 'docs/source'
+    },
+    'timm': {
+        repo_id: 'huggingface/pytorch-image-models',
+        doc_folder: 'hfdocs/source'
+    },
+    'inference-providers': {
+        repo_id: 'huggingface/hub-docs',
+        doc_folder: 'docs/inference-providers'
+    },
+    'safetensors': {
+        repo_id: 'huggingface/safetensors',
+        doc_folder: 'docs/source'
+    },
+    'inference-endpoints': {
+        repo_id: 'huggingface/hf-endpoints-documentation',
+        doc_folder: 'docs/source'
+    },
+    'dataset-viewer': {
+        repo_id: 'huggingface/dataset-viewer',
+        doc_folder: 'docs/source'
+    }
+};
+//# sourceMappingURL=doc-mappings.js.map

package/dist/docs-search/doc-mappings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-mappings.js","sourceRoot":"","sources":["../../src/docs-search/doc-mappings.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,MAAM,YAAY,GAA+B;IACtD,YAAY,EAAE;QACZ,OAAO,EAAE,wBAAwB;QACjC,UAAU,EAAE,yBAAyB;KACtC;IACD,WAAW,EAAE;QACX,OAAO,EAAE,uBAAuB;QAChC,UAAU,EAAE,gBAAgB;KAC7B;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,wBAAwB;QACjC,UAAU,EAAE,aAAa;KAC1B;IACD,iBAAiB,EAAE;QACjB,OAAO,EAAE,6BAA6B;QACtC,UAAU,EAAE,gBAAgB;KAC7B;IACD,cAAc,EAAE;QACd,OAAO,EAAE,0BAA0B;QACnC,UAAU,EAAE,gBAAgB;KAC7B;IACD,KAAK,EAAE;QACL,OAAO,EAAE,sBAAsB;QAC/B,UAAU,EAAE,UAAU;KACvB;IACD,gBAAgB,EAAE;QAChB,OAAO,EAAE,4BAA4B;QACrC,UAAU,EAAE,MAAM;KACnB;IACD,iBAAiB,EAAE;QACjB,OAAO,EAAE,6BAA6B;QACtC,UAAU,EAAE,aAAa;KAC1B;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,wBAAwB;QACjC,UAAU,EAAE,gBAAgB;KAC7B;IACD,MAAM,EAAE;QACN,OAAO,EAAE,kBAAkB;QAC3B,UAAU,EAAE,aAAa;KAC1B;IACD,KAAK,EAAE;QACL,OAAO,EAAE,iBAAiB;QAC1B,UAAU,EAAE,aAAa;KAC1B;IACD,cAAc,EAAE;QACd,OAAO,EAAE,sCAAsC;QAC/C,UAAU,EAAE,aAAa;KAC1B;IACD,SAAS,EAAE;QACT,OAAO,EAAE,qBAAqB;QAC9B,UAAU,EAAE,aAAa;KAC1B;IACD,MAAM,EAAE;QACN,OAAO,EAAE,kCAAkC;QAC3C,UAAU,EAAE,eAAe;KAC5B;IACD,qBAAqB,EAAE;QACrB,OAAO,EAAE,sBAAsB;QAC/B,UAAU,EAAE,0BAA0B;KACvC;IACD,aAAa,EAAE;QACb,OAAO,EAAE,yBAAyB;QAClC,UAAU,EAAE,aAAa;KAC1B;IACD,qBAAqB,EAAE;QACrB,OAAO,EAAE,wCAAwC;QACjD,UAAU,EAAE,aAAa;KAC1B;IACD,gBAAgB,EAAE;QAChB,OAAO,EAAE,4BAA4B;QACrC,UAAU,EAAE,aAAa;KAC1B;CACF,CAAC"}

package/dist/docs-search/docs-semantic-search.d.ts

@@ -0,0 +1,41 @@
+import { z } from 'zod';
+import { HfApiCall } from '../hf-api-call.js';
+export declare const DOCS_SEMANTIC_SEARCH_CONFIG: {
+    readonly name: "docs_search";
+    readonly description: string;
+    readonly schema: z.ZodObject<{
+        query: z.ZodString;
+        product: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        query: string;
+        product?: string | undefined;
+    }, {
+        query: string;
+        product?: string | undefined;
+    }>;
+    readonly annotations: {
+        readonly title: "Hugging Face Documentation Search";
+        readonly destructiveHint: false;
+        readonly readOnlyHint: true;
+        readonly openWorldHint: true;
+    };
+};
+export type DocSearchParams = z.infer<typeof DOCS_SEMANTIC_SEARCH_CONFIG.schema>;
+interface DocSearchResult {
+    text: string;
+    product: string;
+    heading1: string;
+    source_page_url: string;
+    source_page_title: string;
+    heading2?: string;
+}
+interface DocSearchApiParams {
+    q: string;
+    product?: string;
+}
+export declare class DocSearchTool extends HfApiCall<DocSearchApiParams, DocSearchResult[]> {
+    constructor(hfToken?: string, apiUrl?: string);
+    search(query: string, product?: string): Promise<string>;
+}
+export {};
+//# sourceMappingURL=docs-semantic-search.d.ts.map

package/dist/docs-search/docs-semantic-search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-semantic-search.d.ts","sourceRoot":"","sources":["../../src/docs-search/docs-semantic-search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAI9C,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;CAsB9B,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,MAAM,CAAC,CAAC;AAEjF,UAAU,eAAe;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,kBAAkB;IAC3B,CAAC,EAAE,MAAM,CAAC;IACV,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAKD,qBAAa,aAAc,SAAQ,SAAS,CAAC,kBAAkB,EAAE,eAAe,EAAE,CAAC;gBAKtE,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,SAAkC;IAQhE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAyB9D"}

package/dist/docs-search/docs-semantic-search.js

@@ -0,0 +1,138 @@
+import { z } from 'zod';
+import { HfApiCall } from '../hf-api-call.js';
+import { escapeMarkdown } from '../utilities.js';
+import { DOC_FETCH_CONFIG } from './doc-fetch.js';
+export const DOCS_SEMANTIC_SEARCH_CONFIG = {
+    name: 'docs_search',
+    description: 'Search the Hugging Face documentation library with semantic search. Returns documentation excerpts ' +
+        'grouped by Product and document page.',
+    schema: z.object({
+        query: z
+            .string()
+            .min(3, 'Supply at least one search term')
+            .max(200, 'Query too long')
+            .describe('Semantic search query'),
+        product: z
+            .string()
+            .optional()
+            .describe('Filter by specific product (e.g., "hub", "dataset-viewer", "transformers")'),
+    }),
+    annotations: {
+        title: 'Hugging Face Documentation Search',
+        destructiveHint: false,
+        readOnlyHint: true,
+        openWorldHint: true,
+    },
+};
+export class DocSearchTool extends HfApiCall {
+    constructor(hfToken, apiUrl = 'https://hf.co/api/docs/search') {
+        super(apiUrl, hfToken);
+    }
+    async search(query, product) {
+        try {
+            if (!query)
+                return 'No query provided';
+            const params = { q: query.toLowerCase() };
+            if (product) {
+                params.product = product;
+            }
+            const results = await this.callApi(params);
+            if (results.length === 0) {
+                return product
+                    ? `No documentation found for query '${query}' in product '${product}'`
+                    : `No documentation found for query '${query}'`;
+            }
+            return formatSearchResults(query, results, product);
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                throw new Error(`Failed to search documentation: ${error.message}`);
+            }
+            throw error;
+        }
+    }
+}
+function groupResults(results) {
+    const grouped = new Map();
+    for (const result of results) {
+        if (!grouped.has(result.product)) {
+            grouped.set(result.product, new Map());
+        }
+        const productGroup = grouped.get(result.product);
+        if (!productGroup)
+            continue;
+        if (!productGroup.has(result.source_page_url)) {
+            productGroup.set(result.source_page_url, []);
+        }
+        const pageResults = productGroup.get(result.source_page_url);
+        if (pageResults) {
+            pageResults.push(result);
+        }
+    }
+    return grouped;
+}
+function formatExcerpt(result) {
+    const lines = [];
+    if (result.heading2) {
+        lines.push(`**Excerpt from "${escapeMarkdown(result.heading2)}":**`);
+    }
+    const cleanText = result.text
+        .replace(/<[^>]*>/g, '')
+        .replace(/\n\s*\n/g, '\n')
+        .trim();
+    lines.push(cleanText);
+    lines.push('');
+    return lines.join('\n');
+}
+function formatSearchResults(query, results, productFilter) {
+    const lines = [];
+    const filterText = productFilter ? ` (filtered by product: ${productFilter})` : '';
+    lines.push(`# Documentation Search Results for "${escapeMarkdown(query)}"${filterText}`);
+    lines.push('');
+    lines.push(`Found ${results.length} results`);
+    lines.push('');
+    const grouped = groupResults(results);
+    const sortedProducts = Array.from(grouped.keys()).sort((a, b) => {
+        const productGroupA = grouped.get(a);
+        const productGroupB = grouped.get(b);
+        if (!productGroupA || !productGroupB)
+            return 0;
+        const countA = Array.from(productGroupA.values()).reduce((sum, arr) => sum + arr.length, 0);
+        const countB = Array.from(productGroupB.values()).reduce((sum, arr) => sum + arr.length, 0);
+        return countB - countA;
+    });
+    for (const product of sortedProducts) {
+        const productGroup = grouped.get(product);
+        if (!productGroup)
+            continue;
+        const totalProductHits = Array.from(productGroup.values()).reduce((sum, arr) => sum + arr.length, 0);
+        lines.push(`## Results for Product: ${escapeMarkdown(product)} (${totalProductHits} results)`);
+        lines.push('');
+        const sortedUrls = Array.from(productGroup.keys()).sort((a, b) => {
+            const pageResultsA = productGroup.get(a);
+            const pageResultsB = productGroup.get(b);
+            if (!pageResultsA || !pageResultsB)
+                return 0;
+            return pageResultsB.length - pageResultsA.length;
+        });
+        for (const url of sortedUrls) {
+            const pageResults = productGroup.get(url);
+            if (!pageResults || pageResults.length === 0)
+                continue;
+            const firstResult = pageResults[0];
+            if (!firstResult)
+                continue;
+            const pageTitle = firstResult.heading1 || firstResult.source_page_title;
+            const hitCount = pageResults.length > 1 ? ` (${pageResults.length} results)` : '';
+            lines.push(`### Results from [${escapeMarkdown(pageTitle)}](${url})${hitCount}`);
+            lines.push('');
+            for (const result of pageResults) {
+                lines.push(formatExcerpt(result));
+            }
+        }
+    }
+    lines.push('---');
+    lines.push(`Use the "${DOC_FETCH_CONFIG.name}" tool to download a specific document.`);
+    return lines.join('\n');
+}
+//# sourceMappingURL=docs-semantic-search.js.map

package/dist/docs-search/docs-semantic-search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-semantic-search.js","sourceRoot":"","sources":["../../src/docs-search/docs-semantic-search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,MAAM,CAAC,MAAM,2BAA2B,GAAG;IAC1C,IAAI,EAAE,aAAa;IACnB,WAAW,EACV,qGAAqG;QACrG,uCAAuC;IACxC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QAChB,KAAK,EAAE,CAAC;aACN,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,EAAE,iCAAiC,CAAC;aACzC,GAAG,CAAC,GAAG,EAAE,gBAAgB,CAAC;aAC1B,QAAQ,CAAC,uBAAuB,CAAC;QACnC,OAAO,EAAE,CAAC;aACR,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,4EAA4E,CAAC;KACxF,CAAC;IACF,WAAW,EAAE;QACZ,KAAK,EAAE,mCAAmC;QAC1C,eAAe,EAAE,KAAK;QACtB,YAAY,EAAE,IAAI;QAClB,aAAa,EAAE,IAAI;KACnB;CACQ,CAAC;AAqBX,MAAM,OAAO,aAAc,SAAQ,SAAgD;IAKlF,YAAY,OAAgB,EAAE,MAAM,GAAG,+BAA+B;QACrE,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxB,CAAC;IAMD,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,OAAgB;QAC3C,IAAI,CAAC;YACJ,IAAI,CAAC,KAAK;gBAAE,OAAO,mBAAmB,CAAC;YAEvC,MAAM,MAAM,GAAuB,EAAE,CAAC,EAAE,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YAC9D,IAAI,OAAO,EAAE,CAAC;gBACb,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;YAC1B,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAoB,MAAM,CAAC,CAAC;YAE9D,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC1B,OAAO,OAAO;oBACb,CAAC,CAAC,qCAAqC,KAAK,iBAAiB,OAAO,GAAG;oBACvE,CAAC,CAAC,qCAAqC,KAAK,GAAG,CAAC;YAClD,CAAC;YAED,OAAO,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACrD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CAAC,mCAAmC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACrE,CAAC;YACD,MAAM,KAAK,CAAC;QACb,CAAC;IACF,CAAC;CACD;AAKD,SAAS,YAAY,CAAC,OAA0B;IAC/C,MAAM,OAAO,GAAG,IAAI,GAAG,EAA0C,CAAC;IAElE,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC9B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAClC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;QACxC,CAAC;QAED,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,CAAC,YAAY;YAAE,SAAS;QAE5B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;YAC/C,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QAC7D,IAAI,WAAW,EAAE,CAAC;YACjB,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC;IACF,CAAC;IAED,OAAO,OAAO,CAAC;AAChB,CAAC;AAKD,SAAS,aAAa,CAAC,MAAuB;IAC7C,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACrB,KAAK,CAAC,IAAI,CAAC,mBAAmB,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACtE,CAAC;IAGD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI;SAC3B,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;SACvB,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC;SACzB,IAAI,EAAE,CAAC;IAET,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACtB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC;AAKD,SAAS,mBAAmB,CAAC,KAAa,EAAE,OAA0B,EAAE,aAAsB;IAC7F,MAAM,KAAK,GAAa,EAAE,CAAC;IAG3B,MAAM,UAAU,GAAG,aAAa,CAAC,CAAC,CAAC,0BAA0B,aAAa,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACnF,KAAK,CAAC,IAAI,CAAC,uCAAuC,cAAc,CAAC,KAAK,CAAC,IAAI,UAAU,EAAE,CAAC,CAAC;IACzF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,MAAM,UAAU,CAAC,CAAC;IAC9C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAGf,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAGtC,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAC/D,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACrC,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACrC,IAAI,CAAC,aAAa,IAAI,CAAC,aAAa;YAAE,OAAO,CAAC,CAAC;QAE/C,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5F,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5F,OAAO,MAAM,GAAG,MAAM,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,KAAK,MAAM,OAAO,IAAI,cAAc,EAAE,CAAC;QACtC,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,CAAC,YAAY;YAAE,SAAS;QAE5B,MAAM,gBAAgB,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACrG,KAAK,CAAC,IAAI,CAAC,2BAA2B,cAAc,CAAC,OAAO,CAAC,KAAK,gBAAgB,WAAW,CAAC,CAAC;QAC/F,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAGf,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAChE,MAAM,YAAY,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACzC,MAAM,YAAY,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACzC,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY;gBAAE,OAAO,CAAC,CAAC;YAC7C,OAAO,YAAY,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;QAClD,CAAC,CAAC,CAAC;QAEH,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;YAC9B,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC1C,IAAI,CAAC,WAAW,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAS;YACvD,MAAM,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YAGnC,IAAI,CAAC,WAAW;gBAAE,SAAS;YAG3B,MAAM,SAAS,GAAG,WAAW,CAAC,QAAQ,IAAI,WAAW,CAAC,iBAAiB,CAAC;YACxE,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,MAAM,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;YAClF,KAAK,CAAC,IAAI,CAAC,qBAAqB,cAAc,CAAC,SAAS,CAAC,KAAK,GAAG,IAAI,QAAQ,EAAE,CAAC,CAAC;YACjF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAGf,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE,CAAC;gBAClC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;YACnC,CAAC;QACF,CAAC;IACF,CAAC;IAGD,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClB,KAAK,CAAC,IAAI,CAAC,YAAY,gBAAgB,CAAC,IAAI,yCAAyC,CAAC,CAAC;IAEvF,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC"}

package/dist/docs-search/docs-semantic-search.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=docs-semantic-search.test.d.ts.map

package/dist/docs-search/docs-semantic-search.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-semantic-search.test.d.ts","sourceRoot":"","sources":["../../src/docs-search/docs-semantic-search.test.ts"],"names":[],"mappings":""}