mcp-mistral-ocr

🚀 MCP Mistral OCR

MCP Mistral OCR是一个MCP服务器，借助Mistral AI的OCR API实现光学字符识别功能。该服务器支持处理本地文件和URL链接文件，图像和PDF格式均可适用，为用户提供便捷的文字识别服务。

✨ 主要特性

• 运用Mistral的OCR技术处理本地文件（涵盖图像和PDF）。
• 能够处理指定明确文件类型的URL文件。
• 支持多种文件格式，如JPG、PNG、PDF等。
• 将识别结果保存为带时间戳的JSON文件。
• 采用Docker容器化部署。
• 使用UV包管理工具。

🔧 环境变量

| 属性 | 详情 | |------|------| | MISTRAL_API_KEY | 您的Mistral AI API密钥 | | OCR_DIR | 本地文件处理目录。在容器内，此路径始终映射到/data/ocr |

📦 安装指南

通过Smithery安装

若要借助Smithery为Claude Desktop自动安装Mistral OCR，可执行以下命令：

npx -y @smithery/cli install @everaldo/mcp/mistral-crosswalk --client claude

使用Docker

1. 构建Docker镜像：

docker build -t mcp-mistral-ocr .

2. 运行容器：

docker run -e MISTRAL_API_KEY=your_api_key -e OCR_DIR=/data/ocr -v /path/to/local/files:/data/ocr mcp-mistral-ocr

本地开发

1. 安装UV包管理工具：

pip install uv

2. 创建并激活虚拟环境：

uv venv
source .venv/bin/activate  # 在Unix系统上
# 或者在Windows系统上
.venv\Scripts\activate

3. 安装依赖项：

uv pip install .

📚 详细文档

Claude Desktop配置

需将以下配置添加到您的claude_desktop_config.json文件中：

{
  "mcpServers": {
    "mistral-ocr": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "MISTRAL_API_KEY",
        "-e",
        "OCR_DIR",
        "-v",
        "C:/path/to/your/files:/data/ocr",
        "mcp-mistral-ocr:latest"
      ],
      "env": {
        "MISTRAL_API_KEY": "<YOUR_MISTRAL_API_KEY>",
        "OCR_DIR": "C:/path/to/your/files"
      }
    }
  }
}

可用工具

💻 使用示例

基础用法

• process_local_file：用于处理OCR_DIR目录中的文件。

{
    "name": "process_local_file",
    "arguments": {
        "filename": "document.pdf"
    }
}

• process_url_file：从URL处理文件，需指定明确的文件类型。

{
    "name": "process_url_file", 
    "arguments": {
        "url": "https://example.com/document",
        "file_type": "image" // 或 "pdf"
    }
}

输出

OCR结果会保存在OCR_DIR目录下的output文件夹中。每个结果文件的命名规则如下：

• 本地文件：{original_filename}_{timestamp}.json
• URL文件：{url_filename}_{timestamp}.json 或 url_document_{timestamp}.json（若URL中未包含文件名）

时间戳格式为YYYYMMDD_HHMMSS。

支持的文件类型

• 图像：JPG、JPEG、PNG、GIF、WebP
• PDF

⚠️ 注意事项

请务必确保API密钥的安全性，避免在明文环境中暴露。