agentleFS
r04943083r04943083/doc-search-skill/.claude/skills/doc-search/SKILL.md

doc-search

Skill0 starsChanged 9 months agoMITView on GitHub

Search indexed documents (PDF, Word, Excel, PPT, TXT) using BM25 keyword search. Use for EDA tools, company docs, bug reports, and technical documentation.

2 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions2 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 2

    1. jellydn/my-ai-tools★ 129same name
    2. danielfrg/skills★ 1same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

The file

We split this skill into the rules it gives an agent

8 rules. About 0 are common, 8 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈8

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    ALWAYS search the knowledge base proactively — do not guess or rely on general knowledge alone.

    line 14
  2. Distinctive:

    Search indexed documents by keyword.

    line 27
  3. Distinctive:

    Check what documents are indexed and available for search.

    line 40
  4. Distinctive:

    Use this when the user asks what documents or categories are available.

    line 41
  5. Distinctive:

    Start broad, then narrow: If the first search returns no results, try alternative keywords or remove the category filter.

    line 45
  6. Distinctive:

    After searching, the assistant should:

    line 52
  7. Distinctive:

    Quote relevant passages: when precision matters (commands, syntax, parameters)

    line 55
  8. Distinctive:

    If results are insufficient, inform the user and suggest they index additional documents

    line 56

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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 issues
    • default — 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

  1. Start broad, then narrow: If the first search returns no results, try alternative keywords or remove the category filter.
  2. Use technical terms: BM25 matches on keywords, so use specific terms from the domain (e.g., "setDesignMode" instead of "design mode setting").
  3. Try both languages: For bilingual documentation, search in both English and Chinese if initial results are insufficient.
  4. Multiple searches: For complex questions, perform multiple searches with different queries to gather comprehensive information.

Response Format

After searching, the assistant should:

  1. Provide a direct answer synthesized from the search results
  2. Cite sources — include the document name and page number when available
  3. Quote relevant passages when precision matters (commands, syntax, parameters)
  4. 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

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.