使用说明
项目简介
Unstructured文档处理器MCP服务器是一个基于Model Context Protocol (MCP) 的后端应用,旨在为大型语言模型(LLM)提供从非结构化文档中提取内容的能力。该服务器通过集成 Unstructured API,允许 LLM 客户端调用工具来处理各种文档格式,并将文档内容转换为结构化文本,从而增强 LLM 对非结构化数据的理解和应用。
主要功能点
- 文档处理工具: 提供 'process_document' 工具,支持上传多种文档格式(如PDF, Word, Excel, 文本文件等),并利用 Unstructured API 提取文档内容。
- 格式转换: 将文档内容解析为JSON格式的元素,并进一步转换为包含HTML标签的文本,方便LLM理解和使用。
- 支持多种文件类型: 支持非常广泛的非结构化文档格式,包括文本、Office文档、PDF、图片、邮件、网页等常见类型 (具体支持类型见仓库 README)。
- 易于集成 Claude Desktop: 提供详细的 Claude Desktop 集成配置说明,方便用户快速将此 MCP 服务器添加到 Claude Desktop 环境中使用。
- 基于标准 MCP 框架: 使用 'fastmcp' 框架构建,保证了与 MCP 协议的兼容性,并易于扩展和维护。
安装步骤
-
克隆仓库:
git clone https://github.com/MKhalusova/unstructured-mcp cd unstructured-mcp -
创建虚拟环境 (可选但推荐):
python -m venv venv source venv/bin/activate # 或根据你的系统使用 venv\Scripts\activate -
安装依赖:
uv pip install -r requirements.txt # 推荐使用 uv,如果使用 pip,请替换 uv pip install 为 pip install或者直接使用 'pip install unstructured-client python-dotenv mcp'
-
配置环境变量:
- 在项目根目录下创建 '.env' 文件。
- 在 '.env' 文件中添加 Unstructured API Key:
注意: 你需要在 Unstructured.io 官网注册并获取 API Key。UNSTRUCTURED_API_KEY=YOUR_UNSTRUCTURED_API_KEY # 将 YOUR_UNSTRUCTURED_API_KEY 替换为你的 API Key
-
运行 MCP 服务器:
uv run doc_processor.py # 推荐使用 uv 运行,如果使用 pip,请替换 uv run 为 python或者 'python doc_processor.py'
服务器配置
要将此 MCP 服务器添加到 MCP 客户端(例如 Claude Desktop),你需要提供服务器的启动配置信息。以下是 Claude Desktop 'claude_desktop_config.json' 文件的配置示例:
{ "mcpServers": { "unstructured_doc_processor": { // 服务器名称,可以自定义 "command": "PATH/TO/YOUR/UV", // uv 命令的绝对路径,如果 uv 可执行文件在 PATH 环境变量中,则直接使用 "uv" "args": [ "--directory", // 参数,指定工作目录 "ABSOLUTE/PATH/TO/YOUR/unstructured-mcp/", // unstructured-mcp 仓库的绝对路径 "run", // 参数,运行命令 "doc_processor.py" // 参数,指定要运行的 Python 脚本 ], "disabled": false // 设置为 false 启用该服务器 } } }
配置说明:
- 'server name' (unstructured_doc_processor): 为你的 MCP 服务器指定一个唯一的名称,例如 'unstructured_doc_processor'。这个名称将用于在 MCP 客户端中标识和调用该服务器。
- 'command' (PATH/TO/YOUR/UV 或 uv): 指定启动 MCP 服务器的命令。
- 如果你安装了 'uv' 并希望使用 'uv' 运行,你需要提供 'uv' 可执行文件的绝对路径。你可以通过 'which uv' (Linux/macOS) 或 'where uv' (Windows) 命令查找 'uv' 的路径,并将其替换到 'PATH/TO/YOUR/UV' 的位置。
- 更简便的方式 是确保 'uv' (或者 'python',如果你使用 'python doc_processor.py' 启动服务器) 命令所在的目录已经添加到系统的 'PATH' 环境变量中。这样你就可以直接将 'command' 设置为 '"uv"' (或 '"python"')。
- 'args' (参数列表): 提供启动服务器脚本所需的参数。
- '--directory "ABSOLUTE/PATH/TO/YOUR/unstructured-mcp/"': 指定 MCP 服务器的工作目录为 'unstructured-mcp' 仓库的绝对路径。你需要将 'ABSOLUTE/PATH/TO/YOUR/unstructured-mcp/' 替换为你本地仓库的实际绝对路径。
- '"run"', '"doc_processor.py"': 指定使用 'uv run' 命令运行 'doc_processor.py' 脚本。
Claude Desktop 配置路径:
Claude Desktop 的配置文件 'claude_desktop_config.json' 通常位于以下路径:
- macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%\Claude' (通常展开为 'C:\Users\YourUserName\AppData\Roaming\Claude')
- Linux: '~/.config/Claude/' 或 '~/.var/app/com.anthropic.claude/config/Claude/' (取决于安装方式)
如果 'claude_desktop_config.json' 文件不存在,你需要手动创建它。
配置完成后,重启 Claude Desktop 以加载新的 MCP 服务器配置。
基本使用方法
- 启动 MCP 服务器: 按照安装步骤中的说明启动 'doc_processor.py'。
- 配置 MCP 客户端 (如 Claude Desktop): 根据上述服务器配置说明,将 'unstructured_doc_processor' 添加到你的 MCP 客户端配置中。
- 在 MCP 客户端中使用:
- 在 Claude Desktop 中,你应该能够看到名为 'unstructured_doc_processor' 的 MCP 服务器已连接。
- 当 LLM 需要处理文档时,你可以指示 LLM 调用 'unstructured_doc_processor' 服务器提供的 'process_document' 工具,并提供文档的文件路径作为参数。
- 服务器将处理文档,并将提取的文本内容返回给 LLM,以便 LLM 可以利用文档内容进行后续操作。
示例使用场景:
你可以告诉 Claude Desktop (或其他 MCP 客户端) 类似这样的指令:
'请帮我总结一下这个文档的内容,文档路径是 /path/to/your/document.pdf,请使用 unstructured_doc_processor 服务器处理文档。'
(具体的指令格式取决于你的 MCP 客户端,以上仅为示例)
注意事项
- 确保你已安装了所有必要的依赖,并正确配置了 Unstructured API Key。
- 首次运行可能需要一些时间下载和安装依赖。
- "This repo is work in progress, proceed with caution :)" 表明该项目仍在开发中,可能存在一些未完善之处,使用时请注意。
- 请根据你的实际环境调整配置文件中的路径和命令。
信息
分类
AI与计算