Search PDFDancer documentation

Instructions

Implementation Reference

• src/index.ts:245-262 (handler)

  The core handler function for the 'search-docs' tool. It makes an API call to the search endpoint with the provided query and optional maxResults, then formats the response using helper functions and returns both markdown content and structured data.

  async ({query, maxResults}) => {
      const data = await callApi<SearchResponse>('/search', {
          searchParams: {
              q: query,
              maxResults
          }
      });
  
      return {
          content: [
              {
                  type: 'text' as const,
                  text: `${summarizeSearchResponse(data)}\n\n${formatJsonBlock('Raw search response', data)}`
              }
          ],
          structuredContent: data
      };
  }

• src/index.ts:237-243 (schema)

  Input schema and metadata for the 'search-docs' tool, defining title, description, and Zod validation for parameters: required 'query' string and optional 'maxResults' integer (1-10).

  {
      title: 'Search PDFDancer documentation',
      description: 'Search the official PDFDancer SDK documentation by keyword. Returns matching documentation routes with titles, content snippets, and relevance scores. Use this to find information about PDFDancer features, APIs, and usage examples.',
      inputSchema: {
          query: z.string().min(1, 'query is required'),
          maxResults: z.number().int().min(1).max(10).optional()
      }

• src/index.ts:235-263 (registration)

  Complete registration of the 'search-docs' tool via server.registerTool(), including schema, title, description, and inline handler implementation.

  server.registerTool(
      'search-docs',
      {
          title: 'Search PDFDancer documentation',
          description: 'Search the official PDFDancer SDK documentation by keyword. Returns matching documentation routes with titles, content snippets, and relevance scores. Use this to find information about PDFDancer features, APIs, and usage examples.',
          inputSchema: {
              query: z.string().min(1, 'query is required'),
              maxResults: z.number().int().min(1).max(10).optional()
          }
      },
      async ({query, maxResults}) => {
          const data = await callApi<SearchResponse>('/search', {
              searchParams: {
                  q: query,
                  maxResults
              }
          });
  
          return {
              content: [
                  {
                      type: 'text' as const,
                      text: `${summarizeSearchResponse(data)}\n\n${formatJsonBlock('Raw search response', data)}`
                  }
              ],
              structuredContent: data
          };
      }
  );

• src/index.ts:116-129 (helper)

  Helper function used by the handler to create a human-readable summary of search results, showing top 5 matches with titles, routes, and scores.

  function summarizeSearchResponse(data: SearchResponse): string {
      if (!data.results?.length) {
          return `No matches for "${data.query}".`;
      }
  
      const lines = data.results.slice(0, 5).map((result, index) => {
          const title = result.pageTitle ?? result.sectionTitle ?? result.sectionRoute;
          const score = typeof result.score === 'number' ? `score=${result.score.toFixed(3)}` : '';
          return `${index + 1}. ${title} → ${result.sectionRoute} ${score}`.trim();
      });
  
      const summary = `${data.total} result(s) for "${data.query}" (showing ${lines.length}, ${data.took}ms).`;
      return `${summary}\n${lines.join('\n')}`;
  }

• src/index.ts:67-110 (helper)

  Generic API client helper function used by the handler to make HTTP requests to the PDFDancer docs search backend, handling params, JSON, errors.

  async function callApi<T>(path: string, options: ApiRequestOptions = {}): Promise<T> {
      const url = new URL(path, apiBase);
      if (options.searchParams) {
          Object.entries(options.searchParams).forEach(([key, value]) => {
              if (value !== undefined && value !== null && value !== '') {
                  url.searchParams.set(key, String(value));
              }
          });
      }
  
      const method = options.method ?? 'GET';
      const init: RequestInit = {
          method,
          headers: {
              Accept: 'application/json',
              ...(options.body ? {'Content-Type': 'application/json'} : {})
          }
      };
  
      if (options.body && method === 'POST') {
          init.body = JSON.stringify(options.body);
      }
  
      const response = await fetch(url, init);
      const text = await response.text();
  
      if (!response.ok) {
          throw new Error(
              `Request to ${url.toString()} failed with status ${response.status}: ${
                  text || response.statusText
              }`
          );
      }
  
      if (!text) {
          return undefined as T;
      }
  
      try {
          return JSON.parse(text) as T;
      } catch (error) {
          throw new Error(`Failed to parse JSON response from ${url.toString()}: ${error}`);
      }
  }