AI导哈

Markdown文件索引与搜索工具

mdq是一个基于Meilisearch的CLI工具，支持本地Markdown文件的索引和搜索，并提供MCP服务器功能。

  • by aaronshaf
  • TypeScript
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 aaronshaf/md

使用说明

mdq

CLI，用于通过Meilisearch对本地markdown文件进行索引和搜索，并支持MCP服务器。

快速开始

1.安装

curl -fsSL https://bun.sh/install | bash
bun install -g @aaronshaf/mdq

2.启动Meilisearch

docker run -d -p 7700:7700 \
  -v ~/.meilisearch/data:/meili_data \
  getmeili/meilisearch:latest

3.索引和搜索

mdq index --path ~/docs
mdq search "query"

命令

mdq status              Check if Meilisearch is running
mdq search <query>      Search indexed content
mdq index               Build/rebuild index
mdq embed               Generate embeddings for semantic search
mdq source              Manage registered sources for MCP server
mdq token               Generate API tokens for Bearer authentication
mdq oauth               Manage OAuth 2.1 authentication
mdq mcp [sources...]    Start MCP server

跑 mdq <command> --help 用于命令特定选项。

MCP服务器

# Register sources (one-time setup)
mdq source add -s ~/docs -d "Documentation"
mdq source add -s ~/wiki -d "Team wiki"
mdq source list

# Start MCP server (uses registered sources)
mdq mcp

# Or specify sources directly (overrides registered)
mdq mcp -s ~/docs -d "Documentation"

# HTTP mode with Bearer token (simple)
mdq token generate  # Generate and save the token
export MDQ_MCP_API_KEY="<your-token>"
mdq mcp --http

# Or use OAuth 2.1 (recommended for production)
mdq oauth setup --client-id claude --name "Claude"
mdq mcp --http --oauth --cert ./cert.pem --key ./key.pem

# Add to Claude Code
claude mcp add kb -- mdq mcp

文档

看 docs/ 有关综合文档：

另见

  • 量子分子动力学 -类似的工具具有相反的权衡：qmd在查询时执行LLM工作（重新排序、查询扩展），而mdq在索引时执行LLM工作（嵌入）以实现快速查询。

相关 MCP