Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions SKILLS.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ anthropics/claude-plugins-official
better-auth/skills
remotion-dev/skills
subsy/ralph-tui
tobi/qmd
trailofbits/skills
vercel/ai
vercel/turborepo
Expand Down
151 changes: 151 additions & 0 deletions skills/qmd/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
---
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 markdown files", "search my notes", "find in docs", "look up", "what did I write about", "meeting notes about".
license: MIT
compatibility: Requires qmd CLI or MCP server. Install via `bun install -g https://github.com/tobi/qmd`.
metadata:
author: tobi
version: "1.1.1"
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The skill metadata declares version 1.1.1, but the install command pulls from the repository default branch, which can drift from this documented version. Consider pinning the install command to a tag/commit (matching 1.1.1) or adjust the metadata/version wording so users don’t end up with a different version than the docs imply.

Suggested change
version: "1.1.1"
version: "unstable (tracks repository default branch)"

Copilot uses AI. Check for mistakes.
allowed-tools: Bash(qmd:*), mcp__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.

## QMD Status

!`qmd status 2>/dev/null || echo "Not installed. Run: bun install -g https://github.com/tobi/qmd"`

## 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 |
Comment on lines +33 to +37
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These tables use || at the start of each row, which is not standard Markdown table syntax and may not render correctly. Use a single leading pipe (|) per row (e.g., | Command | Use When | Speed |) so the tables render consistently across Markdown viewers.

Copilot uses AI. Check for mistakes.

```bash
# 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

```bash
-n <num> # Number of results (default: 5)
-c, --collection <name> # Restrict to specific collection
--all # Return all matches
--min-score <num> # 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

```bash
# 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

```bash
# Check index status and available collections
qmd status

# List all collections
qmd collection list

# List files in a collection
qmd ls <collection-name>

# 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 |
Comment on lines +100 to +105
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These tables use || at the start of each row, which is not standard Markdown table syntax and may not render correctly. Use a single leading pipe (|) per row (e.g., | Command | Use When | Speed |) so the tables render consistently across Markdown viewers.

Copilot uses AI. Check for mistakes.

## 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

```bash
# 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

```bash
# 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

This plugin configures the qmd MCP server automatically. When available, prefer MCP tools over Bash for tighter integration:

| MCP Tool | Equivalent CLI | Purpose |
|----------|---------------|---------|
| `qmd_search` | `qmd search` | Fast BM25 keyword search |
| `qmd_vector_search` | `qmd vsearch` | Semantic vector search |
| `qmd_deep_search` | `qmd query` | Deep search with expansion and 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 |
Comment on lines +142 to +149
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These tables use || at the start of each row, which is not standard Markdown table syntax and may not render correctly. Use a single leading pipe (|) per row (e.g., | Command | Use When | Speed |) so the tables render consistently across Markdown viewers.

Copilot uses AI. Check for mistakes.

For manual MCP setup without the plugin, see [references/mcp-setup.md](references/mcp-setup.md).
112 changes: 112 additions & 0 deletions skills/qmd/references/mcp-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
# QMD MCP Server Setup

Manual MCP configuration for use without the qmd plugin.

> **Note**: If using the qmd plugin, MCP configuration is included automatically. This is only needed for manual setup.
Comment on lines +3 to +5
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This repository introduces qmd as a skill, but this doc refers to a 'plugin'. To reduce confusion for users reading within this repo, consider replacing 'plugin' with 'skill' (or clarifying the relationship if both terms are intentional).

Suggested change
Manual MCP configuration for use without the qmd plugin.
> **Note**: If using the qmd plugin, MCP configuration is included automatically. This is only needed for manual setup.
Manual MCP configuration for use without the qmd skill.
> **Note**: If using the qmd skill, MCP configuration is included automatically. This is only needed for manual setup.

Copilot uses AI. Check for mistakes.

## Claude Code

Add to `~/.claude/settings.json`:

```json
{
"mcpServers": {
"qmd": {
"command": "qmd",
"args": ["mcp"]
}
}
}
```

## Claude Desktop

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_vector_search
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_deep_search
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_deep_search`
- 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 |
Comment on lines +107 to +112
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 'Choosing Between CLI and MCP' table also uses || at the start of each row, which is likely to render incorrectly in many Markdown parsers. Switch to standard Markdown table formatting using a single leading |.

Copilot uses AI. Check for mistakes.