Prototype · Preview: every server in the official registry, synced every 30 minutes. Sign in with Google to write reviews.Prototype · updated every 30 min
PopNx MCPMCP servers for people who use AI · explained in plain words Sign in

ocr-software.com OCR

✓ Brand-named GitHub · github.com/ocr-software

by ocr-softwareversion 0.3.1i★ 0iRuns on your computerOfficial site ↗
Registry nameio.github.ocr-software/ocr-software-mcp

How to install

What it does

Read PDFs and images with ocr-software.com: page count, job, text, Markdown, JSON, hOCR.

  • Connects Runs on your computer
  • Account or key Needs OCR_KEY
  • Category Design, images & audio

Use together with

Skills that teach the AI this kind of work; they work alongside this one

impeccable

The design vocabulary for your coding agent. Steer with polish and bolder, review with critique and audit, catch AI slop before it ships.

by pbakaus★ 113,5361 skills

Skill · How-to guide

diagram-design

Editorial diagram design for Claude Code, Codex, GitHub Copilot, Cursor, Factory Droid, Qoder, and Pi. 45 diagram types. Self-contained HTML + SVG. No shadows. No Mermaid slop.

by cathrynlavery★ 68,7131 skills

Skill · How-to guide

frontend-slides

Create beautiful slides on the web using a coding agent's frontend skills

by zarazhangrui★ 32,6391 skills

Skill · How-to guide

Why it ranks here

Lists are ordered by a usage score (out of 100) built from these parts

Popularity0/80GitHub stars or weekly downloads: the larger counts 60, the smaller 20
Freshness12/12Full marks for a release or code change within 30 days
Still answering0/8The cloud endpoint answered at the last check
Usage score12/100

Quality: Passed 3/3 basic checks (shown, not used for ordering) · Momentum: No data yet (Used only on the Trending tab)

Install

Pick the AI app you use, then copy the settings.

Let your AI install it with one sentence

Please install ocr-software.com OCR. Follow https://mcp.popnx.com/i/ocr-software-mcp.md, show me the commands and wait for my OK before running them.

Paste it into an AI that can work on your computer (such as Claude Code or Cursor). It reads our steps, shows you the commands and waits for your OK. No key, no sign-up. · See the full text your AI reads

Passed 3/3 checks · Runs on your computer · ✓ Commands checked Nov 14, 2026

First: which AI do you use?

Pick your app and the steps appear below.

Works with Claude, with some setup first

You need a ocr-software.com OCR key (create it on the maker’s site) · Install Python (uv) on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone

Let AI install it

Copy this message into a Claude chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server ocr-software.com OCR for Claude on this computer, in this order: 1) Check uv with uv --version. If it is missing, tell me to install it from https://docs.astral.sh/uv/getting-started/installation/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "ocr-software": { "command": "uvx", "args": [ "ocr-software-mcp" ], "env": { "OCR_KEY": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For OCR_KEY, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the ocr-software.com OCR tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install uv (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    uv --version
    • A version number such as uv … = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: uv has no click-through installer. Copy the one-line command for your system (macOS or Windows) from uv’s official page into Terminal · no separate Python install needed; uv downloads it when required

    Open the uv download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: uv --version

    Install once; it works for everything that needs uv

  2. Sign up and create a ocr-software.com OCR key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the ocr-software.com OCR site ↗

  3. Open the Claude desktop app’s settings file

    SettingsDeveloperEdit Config

  4. Paste these settings and save the file

    {
      "mcpServers": {
        "ocr-software": {
          "command": "uvx",
          "args": [
            "ocr-software-mcp"
          ],
          "env": {
            "OCR_KEY": "your-value"
          }
        }
      }
    }

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Quit Claude and open it again

  6. Try it

    Use ocr-software.com OCR and tell me what you can do for me, then show me one thing

    ✓ If Claude says it is using ocr-software.com OCR or shows a ocr-software.com OCR tool in the answer, you are connected

3 optional setting(s) (works without them)

The command above works without these. Add them only if you want to change something, following the maker’s description.

  • OCR_BASE_URL Address of the service; for your own server e.g. http://127.0.0.1:8080. · default https://api.ocr-software.com
  • OCR_OUT_DIR Folder where results are written. Default: ocr-results next to the document, else ~/Documents/ocr-results.
  • OCR_ALLOWED_DIR Optional: read documents only from below this folder.

Descriptions are as written by the maker.

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

ChatGPT cannot connect ocr-software.com OCR yet

ocr-software.com OCR runs on your computer, but ChatGPT can only connect servers that run on the web

What you can do instead

A · Use an app that can connect ocr-software.com OCR

  • You need a ocr-software.com OCR key (create it on the maker’s site) · Install Python (uv) on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone
  • You need a ocr-software.com OCR key (create it on the maker’s site) · Install Python (uv) on your computer first (one time)
  • You need a ocr-software.com OCR key (create it on the maker’s site) · Install Python (uv) on your computer first (one time)
  • You need a ocr-software.com OCR key (create it on the maker’s site) · Install Python (uv) on your computer first (one time)

B · Others in Design, images & audio that work with ChatGPT

Picked from the most used in the same category, only ones that connect by address with no key

Works with Claude Code, with some setup first

You need a ocr-software.com OCR key (create it on the maker’s site) · Install Python (uv) on your computer first (one time)

Let AI install it

Copy this message into a Claude Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server ocr-software.com OCR for Claude Code on this computer, in this order: 1) Check uv with uv --version. If it is missing, tell me to install it from https://docs.astral.sh/uv/getting-started/installation/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): claude mcp add --scope user ocr-software --env OCR_KEY=your-value -- uvx ocr-software-mcp 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For OCR_KEY, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the ocr-software.com OCR tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install uv (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    uv --version
    • A version number such as uv … = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: uv has no click-through installer. Copy the one-line command for your system (macOS or Windows) from uv’s official page into Terminal · no separate Python install needed; uv downloads it when required

    Open the uv download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: uv --version

    Install once; it works for everything that needs uv

  2. Sign up and create a ocr-software.com OCR key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the ocr-software.com OCR site ↗

  3. Open Terminal

    Mac: press Command+Space and type Terminal · Windows: open PowerShell

  4. Paste this command and press Enter

    claude mcp add --scope user ocr-software --env OCR_KEY=your-value -- uvx ocr-software-mcp

    Replace “your-value” with your key before pressing Enter

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Type /mcp in Claude Code

    You should see ocr-software.com OCR listed as connected

  6. Try it

    Use ocr-software.com OCR and tell me what you can do for me, then show me one thing

    ✓ If Claude Code says it is using ocr-software.com OCR or shows a ocr-software.com OCR tool in the answer, you are connected

3 optional setting(s) (works without them)

The command above works without these. Add them only if you want to change something, following the maker’s description.

  • OCR_BASE_URL Address of the service; for your own server e.g. http://127.0.0.1:8080. · default https://api.ocr-software.com
  • OCR_OUT_DIR Folder where results are written. Default: ocr-results next to the document, else ~/Documents/ocr-results.
  • OCR_ALLOWED_DIR Optional: read documents only from below this folder.

Descriptions are as written by the maker.

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with Cursor, with some setup first

You need a ocr-software.com OCR key (create it on the maker’s site) · Install Python (uv) on your computer first (one time)

Let AI install it

Copy this message into a Cursor chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server ocr-software.com OCR for Cursor on this computer, in this order: 1) Check uv with uv --version. If it is missing, tell me to install it from https://docs.astral.sh/uv/getting-started/installation/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "ocr-software": { "command": "uvx", "args": [ "ocr-software-mcp" ], "env": { "OCR_KEY": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For OCR_KEY, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the ocr-software.com OCR tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install uv (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    uv --version
    • A version number such as uv … = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: uv has no click-through installer. Copy the one-line command for your system (macOS or Windows) from uv’s official page into Terminal · no separate Python install needed; uv downloads it when required

    Open the uv download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: uv --version

    Install once; it works for everything that needs uv

  2. Sign up and create a ocr-software.com OCR key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the ocr-software.com OCR site ↗

  3. Click this button to open Cursor

    Open in Cursor

    Cursor asks you to confirm; click Install

  4. Fill in your key

    In the ocr-software.com OCR settings, OCR_KEY is empty; add your key and save

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Open the AI chat in Cursor in Agent mode

  6. Try it

    Use ocr-software.com OCR and tell me what you can do for me, then show me one thing

    ✓ If Cursor says it is using ocr-software.com OCR or shows a ocr-software.com OCR tool in the answer, you are connected

3 optional setting(s) (works without them)

The command above works without these. Add them only if you want to change something, following the maker’s description.

  • OCR_BASE_URL Address of the service; for your own server e.g. http://127.0.0.1:8080. · default https://api.ocr-software.com
  • OCR_OUT_DIR Folder where results are written. Default: ocr-results next to the document, else ~/Documents/ocr-results.
  • OCR_ALLOWED_DIR Optional: read documents only from below this folder.

Descriptions are as written by the maker.

Menu names checked against Cursor’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with VS Code, with some setup first

You need a ocr-software.com OCR key (create it on the maker’s site) · Install Python (uv) on your computer first (one time)

Let AI install it

Copy this message into a VS Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server ocr-software.com OCR for VS Code on this computer, in this order: 1) Check uv with uv --version. If it is missing, tell me to install it from https://docs.astral.sh/uv/getting-started/installation/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "servers": { "ocr-software": { "type": "stdio", "command": "uvx", "args": [ "ocr-software-mcp" ], "env": { "OCR_KEY": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For OCR_KEY, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the ocr-software.com OCR tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install uv (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    uv --version
    • A version number such as uv … = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: uv has no click-through installer. Copy the one-line command for your system (macOS or Windows) from uv’s official page into Terminal · no separate Python install needed; uv downloads it when required

    Open the uv download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: uv --version

    Install once; it works for everything that needs uv

  2. Sign up and create a ocr-software.com OCR key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the ocr-software.com OCR site ↗

  3. Click this button to open VS Code

    Open in VS Code

    VS Code asks you to confirm; click Install

  4. Fill in your key

    In the ocr-software.com OCR settings, OCR_KEY is empty; add your key and save

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Open the AI chat in VS Code in Agent mode

  6. Try it

    Use ocr-software.com OCR and tell me what you can do for me, then show me one thing

    ✓ If VS Code says it is using ocr-software.com OCR or shows a ocr-software.com OCR tool in the answer, you are connected

3 optional setting(s) (works without them)

The command above works without these. Add them only if you want to change something, following the maker’s description.

  • OCR_BASE_URL Address of the service; for your own server e.g. http://127.0.0.1:8080. · default https://api.ocr-software.com
  • OCR_OUT_DIR Folder where results are written. Default: ocr-results next to the document, else ~/Documents/ocr-results.
  • OCR_ALLOWED_DIR Optional: read documents only from below this folder.

Descriptions are as written by the maker.

Menu names checked against VS Code’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Other apps that use MCP, such as Windsurf, Zed or Gemini CLI, each add servers differently. See how in the app list.

See every app that uses MCP →

JSON settings are under “For developers” below

Stuck? Ask people who use ocr-software.com OCR💬 Discussion →
For developers: Terminal commands and JSON settings

Installed on your computer

Claude Code

claude mcp add --scope user ocr-software --env OCR_KEY=your-value -- uvx ocr-software-mcp

Claude Desktop (claude_desktop_config.json)

{
  "mcpServers": {
    "ocr-software": {
      "command": "uvx",
      "args": [
        "ocr-software-mcp"
      ],
      "env": {
        "OCR_KEY": "your-value"
      }
    }
  }
}

Cursor (~/.cursor/mcp.json)

{
  "mcpServers": {
    "ocr-software": {
      "command": "uvx",
      "args": [
        "ocr-software-mcp"
      ],
      "env": {
        "OCR_KEY": "your-value"
      }
    }
  }
}

VS Code (mcp.json)

{
  "servers": {
    "ocr-software": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "ocr-software-mcp"
      ],
      "env": {
        "OCR_KEY": "your-value"
      }
    }
  }
}

Values you fill in

  • OCR_KEY secret required env
    API key, starts with ocr_. Never shown to the model.
  • OCR_BASE_URL env
    Address of the service; for your own server e.g. http://127.0.0.1:8080.
  • OCR_OUT_DIR env
    Folder where results are written. Default: ocr-results next to the document, else ~/Documents/ocr-results.
  • OCR_ALLOWED_DIR env
    Optional: read documents only from below this folder.

Descriptions are as written by the maker.

These settings are generated from the maker’s registry entry. If the README says otherwise, follow the README.

At a glance

Downloads per weeki
Not on npm/PyPI
Connection
Runs on your computer
Latest versioni
0.3.1
Published to registryi
Nov 14, 2026
Code last changedi
Nov 14, 2026
Maker
ocr-software
Packages
pypi: ocr-software-mcp
Registry status
Active

Which apps can use it

Based on how this server connects and on each app’s own docs, checked Nov 10, 2026.

Run on your computer in

ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast

All apps, with pros and cons →

Related guides

What it can do

Runs on your computer; the tool list appears in your AI app after you install it.

Basic checksi

We check information anyone can see; we have not read the code. Checks that do not apply are left out of the count. · Checked Nov 20, 2026

  • ✓ Pass

    Maker matches the repo

    The registry name was verified with the GitHub account ocr-software, which owns the repo

  • ✓ Pass

    Still maintained

    Code last changed 6 days ago

  • ✓ Pass

    Has a licence

    Uses MIT

  • – Not applicable

    Endpoint responds

    This one runs on your computer; there is no internet endpoint

  • – Not applicable

    Sign-in with OAuth

    Runs on your computer and uses local settings instead

  • … Not checked yet

    No hidden instructions in tool descriptions

    Runs on your computer; we can only read tool lists from internet endpoints

Published vulnerabilities (OSV.dev)

No entries on OSV.dev for ocr-software-mcp@0.3.1

Checks only this package version, not every dependency · checked Nov 16, 2026

What we check → · JSON

Makers: ask for a re-check or report wrong info
For makers: add a badge to your README

If you made this, paste this code into your README. The badge links back to this page.

[![Featured on PopNx MCP](https://mcp.popnx.com/badge/ocr-software-mcp.svg)](https://mcp.popnx.com/en/servers/ocr-software-mcp)

Discussion

Ask, share a tip or report that it does not work. Sorted by what people marked helpful.

No posts yet. Be the first to ask or share.

Posts here are written by users, not the PopNx team.

Sign in to post

User reviews

No reviews yet

Sign in to write a review

Compared with others in Design, images & audioi

  • More stars than 0% of the other 3358 servers in this category
  • Published to the registry more recently than 84% of the other 3358 servers in this category
  • Basic checks equal to or better than 99% of the other 3358 servers in this category

Compared with every active server in this category in the registry. Stars count only when the publisher owns the repo.

Common questions

Is ocr-software.com OCR safe?

It passed 3 of 3 applicable basic checks. We have not read the code. Before adding a key or token, see what access the server asks for and use a key with only the permissions you need.

What keys or codes does it need?

You need to fill in: OCR_KEY

Does it run on my computer or in the cloud?

It runs on your computer. Your AI app starts it when needed, and data does not pass through the maker’s servers (unless it calls an online service itself).

Is it still maintained?

The GitHub repo last changed 6 days ago, and the latest version (0.3.1) reached the registry 6 days ago.

Which apps can use it?

Apps that support MCP, such as Claude Desktop, Claude Code, Cursor and VS Code. You also need Python (uv) on your computer.

What can I use instead?

In the same category: HyperFrames by HeyGen, Pascal 3D Editor, draw.io, Figma MCP Server, Remocn: Remotion MCP server

Similar alternatives

Same category, other makers, commands already checked. Official ones first, then by stars.

Reading a card:↓ Downloads per weeki★ GitHub starsiThree pillars: reviews · checks · usageiUpdated = latest version published to the registryi

HyperFrames by HeyGen

Official HyperFrames by HeyGen: the best AI video editor in chat. Captions, motion graphics, MP4.

by heygen-comWidely used★ 87.2K Stars for the whole repoUpdated 2 days ago

Runs in the cloud✓ heygen.com

Pascal 3D Editor

Create, inspect, validate, and save editable 3D building scenes with Pascal's MCP server.

by pascalorgWidely used↓ 1K/wk★ 25.7K Stars for the whole repoUpdated 2 days ago

Computer or cloud✓ service owner · pascal.app

draw.io

Create draw.io diagrams in chat from Mermaid or XML, shown live and interactive. 10,000+ shapes.

by jgraphWidely used★ 5.9KUpdated 3 days ago

Runs in the cloud✓ service owner · draw.ioTried by the PopNx team

Figma MCP Server

Figma’s official server gives AI your design data so it can turn designs into code or describe them accurately. Connects to Figma’s cloud.

by figmaWidely used★ 2.2KUpdated 13 months ago

Runs in the cloud✓ service owner · mcp.figma.com
Compared with similar ones
This one
ocr-software.com OCR
HyperFrames by HeyGenPascal 3D Editordraw.ioFigma MCP ServerRemocn: Remotion MCP server
Runs whereInstalls on your computerRuns in the cloud, nothing to installCloud or install on your computerRuns in the cloud, nothing to installRuns in the cloud, nothing to installRuns in the cloud, nothing to install
Needs a keyYesNoNoNoNoNo
Add with + in ClaudeNoYesNoNoYesNo
Basic checks3/34/45/54/44/44/4
LicenseMITApache-2.0MITApache-2.0–MIT
PriceNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registry

README from the maker

Open the README

Copied from the maker’s repo as written. PopNx MCP has not reviewed or endorsed it. HTML, images and scripts are removed. Links lead off this site.

OCR MCP server for ocr-software.com: let Claude, Cursor and other agents read PDFs and scans

Give your AI agent a way to read documents: this MCP server sends PDF, PNG, JPEG and TIFF files to the ocr-software.com OCR API and writes the result (JSON with word boxes, text, Markdown or hOCR) to a file. The API is hosted in Helsinki, EU (Hetzner). It also works against the package on your own server, which takes the same calls: set OCR_BASE_URL to its address (install guide).

The server is small by design. It enforces the price side: no job without a quote, and the quoted price is the cap. The rest is a request to the agent: it is asked to let a person pick the pipeline, show the page count and price, and wait for a real yes. More on the idea and on what to expect: OCR for AI agents (MCP).

Tools

Six tools. The API itself is described in the API guide, the rules for agents in the agent guide. The normal path is three calls: list_pipelines, quote, submit_job with wait_seconds and format.

ToolWhat it does
list_pipelinesShort list: per pipeline one summary line (what it delivers, price per page in euros, when to choose another one), formats and features, and default_pipeline (the fastest and cheapest available one, used by quote when no pipeline is named), from GET /v1/catalog (no key needed); detail=true gives the full catalog. The agent is asked to show the list to the human and never to pick a pipeline itself.
quoteDry run of POST /v1/jobs. pipeline is optional: without it the default is used and say_to_human says so. Returns a quote_id and say_to_human, a plain sentence with the page count and the amounts in euros. While billing is off it says that you pay EUR 0.00 today, shows the list price for information only and names the fair-use page and the contact. Nothing runs, nothing is billed. The quote is bound to the file (hash), the pipeline, the dpi and the price, lives one hour in the memory of the server and is used up by one job.
submit_jobStarts the job from the quote_id; the budget comes from the quote, so the agent never handles it. The agent is asked to set human_confirmed=true only after the human saw say_to_human and answered yes; the server cannot tell a real answer from a set flag. If the client supports elicitation and the flag is left out, the client asks the human itself. wait_seconds (up to 300) waits for the end with progress messages, format then writes the result in the same call. Sends an Idempotency-Key, so a retry never creates a second job or a second charge.
job_statusWaits up to wait_seconds (default 45) until the job is done, with progress messages, in one call. done does not mean every page worked: it says problem if pages failed or did not run. The queue block shows only while the job waits.
get_resultFetches json, text, md, hocr or pdf (searchable PDF, needs the original document), writes it to a file and returns the path, the size and a quick check: words, mean confidence, uncertain words and a note for pages that look multi-column (from 12 words on; no pipeline of ours reads columns in order yet) or failed. With pages ("2-4") or search it returns text or matching lines instead of a file; then format, out_dir and source_path are refused, an empty pages or search is an error, and a page the job does not have is an error naming its page count. pdf needs the original: after a restart of the server pass source_path. Results expire after about 24 hours.
uncertain_wordsThe words the OCR is least sure about: page, word, confidence, the other reading where the pipeline has two (differs), the box in pixels and the page size. The agent should check these against the image. limit is 1 to 100, max_confidence 0 to 1; page_size lists width and height per page.
cancel_jobStops a running job or deletes the result of a finished one (DELETE /v1/jobs/{id}). The agent is asked to set human_confirmed=true only after the human agreed; if the client can ask the human itself it asks when the flag is left out. Pages already read stay charged.

verified (per word) and safe_ok (per page) in the JSON result are flags of the OCR service, not of this server. verified is true when a second reader confirmed the word: scan-vlm-ctc@2 sets it where the character reader read the same text (flag ok); the other pipelines have one reader and leave it false. safe_ok is always false today (not calibrated), which says nothing against the page. Judge a word by confidence (0 to 1) and flag. box is [x0, y0, x1, y1] in pixels of the page image, origin top left; the page's width, height and dpi say which image, and PDF points are pixels * 72 / dpi. uncertain_words lists words with confidence below 0.9 (the really wrong words of the gold set sat at about 0.83) or a differing second reading.

Price: the API counts in millicents (100,000 millicents = 1 EUR); this server speaks euros. Today nothing is charged: quote says "you pay EUR 0.00 today", shows the list price for information and names the fair-use rules (https://ocr-software.com/legal/fair-usage/) and info@ocr-software.com for more volume.

The job budget is internal: quote gives the price in the plain sentence, the server sends the quoted price as the cap, and the job stops before a page that would exceed it. If the operator set no prices, no cap is sent.

Retries follow the agent guide: 429, 500, 502, 503, 504 and network errors up to 5 times with growing waits. A Retry-After over 60 seconds goes back to the human at once. Other 4xx errors are never retried.

Settings

Environment variables only.

VariableMeaning
OCR_KEY (or OCR_SOFTWARE_API_KEY)API key (starts with ocr_). Required except for list_pipelines. It belongs only in the env field of this server in the config of your client, not in the shell of the agent. Never print it, never paste it into the chat. Get one at ocr-software.com/order.
OCR_BASE_URLDefault https://api.ocr-software.com. For a self-hosted service, for example http://127.0.0.1:8080.
OCR_OUT_DIRWhere get_result writes; if set, the agent cannot choose another folder. Default: the folder ocr-results next to the document, for a job this server did not start (a new session or a restart: the server keeps jobs, quotes and document paths in memory only) ~/Documents/ocr-results, or ~/ocr-results if there is no Documents folder (for example with an OneDrive redirect); the answer always gives the full path and, in that case, a note saying why. Never the folder of the app. A relative value is relative to that place. Without it the agent may pass out_dir (inside OCR_ALLOWED_DIR if set). An existing file is never overwritten (j1-1.json instead).
OCR_ALLOWED_DIROptional. quote and submit_job then read only files below this folder; symlinks and .. do not escape. Outside it the answer is always "outside the allowed folder", whether the path exists or not. Give absolute paths.

What the server enforces, and what the agent is asked to do

The server enforces:

  • No job without a quote_id; a file that changed since the quote is refused.
  • The quoted price is sent as the job budget (job_budget): the job stops before a page that would exceed it. (A quote without a price, for example while billing is off, sends no budget.)
  • Every document is checked locally before it is sent: PDF, PNG, JPEG or TIFF by its first bytes, a regular file, at most 100 MiB.
  • Results go to files, not into the conversation, so large documents do not fill the context.
  • The key is read from the environment and never appears in a tool result.

The agent is asked to (the server cannot check it):

  • ask the human before a job and show say_to_human word for word,
  • not choose a pipeline itself; without a choice quote takes the default pipeline and says so in say_to_human,
  • set human_confirmed=true only after a real answer of the human. Asking every time through the client (elicitation) is planned, not built.

Install

Python 3.10 or newer. The package ocr-software-mcp runs the server (it needs the ocr-software package, installed with it).

uvx ocr-software-mcp            # run without installing (uv)

pipx install ocr-software-mcp # or install once; the command is then ocr-software-mcp pip install ocr-software-mcp # inside a venv

Claude Desktop

Add this to claude_desktop_config.json, then restart. The file is in ~/Library/Application Support/Claude/ on macOS and in %APPDATA%\Claude\ on Windows:

{"mcpServers": {"ocr-software": {"command": "uvx", "args": ["ocr-software-mcp"],

"env": {"OCR_KEY": "ocr_..."}}}}

With pipx use "command": "ocr-software-mcp" and no args.

On Windows, uv must be on the PATH that Claude Desktop sees (install it with winget install astral-sh.uv, then restart Claude Desktop); otherwise use pipx and "command": "ocr-software-mcp".

Claude Code
claude mcp add ocr-software --env OCR_KEY=ocr_... -- uvx ocr-software-mcp
Cursor

Use the same JSON as for Claude Desktop in .cursor/mcp.json (project) or ~/.cursor/mcp.json (all projects).

Your own server
"env": {"OCR_KEY": "ocr_...", "OCR_BASE_URL": "http://127.0.0.1:8080"}

The names OCR_SOFTWARE_API_KEY, OCR_SOFTWARE_BASE_URL and OCR_SOFTWARE_ALLOWED_DIR of the ocr-software package and its CLI are read too; the OCR_SOFTWARE_ names win if both are set (the same order in the Python client and the command line).

Tests

A fake local service, no network and no key needed. In a fresh clone, install the package with its test extra (this brings mcp and ocr-software), then run pytest:

python -m venv .venv

.venv/bin/pip install -e ".[test]" # Windows: .venv\Scripts\pip install -e ".[test]" .venv/bin/python -m pytest -p no:cacheprovider . # Windows: .venv\Scripts\python -m pytest -p no:cacheprovider .

License

MIT, see LICENSE. More about the service, its pipelines and output formats: ocr-software.com.

Provider and legal

The OCR runs on the ocr-software.com API, operated by Helm & Nagel GmbH. Terms · Privacy · Imprint · Security

mcp-name: io.github.ocr-software/ocr-software-mcp