search
Use semantic similarity to query HoloViz and custom project documentation, returning relevant snippets or full documents.
Instructions
Search the HoloViz and any user defined project documentation using semantic similarity.
IMPORTANT: This is a general purpose search tool. Not just for searching the HoloViz documentation.
DO use this tool to search the HoloViz project documentation DO use this tool to search any additional user-defined project documentation. DO use the project_list tool to list the available projects.
BEST PRACTICES:
For initial exploration, use content=False to get an overview of available documents
Use content="chunk" for quick snippets, content="full" for complete documents
Adjust max_content_chars if you need more or less content per result
Set max_content_chars=None to get untruncated content (use with caution for large docs)
QUERY OPTIMIZATION: The search uses context-aware truncation that centers returned content on query keywords. To get the most relevant excerpts:
Use SPECIFIC terms: "CheckboxEditor SelectEditor" > "editor dropdown"
Use UNIQUE identifiers: "background_gradient text_gradient" > "styling colors"
Avoid COMMON terms that appear everywhere: "pandas", "import", "data", "widget"
Include CLASS/FUNCTION names: "add_filter RangeSlider" > "filtering with widgets"
Use MULTIPLE specific terms: Helps the algorithm find the right section
Target FEATURE-SPECIFIC vocabulary: Terms unique to the feature you're looking for
Example: Instead of "how to add pagination to a table", use "pagination page_size local remote" This ensures the truncated content focuses on the pagination section, not generic table info.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Search query using natural language or specific keywords. Natural language works for finding documents, but specific terms work better for content truncation. See QUERY OPTIMIZATION above. Good examples: "Button onClick on_click callback event", "hvPlot bar chart kind options" Okay examples: "how to style Material UI components", "interactive plotting with widgets" | |
| project | No | Optional project filter. Defaults to None. Examples: "panel", "hvplot", "my-custom-project" | |
| content | No | Controls what content is returned. Defaults to "truncated". - "truncated": Full document content, smart-truncated around query keywords (default) - "chunk": Only the best-matching chunk from the document - "full": Full document content with no truncation (can be very large) - False: No content, metadata only (fastest) For backward compat, True maps to "truncated". | truncated |
| max_results | No | Maximum number of results to return. Defaults to 2. Increase if you need more options, but be mindful of response size. | |
| max_content_chars | No | Maximum characters of content per result. Defaults to 10000. Set to None for untruncated content (may cause token limit errors). Content is truncated at word boundaries with an ellipsis indicator. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |