关键词

文档处理PDF转换文档生成工具集成文档服务

使用说明

项目简介

Docling MCP 是一个基于 Model Context Protocol (MCP) 构建的文档处理服务器。它利用 Docling 库提供文档转换、处理和生成工具，旨在为大型语言模型 (LLM) 应用提供强大的文档上下文服务。通过 MCP 协议，LLM 客户端可以调用 Docling MCP 提供的工具，实现文档的智能处理和交互。

主要功能点

  • PDF 文档转换: 将 PDF 文档转换为结构化的 JSON (DoclingDocument) 格式，方便 LLM 理解和处理文档内容。
  • 文档生成: 支持创建、编辑和导出 DoclingDocument 文档，可以生成包括标题、段落、列表等多种文档元素，并导出为 Markdown 格式。
  • 本地文档缓存: 为了提高性能，服务器支持本地缓存已转换的文档，避免重复处理。
  • 灵活的文档来源: 支持从本地文件路径和 URL 获取文档。

安装步骤

  1. 环境准备: 确保已安装 Python 3.7 或更高版本。建议使用 'uv' 包管理器 (参考仓库 README)。
  2. 克隆仓库: 从 GitHub 克隆 'docling-mcp' 仓库到本地： 
    git clone https://github.com/docling-project/docling-mcp
cd docling-mcp
  3. 安装依赖: 根据仓库 'README.md'，使用 'uv sync' 命令安装项目依赖： 
    uv sync
    (如果 'uv' 未安装，请先安装 'uv'，或尝试使用 'pip install -r requirements.txt')
  4. 启动服务器: 运行以下命令启动 Docling MCP 服务器： 
    uv run python -m docling_mcp.server
    服务器默认使用 stdio 传输协议。

服务器配置

要将 Docling MCP 服务器与 MCP 客户端（例如 Claude Desktop）连接，您需要提供服务器的配置信息。以下是一个 JSON 格式的配置示例，您可以将其添加到 MCP 客户端的配置文件中：

{
  "serverName": "docling-mcp",
  "command": "uv",
  "args": ["run", "python", "-m", "docling_mcp.server"],
  "transport": "stdio"
}

配置参数说明:

  • 'serverName': 服务器的名称，可以自定义，用于在客户端中标识该服务器。例如: '"docling-mcp"'。
  • 'command': 启动服务器的可执行命令。这里使用 'uv'，假设 'uv' 可执行文件在您的系统 PATH 环境变量中。如果直接使用 Python 解释器，可以改为 '"python"'。
  • 'args': 传递给 'command' 的参数列表。这里指定运行 'docling_mcp.server' 模块来启动服务器。
  • 'transport': MCP 服务器使用的传输协议。根据 'docling_mcp/server.py' 中的 'mcp.run(transport="stdio")'，这里设置为 '"stdio"'。 注意: 如果需要使用 SSE 或 WebSocket 等其他传输协议，可能需要修改 'docling_mcp/server.py' 中的 'transport' 参数，并相应地更新客户端配置。 仓库 'README.md' 和 'clients/test_llama_stack.py' 示例中使用了 SSE 协议，并指向 'http://localhost:8000/sse' 端点，但默认服务器启动配置为 stdio。 请根据实际需求和服务器配置调整客户端的 'transport' 和相关参数。 如果使用 SSE 协议，客户端配置可能需要包含 'mcpEndpoint' 字段，例如 '"mcpEndpoint": "http://localhost:8000/sse"'。

基本使用方法

  1. 启动 Docling MCP 服务器 (按照上面的安装步骤)。

  2. 配置 MCP 客户端: 将上面提供的服务器配置 JSON 添加到您的 MCP 客户端配置中。确保客户端能够连接到 Docling MCP 服务器。

  3. 在 LLM Prompt 中调用工具: 在与 LLM 交互时，您可以使用自然语言指令来触发 Docling MCP 提供的工具。例如：

    • 转换 PDF 文档: 'Convert the PDF document at <文件路径或 URL> to DoclingDocument and return me its document-key.'
    • 生成文档: 按照仓库 'README.md' 提供的示例 Prompt，使用 'create_new_docling_document'、'add_title_to_docling_document' 等工具逐步构建文档内容。
    • 查看文档: 使用 'export_docling_document_to_markdown' 工具查看当前文档的 Markdown 格式内容。
    • 保存文档: 使用 'save_docling_document' 工具将文档保存到本地。

    具体的工具名称和使用方法可以参考仓库 'docling_mcp/tools/' 目录下的代码和 'README.md' 中的示例。

信息

分类

开发者工具

访问项目