From 03559613b4c5b89b4e9e7e9654bcc5770596a8fc Mon Sep 17 00:00:00 2001 From: Aligmantas Krasauskas Date: Wed, 28 Jan 2026 10:08:10 +0200 Subject: [PATCH] Add skills.sh integration for AI agent discovery Adds a SKILL.md following the Agent Skills specification (agentskills.io) so qmd can be discovered and used by AI agents via skills.sh. - skills/qmd/SKILL.md: Main skill definition with search commands, options, workflows, and MCP tool documentation - skills/qmd/references/MCP-SETUP.md: Detailed MCP server setup guide - .gitignore: Allow .md files in skills/ directory Users can install via: npx skills add tobi/qmd The skill supports both CLI usage (via Bash) and MCP server integration, documenting all qmd_* tools and their CLI equivalents. Co-Authored-By: Claude Opus 4.5 --- .gitignore | 1 + skills/qmd/SKILL.md | 160 +++++++++++++++++++++++++++++ skills/qmd/references/MCP-SETUP.md | 128 +++++++++++++++++++++++ 3 files changed, 289 insertions(+) create mode 100644 skills/qmd/SKILL.md create mode 100644 skills/qmd/references/MCP-SETUP.md diff --git a/.gitignore b/.gitignore index 7e259a62..24cf666a 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,4 @@ texts/ *.md !README.md !CLAUDE.md +!skills/**/*.md diff --git a/skills/qmd/SKILL.md b/skills/qmd/SKILL.md new file mode 100644 index 00000000..988bab9b --- /dev/null +++ b/skills/qmd/SKILL.md @@ -0,0 +1,160 @@ +--- +name: qmd +description: Search personal markdown knowledge bases, notes, meeting transcripts, and documentation using QMD - a local hybrid search engine. Combines BM25 keyword search, vector semantic search, and LLM re-ranking. Use when users ask to search notes, find documents, look up information in their knowledge base, retrieve meeting notes, or search documentation. Triggers on "search my notes", "find in docs", "look up", "what did I write about", "meeting notes about". +license: MIT +compatibility: Requires qmd installed via `bun install -g https://github.com/tobi/qmd`. Works with Claude Code CLI and MCP-compatible agents. +metadata: + author: tobi + version: "1.0" +allowed-tools: Bash(qmd:*) +--- + +# QMD - Quick Markdown Search + +QMD is a local, on-device search engine for markdown content. It indexes your notes, meeting transcripts, documentation, and knowledge bases for fast retrieval. + +## When to Use This Skill + +- User asks to search their notes, documents, or knowledge base +- User needs to find information in their markdown files +- User wants to retrieve specific documents or search across collections +- User asks "what did I write about X" or "find my notes on Y" +- User needs semantic search (conceptual similarity) not just keyword matching +- User mentions meeting notes, transcripts, or documentation lookup + +## Search Commands + +Choose the right search mode for the task: + +| Command | Use When | Speed | +|---------|----------|-------| +| `qmd search` | Exact keyword matches needed | Fast | +| `qmd vsearch` | Keywords aren't working, need conceptual matches | Medium | +| `qmd query` | Best results needed, speed not critical | Slower | + +```sh +# Fast keyword search (BM25) +qmd search "your query" + +# Semantic vector search (finds conceptually similar content) +qmd vsearch "your query" + +# Hybrid search with re-ranking (best quality) +qmd query "your query" +``` + +## Common Options + +```sh +-n # Number of results (default: 5) +-c, --collection # Restrict to specific collection +--all # Return all matches +--min-score # Minimum score threshold (0.0-1.0) +--full # Show full document content +--json # JSON output for processing +--files # List files with scores +--line-numbers # Add line numbers to output +``` + +## Document Retrieval + +```sh +# Get document by path +qmd get "collection/path/to/doc.md" + +# Get document by docid (shown in search results as #abc123) +qmd get "#abc123" + +# Get with line numbers for code review +qmd get "docs/api.md" --line-numbers + +# Get multiple documents by glob pattern +qmd multi-get "docs/*.md" + +# Get multiple documents by list +qmd multi-get "doc1.md, doc2.md, #abc123" +``` + +## Index Management + +```sh +# Check index status and available collections +qmd status + +# List all collections +qmd collection list + +# List files in a collection +qmd ls + +# Update index (re-scan files for changes) +qmd update +``` + +## Score Interpretation + +| Score | Meaning | Action | +|-------|---------|--------| +| 0.8 - 1.0 | Highly relevant | Show to user | +| 0.5 - 0.8 | Moderately relevant | Include if few results | +| 0.2 - 0.5 | Somewhat relevant | Only if user wants more | +| 0.0 - 0.2 | Low relevance | Usually skip | + +## Recommended Workflow + +1. **Check what's available**: `qmd status` +2. **Start with keyword search**: `qmd search "topic" -n 10` +3. **Try semantic if needed**: `qmd vsearch "describe the concept"` +4. **Use hybrid for best results**: `qmd query "question" --min-score 0.4` +5. **Retrieve full documents**: `qmd get "#docid" --full` + +## Example: Finding Meeting Notes + +```sh +# Search for meetings about a topic +qmd search "quarterly review" -c meetings -n 5 + +# Get semantic matches +qmd vsearch "performance discussion" -c meetings + +# Retrieve the full meeting notes +qmd get "#abc123" --full +``` + +## Example: Research Across All Notes + +```sh +# Hybrid search for best results +qmd query "authentication implementation" --min-score 0.3 --json + +# Get all relevant files for deeper analysis +qmd query "auth flow" --all --files --min-score 0.4 +``` + +## MCP Server Integration + +QMD also works as an MCP server, providing these tools directly: + +| MCP Tool | Equivalent CLI | Purpose | +|----------|---------------|---------| +| `qmd_search` | `qmd search` | Fast BM25 keyword search | +| `qmd_vsearch` | `qmd vsearch` | Semantic vector search | +| `qmd_query` | `qmd query` | Hybrid search with reranking | +| `qmd_get` | `qmd get` | Retrieve document by path or docid | +| `qmd_multi_get` | `qmd multi-get` | Retrieve multiple documents | +| `qmd_status` | `qmd status` | Index health and collection info | + +To enable MCP tools, add to `~/.claude/settings.json`: + +```json +{ + "mcpServers": { + "qmd": { + "command": "qmd", + "args": ["mcp"] + } + } +} +``` + +When MCP is configured, prefer using the `qmd_*` tools directly instead of Bash commands for better integration. diff --git a/skills/qmd/references/MCP-SETUP.md b/skills/qmd/references/MCP-SETUP.md new file mode 100644 index 00000000..86c13713 --- /dev/null +++ b/skills/qmd/references/MCP-SETUP.md @@ -0,0 +1,128 @@ +# QMD MCP Server Setup + +Detailed instructions for configuring QMD as an MCP (Model Context Protocol) server. + +## Prerequisites + +1. Install qmd globally: + ```sh + bun install -g https://github.com/tobi/qmd + ``` + +2. Verify installation: + ```sh + qmd --help + ``` + +3. Set up at least one collection: + ```sh + qmd collection add ~/Documents/notes --name notes + qmd embed # Generate vector embeddings + ``` + +## Claude Code Configuration + +Add to `~/.claude/settings.json`: + +```json +{ + "mcpServers": { + "qmd": { + "command": "qmd", + "args": ["mcp"] + } + } +} +``` + +## Claude Desktop Configuration + +Add to `~/Library/Application Support/Claude/claude_desktop_config.json`: + +```json +{ + "mcpServers": { + "qmd": { + "command": "qmd", + "args": ["mcp"] + } + } +} +``` + +## Available MCP Tools + +Once configured, these tools become available: + +### qmd_search +Fast BM25 keyword search. + +**Parameters:** +- `query` (required): Search query string +- `collection` (optional): Restrict to specific collection +- `limit` (optional): Number of results (default: 5) +- `minScore` (optional): Minimum relevance score + +### qmd_vsearch +Semantic vector search for conceptual similarity. + +**Parameters:** +- `query` (required): Search query string +- `collection` (optional): Restrict to specific collection +- `limit` (optional): Number of results (default: 5) +- `minScore` (optional): Minimum relevance score + +### qmd_query +Hybrid search combining BM25, vector search, and LLM re-ranking. + +**Parameters:** +- `query` (required): Search query string +- `collection` (optional): Restrict to specific collection +- `limit` (optional): Number of results (default: 5) +- `minScore` (optional): Minimum relevance score + +### qmd_get +Retrieve a document by path or docid. + +**Parameters:** +- `path` (required): Document path or docid (e.g., `#abc123`) +- `full` (optional): Return full content (default: true) +- `lineNumbers` (optional): Include line numbers + +### qmd_multi_get +Retrieve multiple documents. + +**Parameters:** +- `pattern` (required): Glob pattern or comma-separated list +- `maxBytes` (optional): Skip files larger than this (default: 10KB) + +### qmd_status +Get index health and collection information. + +**Parameters:** None + +## Troubleshooting + +### MCP server not starting +- Ensure qmd is in your PATH: `which qmd` +- Try running `qmd mcp` manually to see errors +- Check that Bun is installed: `bun --version` + +### No results returned +- Verify collections exist: `qmd collection list` +- Check index status: `qmd status` +- Ensure embeddings are generated: `qmd embed` + +### Slow searches +- For faster results, use `qmd_search` instead of `qmd_query` +- The first search may be slow while models load (~3GB) +- Subsequent searches are much faster + +## Choosing Between CLI and MCP + +| Scenario | Recommendation | +|----------|---------------| +| MCP configured | Use `qmd_*` tools directly | +| No MCP | Use Bash with `qmd` commands | +| Complex pipelines | Bash may be more flexible | +| Simple lookups | MCP tools are cleaner |