内容
# MCP-PDF2MD
# MCP-PDF2MD 服务
一个基于MCP的高性能PDF到Markdown转换服务,使用Mistral AI OCR API,支持本地文件和URL链接的批量处理,并提供结构化输出。
## 主要特性
- **格式转换**:将PDF文件转换为结构化的Markdown格式。
- **多源支持**:处理本地PDF文件和远程PDF URL。
- **MCP集成**:与Claude Desktop等LLM客户端无缝集成。
- **结构保留**:旨在保持原始文档结构,包括标题、段落和列表。
- **图像提取**:自动从PDF中提取图像并保存到本地。
- **高质量提取**:利用Mistral AI的先进OCR技术进行高质量文本和布局信息提取。
## 系统要求
- Python 3.10+
- `uv`用于环境和包管理(推荐)
## 快速开始
1. 克隆代码库并进入目录:
```bash
git clone https://github.com/zicez/mcp-pdf2md.git
cd mcp-pdf2md
```
2. 使用uv安装依赖:
```bash
uv sync
```
3. 配置环境变量:
在项目根目录创建一个`.env`文件,并设置你的Mistral AI API密钥:
```
MISTRAL_API_KEY=your_mistral_api_key_here
```
4. 启动服务:
```bash
uv run pdf2md
```
## 命令行参数
服务器支持以下命令行参数:
- `--output-dir`:指定保存转换后的Markdown文件和图像的目录。默认为`./downloads`。
示例:
```bash
uv run pdf2md --output-dir /path/to/my/output
```
## Claude Desktop 配置
在Claude Desktop中添加以下配置:
**Windows**:
```json
{
"mcpServers": {
"pdf2md": {
"command": "uv",
"args": [
"--directory",
"C:\\path\\to\\mcp-pdf2md",
"run",
"pdf2md",
"--output-dir",
"C:\\path\\to\\output"
],
"env": {
"MISTRAL_API_KEY": "your_mistral_api_key_here"
}
}
}
}
```
**Linux/macOS**:
```json
{
"mcpServers": {
"pdf2md": {
"command": "uv",
"args": [
"--directory",
"/path/to/mcp-pdf2md",
"run",
"pdf2md",
"--output-dir",
"/path/to/output"
],
"env": {
"MISTRAL_API_KEY": "your_mistral_api_key_here"
}
}
}
}
```
**关于API密钥配置的说明:**
你可以通过两种方式设置API密钥:
1. 在项目目录中的`.env`文件中(推荐用于开发)。
2. 在Claude Desktop配置中,如上所示(推荐用于常规使用)。
如果你在两个地方都设置了API密钥,则Claude Desktop配置中的密钥将优先使用。
## MCP工具
服务器提供以下MCP工具:
- **`convert_pdf_url(url: str)`**:将来自URL的PDF转换为Markdown。支持单个URL或多个用空格、逗号或换行符分隔的URL。
- **`convert_pdf_file(file_path: str)`**:将本地PDF文件转换为Markdown。支持单个或多个用空格、逗号或换行符分隔的文件路径。
## 获取Mistral AI API密钥
该项目依赖Mistral AI API进行PDF内容提取。要获取API密钥:
1. 访问[Mistral AI平台](https://console.mistral.ai/)并创建一个账户。
2. 在你的工作区中导航到“API密钥”部分。
3. 创建一个新的密钥。
4. 复制生成的API密钥。
5. 将此密钥用作`MISTRAL_API_KEY`的值。
## 许可证
MIT许可证 - 详细信息请参见`LICENSE`文件。
## 致谢
该项目使用了[Mistral AI OCR API](https://docs.mistral.ai/api/#tag/ocr)。
连接信息
猜你喜欢
MarkItDown
将文件和办公文档转换为Markdown的Python工具。
Whisper 语音识别
OpenAI Whisper MCP Server - 基于本地 Whisper CLI 的离线语音识别与翻译,无需 API Key,支持...
claude-flow
Claude-Flow v2.7.0 是一个企业级AI编排平台。
oh-my-opencode
背景代理 · 精心挑选的代理,如 oracle、librarians、frontend engineer · 预构建工具,如 LSP/AST ·...
ai-engineering-from-scratch
学习它。构建它。交付给他人。最全面的开源AI工程课程:200多节课程,内容涵盖从线性代数到自主代理集群,支持Python、TypeScript、Rust和Julia。
hyperframes
编写HTML。渲染视频。为代理而建。