A Model Context Protocol (MCP) server for Upstage AI's document digitization and information extraction capabilities
The Upstage MCP Server provides a robust bridge between AI assistants and Upstage AI’s powerful document processing APIs. This server enables AI models—such as Claude—to effortlessly extract and structure content from various document types including PDFs, images, and Office files. The package supports multiple formats and comes with seamless integration options for Claude Desktop.
- Document Digitization: Extract structured content from documents while preserving layout.
- Information Extraction: Retrieve specific data points using intelligent, customizable schemas.
- Multi-format Support: Handles JPEG, PNG, BMP, PDF, TIFF, HEIC, DOCX, PPTX, and XLSX.
- Claude Desktop Integration: Effortlessly connect with Claude and other MCP clients.
Before using this server, ensure you have the following:
- Upstage API Key: Obtain your API key from Upstage API.
- Python 3.10+: The server requires Python version 3.10 or higher.
- The MCP server relies upon Astral UV to run, please install
This guide provides step-by-step instructions to set up and configure the mcp-upstage
No additional installation is required when using uvx as it handles execution. However, if you prefer to install the package directly:
uv pip install mcp-upstageFor integration with Claude Desktop, add the following content to your claude_desktop_config.json:
- Windows:
%APPDATA%\Claude\claude_desktop_config.json - macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
{
"mcpServers": {
"mcp-upstage": {
"command": "uvx",
"args": ["mcp-upstage"],
"env": {
"UPSTAGE_API_KEY": "<your-api-key>"
}
}
}
}If uvx is not available globally, you may encounter a Server disconnected error. To resolve this, run which uvx to find its full path, and replace "command": "uvx" above with the returned path.
Processing results are stored in your home directory under:
- Document Parsing Results:
~/.mcp-upstage/outputs/document_parsing/ - Information Extraction Results:
~/.mcp-upstage/outputs/information_extraction/ - Generated Schemas:
~/.mcp-upstage/outputs/information_extraction/schemas/
Follow these steps to set up and run the project locally:
git clone https://github.com/UpstageAI/mcp-upstage.git
cd mcp-upstage# Install uv if not already installed
pip install uv
# Create and activate a virtual environment
uv venv
# Activate the virtual environment
# On Windows:
# .venv\Scripts\activate
# On macOS/Linux:
source .venv/bin/activate
# Install dependencies in editable mode
uv pip install -e .-
Download Claude Desktop:
Download Claude Desktop -
Open and Edit Configuration:
- Navigate to Claude → Settings → Developer → Edit Config.
- Edit the
claude_desktop_config.jsonfile with the following configurations:
For Windows:
{ "mcpServers": { "mcp-upstage": { "command": "uv", "args": [ "run", "--directory", "C:\\path\\to\\cloned\\mcp-upstage", "python", "-m", "upstage_mcp.server" ], "env": { "UPSTAGE_API_KEY": "your_api_key_here" } } } }Replace
C:\\path\\to\\cloned\\mcp-upstagewith your actual repository path.For macOS/Linux:
{ "mcpServers": { "mcp-upstage": { "command": "/Users/username/.local/bin/uv", "args": [ "run", "--directory", "/path/to/cloned/mcp-upstage", "python", "-m", "upstage_mcp.server" ], "env": { "UPSTAGE_API_KEY": "your_api_key_here" } } } }Replace:
/Users/username/.local/bin/uvwith the output ofwhich uv./path/to/cloned/mcp-upstagewith the absolute path to your local clone.
Tip for macOS/Linux users 81B5 : If connection issues occur, using the full path to your uv executable can improve reliability.
After configuring, restart Claude Desktop.
The server exposes two primary tools for AI models:
-
Document Parsing (
parse_document):- Description: Processes documents and extracts content while preserving structure.
- Parameter:
file_path– the path to the document to be processed. - Example Query:
"Can you parse the document atC:\Users\username\Documents\contract.pdfand provide a summary?"
-
Information Extraction (
extract_information):- Description: Extracts structured information from documents based on predefined or auto-generated schemas.
- Parameters:
file_path– the document file path;
schema_path(optional) – a JSON file with an extraction schema;
auto_generate_schema(default true) – whether to auto-generate a schema. - Example Query:
"Extract the invoice number, date, and total fromC:\Users\username\Documents\invoice.pdf."
Below is the revised troubleshooting section formatted as requested. You can copy and paste the following Markdown directly into your README:
-
API Key Missing:
Ensure that your UPSTAGE_API_KEY is correctly set in yourclaude_desktop_config.jsonfile. Obtain a valid API key from Upstage Console. -
File Not Found:
Double-check the file path for correctness and accessibility. Ensure that file paths are absolute (e.g.,C:\Users\name\Documents\file.pdf) and that any special characters in the path are properly escaped. -
Server Not Starting:
Verify that your virtual environment is activated and all dependencies are installed. Additionally, review the Claude Desktop log files for errors:- Windows:
%APPDATA%\Claude\logs\mcp-upstage.log - macOS:
~/Library/Logs/Claude/mcp-upstage.log
- Windows:
-
Server Connection Issues:
Restart Claude Desktop. Ensure thatuvxis installed and available in your system PATH, or use its absolute path in your configuration if needed. -
Processing Failures:
Check that the document is in a supported format (PDF, JPEG, PNG, TIFF, etc.), its file size is under 50MB, and it contains fewer than 100 pages. Test with a simpler document to confirm functionality. -
Invalid Document Format:
Verify that the document is in a supported, uncorrupted format. -
Failed to Connect to Upstage API:
Confirm your network connection, firewall settings, and configuration details inclaude_desktop_config.json. Review the logs for more detailed error messages.
For troubleshooting, view the server logs at:
- Windows:
%APPDATA%\Claude\logs\mcp-upstage.log - macOS:
~/Library/Logs/Claude/mcp-upstage.log
Contributions are welcome! If you wish to enhance the project or add new features, please fork the repository and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.
This project is licensed under the MIT License.