my-docs-mcp-server

my-docs-mcp-server

一个轻量级的 MCP 服务器,用于索引和搜索指定目录中的 Markdown 文件,通过模型上下文协议提供全文搜索和文件检索。

kbyk004

开发者工具
访问服务器

README

my-docs-mcp-server

概要

这个MCP服务器可以将指定目录下的Markdown(.md)文件全文索引化,并通过MCP协议进行搜索和查阅。

  • 提供MCP的tools作为全文搜索(search_docs)
  • 提供MCP的resources作为文件全文获取(read_doc)
  • 使用TypeScript编写

技术栈・实现技术

  • TypeScript: 服务器本体的实现语言。
  • @modelcontextprotocol/sdk: 用于MCP服务器的协议实现和通信。
  • MiniSearch: 用于Markdown文件的全文搜索索引创建和搜索。是一个轻量且快速的全文搜索库。
  • wakachigaki: 用于对日语文本进行分词(tokenize)的轻量库。作为MiniSearch的tokenizer使用,大幅提升日语搜索的精度。
  • fast-glob: 递归地搜索docs目录下的Markdown文件。
  • Node.js标准的fs/promises, path: 文件读取和路径操作。
  • Stdio服务器: 通过标准输入输出与MCP客户端(Claude Desktop或Inspector等)进行通信。

设置

  1. 安装依赖包
npm install
  1. 创建docs目录并放置Markdown文件
mkdir docs
# 例: 创建示例文件
echo "# 示例\n这是一个测试。" > docs/sample.md
  1. TypeScript构建
npm run build

服务器的启动方法

开发用(直接执行TypeScript)

npm run dev -- [docs目录的路径]
# 例: npm run dev -- ./docs

生产用(执行已构建的版本)

npm start -- [docs目录的路径]
# 例: npm start -- ./docs
  • docs目录的路径可以省略(省略时使用docs/

MCP Inspector中的运行确认

使用MCP Inspector可以通过GUI测试服务器的tools/resources。

npm run inspect -- [docs目录的路径]
# 例: npm run inspect -- ./docs

或者使用已构建的版本:

npx -y @modelcontextprotocol/inspector node build/index.js ./docs

Claude Desktop中的使用示例

  1. 打开Claude Desktop的配置文件(例: ~/Library/Application Support/Claude/claude_desktop_config.json),并添加如下服务器。
{
  "mcpServers": {
    "docs-search": {
      "command": "node",
      "args": [
        "/path/to/docs-search/build/index.js",
        "/path/to/your-project/docs"
      ]
    }
  }
}
  • commandnodeargs指定已构建服务器的路径和docs目录的路径。
  • 推荐使用绝对路径
  1. 重启Claude Desktop后,MCP工具列表中会显示search_docs

提供的工具・资源

Tool: search_docs

  • 概要: 全文搜索Markdown文件(日语使用分词tokenize进行高精度搜索)
  • 输入: query(搜索词, 必须)、limit(最大条数, 可选, 默认5)
  • 输出: 搜索结果(文件名、路径、片段)
  • 备注: 搜索查询和正文都使用wakachigaki进行分词,实现自然的日语搜索。

Resource: read_doc

  • 概要: 获取文件全文
  • 输入: filePath(通过MCP资源URI指定)
  • 输出: 文件全文

日志

服务器会在主要处理过程中向标准错误输出(stderr)输出详细日志。

许可证

MIT

推荐服务器

Playwright MCP Server

Playwright MCP Server

一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。

官方
精选
TypeScript
Magic Component Platform (MCP)

Magic Component Platform (MCP)

一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。

官方
精选
本地
TypeScript
MCP Package Docs Server

MCP Package Docs Server

促进大型语言模型高效访问和获取 Go、Python 和 NPM 包的结构化文档,通过多语言支持和性能优化来增强软件开发。

精选
本地
TypeScript
Claude Code MCP

Claude Code MCP

一个实现了 Claude Code 作为模型上下文协议(Model Context Protocol, MCP)服务器的方案,它可以通过标准化的 MCP 接口来使用 Claude 的软件工程能力(代码生成、编辑、审查和文件操作)。

精选
本地
JavaScript
@kazuph/mcp-taskmanager

@kazuph/mcp-taskmanager

用于任务管理的模型上下文协议服务器。它允许 Claude Desktop(或任何 MCP 客户端)在基于队列的系统中管理和执行任务。

精选
本地
JavaScript
mermaid-mcp-server

mermaid-mcp-server

一个模型上下文协议 (MCP) 服务器,用于将 Mermaid 图表转换为 PNG 图像。

精选
JavaScript
Jira-Context-MCP

Jira-Context-MCP

MCP 服务器向 AI 编码助手(如 Cursor)提供 Jira 工单信息。

精选
TypeScript
Linear MCP Server

Linear MCP Server

一个模型上下文协议(Model Context Protocol)服务器,它与 Linear 的问题跟踪系统集成,允许大型语言模型(LLM)通过自然语言交互来创建、更新、搜索和评论 Linear 问题。

精选
JavaScript
Sequential Thinking MCP Server

Sequential Thinking MCP Server

这个服务器通过将复杂问题分解为顺序步骤来促进结构化的问题解决,支持修订,并通过完整的 MCP 集成来实现多条解决方案路径。

精选
Python
Curri MCP Server

Curri MCP Server

通过管理文本笔记、提供笔记创建工具以及使用结构化提示生成摘要,从而实现与 Curri API 的交互。

官方
本地
JavaScript