Document Search Skill
This skill provides access to an indexed document knowledge base via BM25 keyword search.
The MCP server exposes two tools: doc-search:doc_search and doc-search:doc_search_status.
When to Search
ALWAYS search the knowledge base proactively — do not guess or rely on general knowledge alone.
Trigger search when user asks about:
- EDA tool usage (Innovus, ICC, DC, PrimeTime, Calibre, Virtuoso, etc.)
- Company internal procedures, IT policies, onboarding guides
- Technical commands, APIs, tool configurations
- Bug reports, known issues, workarounds
- Any specialized domain topic that may be covered by indexed documents
MCP Tools
doc-search:doc_search
Search indexed documents by keyword.
Parameters:
query (string, required): The search query. Use specific technical terms for best results.category (string, optional): Filter by category. Common categories:
eda — EDA tool documentation (Innovus, ICC, etc.)company — Company internal documents (IT, HR, procedures)bugs — Bug reports and known issuesdefault — Uncategorized documents
n_results (integer, optional): Number of results to return (default: 5)
doc-search:doc_search_status
Check what documents are indexed and available for search. No parameters required.
Use this when the user asks what documents or categories are available.
Search Strategy
- Start broad, then narrow: If the first search returns no results, try alternative keywords or remove the category filter.
- Use technical terms: BM25 matches on keywords, so use specific terms from the domain (e.g., "setDesignMode" instead of "design mode setting").
- Try both languages: For bilingual documentation, search in both English and Chinese if initial results are insufficient.
- Multiple searches: For complex questions, perform multiple searches with different queries to gather comprehensive information.
Response Format
After searching, the assistant should:
- Provide a direct answer synthesized from the search results
- Cite sources — include the document name and page number when available
- Quote relevant passages when precision matters (commands, syntax, parameters)
- If results are insufficient, inform the user and suggest they index additional documents
Indexing Documents (for user reference)
Documents must be indexed before they can be searched. The user indexes documents via CLI:
# Index a directory recursively
doc-search index ./docs --recursive --category eda
# Check what's indexed
doc-search status
# Clear and re-index
doc-search clear --category eda --force
doc-search index ./docs --recursive --category eda
Supported formats: PDF, DOCX, XLSX, PPTX, TXT, MD
1---2name: doc-search-23description: Search indexed documents (PDF, Word, Excel, PPT, TXT) using BM25 keyword search. Use for EDA tools, company docs, bug reports, and technical documentation.4---56# Document Search Skill78This skill provides access to an indexed document knowledge base via BM25 keyword search.9The MCP server exposes two tools: `doc-search:doc_search` and `doc-search:doc_search_status`.1011## When to Search1213ALWAYS search the knowledge base proactively — do not guess or rely on general knowledge alone.1415Trigger search when user asks about:16- EDA tool usage (Innovus, ICC, DC, PrimeTime, Calibre, Virtuoso, etc.)17- Company internal procedures, IT policies, onboarding guides18- Technical commands, APIs, tool configurations19- Bug reports, known issues, workarounds20- Any specialized domain topic that may be covered by indexed documents2122## MCP Tools2324### `doc-search:doc_search`2526Search indexed documents by keyword.2728Parameters:29- `query` (string, required): The search query. Use specific technical terms for best results.30- `category` (string, optional): Filter by category. Common categories:31 - `eda` — EDA tool documentation (Innovus, ICC, etc.)32 - `company` — Company internal documents (IT, HR, procedures)33 - `bugs` — Bug reports and known issues34 - `default` — Uncategorized documents35- `n_results` (integer, optional): Number of results to return (default: 5)3637### `doc-search:doc_search_status`3839Check what documents are indexed and available for search. No parameters required.40Use this when the user asks what documents or categories are available.4142## Search Strategy43441. **Start broad, then narrow**: If the first search returns no results, try alternative keywords or remove the category filter.452. **Use technical terms**: BM25 matches on keywords, so use specific terms from the domain (e.g., "setDesignMode" instead of "design mode setting").463. **Try both languages**: For bilingual documentation, search in both English and Chinese if initial results are insufficient.474. **Multiple searches**: For complex questions, perform multiple searches with different queries to gather comprehensive information.4849## Response Format5051After searching, the assistant should:521. Provide a **direct answer** synthesized from the search results532. **Cite sources** — include the document name and page number when available543. **Quote relevant passages** when precision matters (commands, syntax, parameters)554. If results are insufficient, inform the user and suggest they index additional documents5657## Indexing Documents (for user reference)5859Documents must be indexed before they can be searched. The user indexes documents via CLI:6061```bash62# Index a directory recursively63doc-search index ./docs --recursive --category eda6465# Check what's indexed66doc-search status6768# Clear and re-index69doc-search clear --category eda --force70doc-search index ./docs --recursive --category eda71```7273Supported formats: PDF, DOCX, XLSX, PPTX, TXT, MD
r04943083