my-docs-mcp-server

基本能力

产品定位

my-docs-mcp-server 是一个专门用于管理和检索Markdown文档的MCP服务器，适用于需要快速搜索和访问大量Markdown文件的场景。

核心功能

• 全文检索：支持对Markdown文件进行全文搜索，包括高精度的日语文本搜索。
• 文件内容获取：可以通过MCP协议获取指定文件的全文内容。
• 高性能索引：使用MiniSearch进行轻量级且高速的全文检索索引创建。
• 日语分词：利用wakachigaki库进行日语文本的分词处理，提高搜索精度。

适用场景

• 开发文档的快速检索
• 知识库的内容管理
• 多语言文档的搜索（特别是日语）

工具列表

• search_docs：提供Markdown文件的全文检索功能，支持查询参数和结果限制。
• read_doc：提供指定文件的全文内容获取功能。

常见问题解答

• 如何配置Claude Desktop使用此服务？ 在Claude Desktop的配置文件中添加服务器路径和参数，使用绝对路径推荐。
• 如何调试服务？ 使用MCP Inspector进行GUI测试或查看标准错误输出日志。

使用教程

使用依赖

npm install

安装教程

1. 创建docs目录并放置Markdown文件

mkdir docs
echo "# サンプル\nこれはテストです。" > docs/sample.md

1. 构建TypeScript

npm run build

调试方式

• 开发模式运行

npm run dev -- ./docs

• 生产模式运行

npm start -- ./docs

• 使用MCP Inspector测试

npm run inspect -- ./docs

许可证

该项目遵循 MIT 开源许可条款。