search_docs Tool

interface SearchToolOptions {
  library: string;
  version?: string;
  query: string;
  limit?: number;
  exactMatch?: boolean;
}

interface SearchToolResult {
  results: StoreSearchResult[];
}

interface StoreSearchResult {
  url: string;
  content: string;
  library: string;
  version: string;
  score: number;
}

{
  "name": "search_docs",
  "arguments": {
    "library": "react",
    "query": "hooks lifecycle"
  }
}

{
  "name": "search_docs",
  "arguments": {
    "library": "react",
    "version": "18.0.0",
    "query": "hooks lifecycle",
    "limit": 3
  }
}

{
  "name": "search_docs",
  "arguments": {
    "library": "typescript",
    "version": "5.x",
    "query": "ReturnType example"
  }
}

{
  "results": [
    {
      "url": "https://react.dev/reference/react/hooks",
      "content": "# Hooks\n\nHooks let you use different React features from your components. You can either use the built-in Hooks or combine them to build your own...\n\n## State Hooks\n\nState lets a component remember information like user input. For example, a form component can use state to store the input value...",
      "library": "react",
      "version": "18.2.0",
      "score": 0.89
    },
    {
      "url": "https://react.dev/reference/react/useState",
      "content": "# useState\n\n`useState` is a React Hook that lets you add a state variable to your component.\n\n```js\nconst [state, setState] = useState(initialState);\n```\n\n## Reference\n\n### `useState(initialState)`\n\nCall `useState` at the top level of your component to declare a state variable...",
      "library": "react",
      "version": "18.2.0",
      "score": 0.85
    }
  ]
}

------------------------------------------------------------
Result 1: https://react.dev/reference/react/hooks

# Hooks

Hooks let you use different React features from your components. You can either use the built-in Hooks or combine them to build your own...

------------------------------------------------------------
Result 2: https://react.dev/reference/react/useState

# useState

`useState` is a React Hook that lets you add a state variable to your component...

No results found for 'hooks lifecycle' in react. Try to use a different or more general query.

{
  "error": "Library name is required and must be a non-empty string."
}

{
  "error": "Query is required and must be a non-empty string."
}

{
  "error": "Limit must be a number between 1 and 100."
}

{
  "error": "Library 'reactjs' not found in store.",
  "suggestions": ["react", "react-dom", "react-router"]
}

{
  "error": "Version '19.0.0' not found for library 'react'.",
  "availableVersions": [
    {
      "version": "18.2.0",
      "documentCount": 342,
      "uniqueUrlCount": 156,
      "indexedAt": "2024-03-15T10:30:00.000Z"
    },
    {
      "version": "17.0.2",
      "documentCount": 298,
      "uniqueUrlCount": 134,
      "indexedAt": "2024-02-20T08:15:00.000Z"
    }
  ]
}

Search the React documentation for information about hooks lifecycle.

Search TypeScript 5.x docs for ReturnType examples.

import { Client } from '@modelcontextprotocol/sdk/client/index.js';

const result = await client.callTool({
  name: 'search_docs',
  arguments: {
    library: 'react',
    version: '18.x',
    query: 'hooks lifecycle',
    limit: 5
  }
});

async execute(options: SearchToolOptions): Promise<SearchToolResult> {
  const { library, version, query, limit = 5, exactMatch = false } = options;
  
  // Validate inputs
  if (!library || typeof library !== "string" || library.trim() === "") {
    throw new ValidationError(
      "Library name is required and must be a non-empty string.",
      this.constructor.name,
    );
  }
  
  if (!query || typeof query !== "string" || query.trim() === "") {
    throw new ValidationError(
      "Query is required and must be a non-empty string.",
      this.constructor.name,
    );
  }
  
  if (limit !== undefined && (typeof limit !== "number" || limit < 1 || limit > 100)) {
    throw new ValidationError(
      "Limit must be a number between 1 and 100.",
      this.constructor.name,
    );
  }
  
  // Validate library exists
  await this.docService.validateLibraryExists(library);
  
  // Resolve version if not exact match
  let versionToSearch: string | null | undefined = version || "latest";
  
  if (!exactMatch) {
    const versionResult = await this.docService.findBestVersion(library, version);
    versionToSearch = versionResult.bestMatch;
  }
  
  // Perform search
  const results = await this.docService.searchStore(
    library,
    versionToSearch,
    query,
    limit,
  );
  
  logger.info(`✅ Found ${results.length} matching results`);
  
  return { results };
}

{ "version": "18.x" }

{ "version": undefined }

{ "version": "18.2.0-rc.1" }