My Docs MCP Server

🚀 我的文檔MCP服務器

此MCP服務器可對指定目錄下的所有Markdown（.md）文件進行全文索引，並藉助MCP協議提供搜索與訪問功能，為用戶提供便捷的Markdown文件搜索和獲取服務。

🚀 快速開始

此MCP服務器會索引指定目錄下所有Markdown（.md）文件的全文，並通過MCP協議提供搜索和訪問功能。

✨ 主要特性

• 作為MCP的tools提供全文搜索（search_docs）。
• 作為MCP的resources提供文件全文獲取（read_doc）。
• 使用TypeScript開發。

📦 安裝指南

安裝依賴包

npm install

創建docs目錄並放置Markdown文件

mkdir docs
# 示例：創建測試文件
echo "# 測試\n這是測試內容。" > docs/測試.md

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測試服務器的工具和服務資源。

npm run inspect -- [docs目錄路徑]
# 示例：npm run inspect -- ./docs

或使用已構建文件：

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

在Claude Desktop中的使用示例

配置Claude Desktop

打開Claude Desktop的配置文件（例如：~/Library/Application Support/Claude/claude_desktop_config.json），添加以下服務器配置：

{
  "mcpServers": {
    "文檔搜索": {
      "command": "node",
      "args": [
        "/path/to/docs-search/build/index.js",
        "/path/to/your-project/docs"
      ]
    }
  }
}

• command設為node，args中填入已構建服務器文件的路徑和docs目錄路徑。
• 建議使用絕對路徑

查看效果

重啟Claude Desktop後，在MCP工具列表中會顯示search_docs。

📚 詳細文檔

提供的工具與資源

工具：search_docs

• 概要：搜索Markdown文件全文（支持通過wakachigaki分詞實現的日語搜索）。
• 輸入參數：支持模糊搜索和精確匹配。
• 輸出格式：JSON數組，包含搜索結果和高亮部分。

資源：read_doc

• 說明：通過MCP資源URI獲取文件內容。
• 支持的 MIME 類型：text/markdown

日誌記錄

服務器在主要處理步驟中會輸出詳細日誌到標準錯誤輸出（stderr）。

🔧 技術細節

技術棧與實現技術

📄 許可證

MIT