@youdotcom-oss/mcp 3.2.3 → 3.4.0

package/src/research/tests/research.utils.spec.ts

@@ -1,128 +0,0 @@
-import { describe, expect, test } from 'bun:test'
-import type { ResearchResponse } from '@youdotcom-oss/api'
-import { formatResearchResults } from '../research.utils.ts'
-
-describe('formatResearchResults', () => {
-  test('formats research response with sources correctly', () => {
-    const mockResponse: ResearchResponse = {
-      output: {
-        content: '# Research Answer\n\nThis is a comprehensive answer about the topic.',
-        content_type: 'text',
-        sources: [
-          {
-            url: 'https://example.com/source1',
-            title: 'Source One',
-            snippets: ['First snippet', 'Second snippet'],
-          },
-          {
-            url: 'https://example.com/source2',
-            title: 'Source Two',
-            snippets: ['Another snippet'],
-          },
-        ],
-      },
-    }
-
-    const result = formatResearchResults(mockResponse)
-
-    expect(result).toHaveProperty('content')
-    expect(result).toHaveProperty('structuredContent')
-    expect(Array.isArray(result.content)).toBe(true)
-    expect(result.content[0]).toHaveProperty('type', 'text')
-    expect(result.content[0]).toHaveProperty('text')
-
-    const text = result.content[0]?.text
-    expect(text).toContain('Research Answer')
-    expect(text).toContain('Source One')
-    expect(text).toContain('https://example.com/source1')
-
-    expect(result.structuredContent.contentType).toBe('text')
-    expect(result.structuredContent.sourceCount).toBe(2)
-    expect(result.structuredContent.sources).toHaveLength(2)
-    expect(result.structuredContent.sources[0]).toMatchObject({
-      url: 'https://example.com/source1',
-      title: 'Source One',
-      snippetCount: 2,
-    })
-    expect(result.structuredContent.sources[1]).toMatchObject({
-      url: 'https://example.com/source2',
-      title: 'Source Two',
-      snippetCount: 1,
-    })
-  })
-
-  test('handles source with undefined title', () => {
-    const mockResponse: ResearchResponse = {
-      output: {
-        content: 'Answer text',
-        content_type: 'text',
-        sources: [
-          {
-            url: 'https://example.com/no-title',
-            snippets: ['A snippet'],
-          },
-        ],
-      },
-    }
-
-    const result = formatResearchResults(mockResponse)
-
-    expect(result.structuredContent.sourceCount).toBe(1)
-    expect(result.structuredContent.sources[0]).toMatchObject({
-      url: 'https://example.com/no-title',
-      title: undefined,
-      snippetCount: 1,
-    })
-  })
-
-  test('handles source with empty snippets array', () => {
-    const mockResponse: ResearchResponse = {
-      output: {
-        content: 'Answer with no-snippet source',
-        content_type: 'text',
-        sources: [
-          {
-            url: 'https://example.com/empty-snippets',
-            title: 'Empty Snippets Source',
-            snippets: [],
-          },
-        ],
-      },
-    }
-
-    const result = formatResearchResults(mockResponse)
-
-    expect(result.structuredContent.sourceCount).toBe(1)
-    expect(result.structuredContent.sources[0]?.snippetCount).toBe(0)
-  })
-
-  test('handles source with undefined snippets', () => {
-    const mockResponse: ResearchResponse = {
-      output: {
-        content: 'Answer',
-        content_type: 'text',
-        sources: [{ url: 'https://example.com/no-snippets', title: 'No Snippets' }],
-      },
-    }
-
-    const result = formatResearchResults(mockResponse)
-
-    expect(result.structuredContent.sources[0]?.snippetCount).toBe(0)
-  })
-
-  test('handles response with zero sources', () => {
-    const mockResponse: ResearchResponse = {
-      output: {
-        content: 'An answer with no cited sources.',
-        content_type: 'text',
-        sources: [],
-      },
-    }
-
-    const result = formatResearchResults(mockResponse)
-
-    expect(result.structuredContent.sourceCount).toBe(0)
-    expect(result.structuredContent.sources).toHaveLength(0)
-    expect(result.content[0]?.text).toContain('An answer with no cited sources.')
-  })
-})

package/src/search/register-search-tool.ts

@@ -1,88 +0,0 @@
-import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
-import { fetchSearchResults, generateErrorReportLink, SearchQuerySchema } from '@youdotcom-oss/api'
-import { getLogger } from '../shared/get-logger.ts'
-import { SearchStructuredContentSchema } from './search.schemas.ts'
-import { formatSearchResults } from './search.utils.ts'
-
-export const registerSearchTool = ({
-  mcp,
-  YDC_API_KEY,
-  getUserAgent,
-}: {
-  mcp: McpServer
-  YDC_API_KEY?: string
-  getUserAgent: () => string
-}) => {
-  mcp.registerTool(
-    'you-search',
-    {
-      title: 'Web Search',
-      description:
-        'Web and news search via You.com. Supports domain filtering, language selection, livecrawl for full page content, and date freshness controls.',
-      inputSchema: SearchQuerySchema.shape,
-      outputSchema: SearchStructuredContentSchema.shape,
-    },
-    async (searchQuery, { sendNotification }) => {
-      const logger = getLogger(sendNotification)
-      try {
-        const response = await fetchSearchResults({
-          searchQuery,
-          YDC_API_KEY,
-          getUserAgent,
-        })
-
-        const webCount = response.results.web?.length ?? 0
-        const newsCount = response.results.news?.length ?? 0
-
-        if (!webCount && !newsCount) {
-          await logger({
-            level: 'info',
-            data: `No results found for query: "${searchQuery.query}"`,
-          })
-
-          return {
-            content: [{ type: 'text' as const, text: 'No results found.' }],
-            structuredContent: {
-              resultCounts: {
-                web: 0,
-                news: 0,
-                total: 0,
-              },
-            },
-          }
-        }
-
-        await logger({
-          level: 'info',
-          data: `Search successful for query: "${searchQuery.query}" - ${webCount} web results, ${newsCount} news results (${webCount + newsCount} total)`,
-        })
-
-        const { content, structuredContent } = formatSearchResults(response)
-        return { content, structuredContent }
-      } catch (err: unknown) {
-        const errorMessage = err instanceof Error ? err.message : String(err)
-        const reportLink = generateErrorReportLink({
-          errorMessage,
-          tool: 'you-search',
-          clientInfo: getUserAgent(),
-        })
-
-        await logger({
-          level: 'error',
-          data: `Search API call failed: ${errorMessage}\n\nReport this issue: ${reportLink}`,
-        })
-
-        return {
-          content: [
-            {
-              type: 'text' as const,
-              text: `Error: ${errorMessage}`,
-            },
-          ],
-          structuredContent: undefined,
-          isError: true,
-        }
-      }
-    },
-  )
-}

package/src/search/search.schemas.ts

@@ -1,53 +0,0 @@
-import * as z from 'zod'
-
-// Minimal schema for structuredContent (reduces payload duplication)
-// Excludes metadata (query, search_uuid, latency) as these are not actionable by LLM
-export const SearchStructuredContentSchema = z.object({
-  resultCounts: z.object({
-    web: z.number().describe('Web results'),
-    news: z.number().describe('News results'),
-    total: z.number().describe('Total results'),
-  }),
-  results: z
-    .object({
-      web: z
-        .array(
-          z.object({
-            url: z.string().describe('URL'),
-            title: z.string().describe('Title'),
-            page_age: z.string().optional().describe('Publication timestamp'),
-            snippets: z.array(z.string()).optional().describe('Content snippets'),
-            contents: z
-              .object({
-                html: z.string().optional().describe('Full HTML content'),
-                markdown: z.string().optional().describe('Full Markdown content'),
-              })
-              .optional()
-              .describe('Livecrawled page content'),
-          }),
-        )
-        .optional()
-        .describe('Web results'),
-      news: z
-        .array(
-          z.object({
-            url: z.string().describe('URL'),
-            title: z.string().describe('Title'),
-            page_age: z.string().describe('Publication timestamp'),
-            contents: z
-              .object({
-                html: z.string().optional().describe('Full HTML content'),
-                markdown: z.string().optional().describe('Full Markdown content'),
-              })
-              .optional()
-              .describe('Livecrawled page content'),
-          }),
-        )
-        .optional()
-        .describe('News results'),
-    })
-    .optional()
-    .describe('Search results'),
-})
-
-export type SearchStructuredContent = z.infer<typeof SearchStructuredContentSchema>

package/src/search/search.utils.ts

@@ -1,83 +0,0 @@
-import type { SearchResponse } from '@youdotcom-oss/api'
-import { formatSearchResultsText } from '../shared/format-search-results-text.ts'
-
-export const formatSearchResults = (response: SearchResponse) => {
-  let formattedResults = ''
-
-  // Format web results using shared utility
-  if (response.results.web?.length) {
-    const webResults = formatSearchResultsText(response.results.web)
-    formattedResults += `WEB RESULTS:\n\n${webResults}`
-  }
-
-  // Format news results using shared utility (consistent with web formatting)
-  if (response.results.news?.length) {
-    const newsResults = formatSearchResultsText(response.results.news)
-
-    if (formattedResults) {
-      formattedResults += `\n\n${'='.repeat(50)}\n\n`
-    }
-    formattedResults += `NEWS RESULTS:\n\n${newsResults}`
-  }
-
-  // Extract fields for structuredContent
-  const structuredResults: {
-    web?: Array<{
-      url: string
-      title: string
-      page_age?: string
-      snippets?: string[]
-      contents?: { html?: string; markdown?: string }
-    }>
-    news?: Array<{ url: string; title: string; page_age: string; contents?: { html?: string; markdown?: string } }>
-  } = {}
-
-  if (response.results.web?.length) {
-    structuredResults.web = response.results.web.map((result) => {
-      const item: {
-        url: string
-        title: string
-        page_age?: string
-        snippets?: string[]
-        contents?: { html?: string; markdown?: string }
-      } = {
-        url: result.url,
-        title: result.title,
-      }
-      if (result.page_age) item.page_age = result.page_age
-      if (result.snippets?.length) item.snippets = result.snippets
-      if (result.contents) item.contents = result.contents ?? undefined
-      return item
-    })
-  }
-
-  if (response.results.news?.length) {
-    structuredResults.news = response.results.news.map((article) => {
-      const item: { url: string; title: string; page_age: string; contents?: { html?: string; markdown?: string } } = {
-        url: article.url,
-        title: article.title,
-        page_age: article.page_age,
-      }
-      if (article.contents) item.contents = article.contents ?? undefined
-      return item
-    })
-  }
-
-  return {
-    content: [
-      {
-        type: 'text' as const,
-        text: `Search Results for "${response.metadata.query}":\n\n${formattedResults}`,
-      },
-    ],
-    structuredContent: {
-      resultCounts: {
-        web: response.results.web?.length || 0,
-        news: response.results.news?.length || 0,
-        total: (response.results.web?.length || 0) + (response.results.news?.length || 0),
-      },
-      results: Object.keys(structuredResults).length > 0 ? structuredResults : undefined,
-    },
-    fullResponse: response,
-  }
-}

package/src/search/tests/register-search-tool.spec.ts

@@ -1,123 +0,0 @@
-import { afterEach, beforeEach, describe, expect, spyOn, test } from 'bun:test'
-import { Client } from '@modelcontextprotocol/sdk/client/index.js'
-import { InMemoryTransport } from '@modelcontextprotocol/sdk/inMemory.js'
-import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
-import type { SearchResponse } from '@youdotcom-oss/api'
-import * as api from '@youdotcom-oss/api'
-import { registerSearchTool } from '../register-search-tool.ts'
-
-const emptyResponse: SearchResponse = {
-  results: { web: [], news: [] },
-  metadata: { search_uuid: 'test', query: 'test', latency: 0 },
-}
-
-const oneResultResponse: SearchResponse = {
-  results: {
-    web: [
-      {
-        url: 'https://example.com',
-        title: 'Example',
-        description: 'A test result',
-        snippets: ['snippet'],
-        page_age: '2025-01-01T00:00:00',
-        authors: [],
-      },
-    ],
-    news: [],
-  },
-  metadata: { search_uuid: 'test', query: 'test', latency: 0.1 },
-}
-
-let mockFetchResponse: SearchResponse | Error = emptyResponse
-let fetchSearchResultsSpy: ReturnType<typeof spyOn<typeof api, 'fetchSearchResults'>> | undefined
-let generateErrorReportLinkSpy: ReturnType<typeof spyOn<typeof api, 'generateErrorReportLink'>> | undefined
-
-type Cleanup = () => Promise<void>
-
-const setupMcpClient = async (): Promise<{ client: Client; cleanup: Cleanup }> => {
-  const server = new McpServer({ name: 'test', version: '0.0.0' }, { capabilities: { logging: {}, tools: {} } })
-  registerSearchTool({
-    mcp: server,
-    YDC_API_KEY: 'test-key',
-    getUserAgent: () => 'test-agent',
-  })
-
-  const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair()
-  await server.connect(serverTransport)
-
-  const client = new Client({ name: 'test-client', version: '0.0.0' })
-  await client.connect(clientTransport)
-
-  const cleanup = async () => {
-    await client.close()
-    await server.close()
-  }
-
-  return { client, cleanup }
-}
-
-describe('registerSearchTool', () => {
-  let cleanup: Cleanup | undefined
-
-  beforeEach(() => {
-    mockFetchResponse = emptyResponse
-    fetchSearchResultsSpy = spyOn(api, 'fetchSearchResults').mockImplementation(async () => {
-      if (mockFetchResponse instanceof Error) throw mockFetchResponse
-      return mockFetchResponse
-    })
-    generateErrorReportLinkSpy = spyOn(api, 'generateErrorReportLink').mockImplementation(
-      () => 'https://example.com/report',
-    )
-  })
-
-  afterEach(async () => {
-    if (cleanup) {
-      await cleanup()
-      cleanup = undefined
-    }
-    fetchSearchResultsSpy?.mockRestore()
-    fetchSearchResultsSpy = undefined
-    generateErrorReportLinkSpy?.mockRestore()
-    generateErrorReportLinkSpy = undefined
-  })
-
-  test('handles empty search results gracefully', async () => {
-    const result = await setupMcpClient()
-    cleanup = result.cleanup
-
-    const toolResult = await result.client.callTool({ name: 'you-search', arguments: { query: 'nonexistent' } })
-
-    expect(toolResult.content).toEqual([{ type: 'text', text: 'No results found.' }])
-    expect(toolResult.structuredContent).toEqual({
-      resultCounts: { web: 0, news: 0, total: 0 },
-    })
-  })
-
-  test('returns formatted results for successful search', async () => {
-    mockFetchResponse = oneResultResponse
-    const result = await setupMcpClient()
-    cleanup = result.cleanup
-
-    const toolResult = await result.client.callTool({ name: 'you-search', arguments: { query: 'example' } })
-
-    const text = (toolResult.content as Array<{ type: string; text: string }>)[0]?.text
-    expect(text).toContain('Example')
-    expect(text).toContain('https://example.com')
-
-    const structured = toolResult.structuredContent as Record<string, unknown>
-    expect(structured).toHaveProperty('resultCounts')
-    expect((structured as { resultCounts: { total: number } }).resultCounts.total).toBe(1)
-  })
-
-  test('returns error when API call fails', async () => {
-    mockFetchResponse = new Error('API rate limit exceeded')
-    const result = await setupMcpClient()
-    cleanup = result.cleanup
-
-    const toolResult = await result.client.callTool({ name: 'you-search', arguments: { query: 'test' } })
-
-    expect(toolResult.isError).toBe(true)
-    const text = (toolResult.content as Array<{ type: string; text: string }>)[0]?.text
-    expect(text).toContain('API rate limit exceeded')
-  })
-})