关于 Mcp Server Markdown
Mcp Server Markdown 为处理本地 Markdown 文档的编码 Agent 和文档使用者提供结构化检索。它能识别标题、章节、代码块和 YAML frontmatter,而不只是读取原始文本。
主要功能
- 01递归列出 Markdown 文件
- 02全文搜索文档
- 03按标题提取章节
- 04列出标题目录
- 05按语言查找代码块
- 06解析 YAML frontmatter
适用场景
- 01搜索项目文档中的主题
- 02提取指定标题下的章节
- 03汇总文档标题作为目录
- 04查找特定语言的代码示例
MCP 相关
它作为 MCP 服务,将本地 Markdown 文件的搜索、章节提取、标题浏览、代码块查找和 frontmatter 解析工具提供给 MCP 客户端。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
6收录的工具列表 · 更新于 3 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| directory | string | 是 | 要扫描的目录路径(例如 ./docs) |
详细介绍
mcp-server-markdown
搜索、浏览并提取本地 Markdown 文件中的内容。支持全文搜索、提取章节、浏览标题、发现代码块和解析 frontmatter。
npx mcp-server-markdown
适用于 Claude Desktop、Cursor、VS Code Copilot 和任何 MCP 客户端。读取本地
.md文件,无需身份验证。

演示由 remotion-readme-kit 制作
为什么要用
Context7 这类工具非常适合查找 npm 上的库文档,但无法帮助你处理自己的文档。项目 Wiki、内部知识库、架构决策记录、入职指南:这些内容都以 Markdown 文件的形式存放在代码仓库或磁盘上。文件系统 MCP 服务可以读取这些文件,但会将它们视为纯文本。它无法理解标题、章节或代码块。本服务则可以。将它指向一个目录,助手就能搜索所有文档、按标题提取特定章节、列出目录,或查找知识库中的所有 TypeScript 代码示例。
工具
| 工具 | 功能 |
|---|---|
list_files | 递归列出目录中的所有 .md 文件(按字母顺序排序) |
search_docs | 在所有 .md 文件中进行全文搜索(不区分大小写,最多返回 50 条结果) |
get_section | 按标题提取章节,直到遇到同级或更高级别的下一个标题 |
list_headings | 将所有标题列为目录 |
find_code_blocks | 查找围栏代码块,可按语言筛选(例如 typescript) |
get_frontmatter | 解析文件开头的 YAML frontmatter 元数据 |
快速开始
Cursor
添加到 .cursor/mcp.json:
{
"mcpServers": {
"markdown": {
"command": "npx",
"args": ["-y", "mcp-server-markdown"]
}
}
}
Claude Desktop
添加到 claude_desktop_config.json:
{
"mcpServers": {
"markdown": {
"command": "npx",
"args": ["-y", "mcp-server-markdown"]
}
}
}
VS Code
添加到用户设置或 .vscode/mcp.json:
{
"mcp": {
"servers": {
"markdown": {
"command": "npx",
"args": ["-y", "mcp-server-markdown"]
}
}
}
}
示例
- “搜索 ./docs 中所有提及‘authentication’的文档”
- “显示 README.md 中的‘API Reference’章节”
- “列出 CONTRIBUTING.md 中的所有标题”
- “查找文档中的所有 TypeScript 代码块”
- “这个文件中的 frontmatter 元数据是什么?”
- “提供我们架构文档的目录”
Agent Plugins
此仓库是一个 Agent Plugins 1.0.0 软件包:plugin.json、可移植的 mcp.json 和 skills/ 会与 MCP 服务一同提供。
对于 Cursor,请克隆仓库并将其复制或软链接到 ~/.cursor/plugins/local/mcp-server-markdown,然后重新加载窗口。技能和 MCP 会显示在 Customize > Plugins 下。
上方的 Cursor 和 VS Code 安装按钮仍然可用:它们会添加与手动配置 JSON 相同的 npx -y mcp-server-markdown stdio 服务。
常见问题
什么是 mcp-server-markdown?
一个用于搜索和浏览本地 .md 文件的 MCP 服务:支持全文搜索、按标题查找章节、目录、代码块和 YAML frontmatter。
它与 Context7 有什么不同?
Context7 从 npm 获取已发布的库文档。此服务会为磁盘上已有的 Markdown 建立索引(维基、ADR、内部指南)。
它与 filesystem MCP 有什么不同?
filesystem 工具读取原始文件。此服务能够理解标题、章节、围栏代码和 frontmatter。
我可以在 Cursor 中将其安装为 Agent Plugin 吗?
可以。使用 ~/.cursor/plugins/local/mcp-server-markdown,即可加载随附的 markdown-search 技能和 MCP 配置。
我需要 API 密钥吗?
不需要。路径均为本地路径;Agent 会将目录和文件路径传递给工具。
开发
git clone https://github.com/ofershap/mcp-server-markdown.git
cd mcp-server-markdown
npm install
npm test
npm run build
另请参阅
在我的作品集中查看更多 MCP 服务和开发者工具。
作者
README 由 README Builder 构建
许可证
MIT © 2026 Ofer Shapira
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。