Markdownify MCP

🚀 Markdownify MCP 服務器

Markdownify 是一款模型上下文協議（MCP）服務器，可將多種文件類型以及網絡內容轉換為 Markdown 格式。它配備了一系列工具，能把 PDF、圖像、音頻文件、網頁等內容轉化為便於閱讀和分享的 Markdown 文本。

🚀 快速開始

1. 克隆此倉庫。
2. 安裝依賴項：

   pnpm install
   

   ⚠️ 重要提示

   這也將安裝 uv 及相關 Python 依賴項。

3. 構建項目：

   pnpm run build
   

4. 啟動服務器：

   pnpm start
   

✨ 主要特性

• 多文件類型轉換：可將 PDF、圖像、帶轉錄的音頻、DOCX、XLSX、PPTX 等文件轉換為 Markdown 格式。
• 網絡內容轉換：支持將 YouTube 視頻字幕、Bing 搜索結果、通用網頁等網絡內容轉換為 Markdown。
• 獲取現有 Markdown 文件：能夠獲取已有的 Markdown 文件。

📦 安裝指南

1. 克隆此倉庫。
2. 安裝依賴項：

   pnpm install
   

   注意：此操作會同時安裝 uv 及相關 Python 依賴項。
3. 構建項目：

   pnpm run build
   

4. 啟動服務器：

   pnpm start
   

💻 使用示例

基礎用法

若要將項目克隆到本地並啟動服務器，可按以下步驟操作：

# 克隆倉庫
git clone <倉庫地址>
# 進入項目目錄
cd <項目目錄>
# 安裝依賴
pnpm install
# 構建項目
pnpm run build
# 啟動服務器
pnpm start

高級用法

開發模式

使用 pnpm run dev 啟動 TypeScript 編譯器的監視模式，方便開發過程中即時編譯代碼：

pnpm run dev

自定義服務器行為

可修改 src/server.ts 文件來定製服務器的行為。

添加或修改工具

在 src/tools.ts 中添加或修改工具。

📚 詳細文檔

與桌面應用集成使用

要將此服務器與桌面應用集成，請在應用的服務器配置中添加以下內容：

{
  "mcpServers": {
    "markdownify": {
      "command": "node",
      "args": [
        "{ABSOLUTE PATH TO FILE HERE}/dist/index.js"
      ],
      "env": {
        // 默認情況下，服務器將使用 `uv` 的默認安裝位置
        "UV_PATH": "/path/to/uv"
      }
    }
  }
}

可用工具

• youtube-to-markdown：將 YouTube 視頻轉換為 Markdown。
• pdf-to-markdown：將 PDF 文件轉換為 Markdown。
• bing-search-to-markdown：將 Bing 搜索結果轉換為 Markdown。
• webpage-to-markdown：將網頁內容轉換為 Markdown。
• image-to-markdown：將圖像轉換為 Markdown 並附帶元數據。
• audio-to-markdown：將音頻文件轉換為 Markdown 並附帶轉錄文本。
• docx-to-markdown：將 DOCX 文件轉換為 Markdown。
• xlsx-to-markdown：將 XLSX 文件轉換為 Markdown。
• pptx-to-markdown：將 PPTX 文件轉換為 Markdown。
• get-markdown-file：獲取現有 Markdown 文件。

📄 許可證

此項目遵循 MIT 許可證 - 有關詳細信息，請參閱 LICENSE 文件。

貢獻

歡迎貢獻！請隨意提交 Pull Request。