Skip to main content

MCP server for AI-powered Rossum orchestration: document workflows, debug pipelines automatically, and configure intelligent document processing through natural language.

Project description

Rossum MCP Server

MCP server for AI-powered Rossum document processing. 56 tools for queues, schemas, hooks, engines, and more.

Documentation Python License: MIT PyPI - rossum-mcp Coverage MCP Tools

Rossum API MCP Ruff ty uv

[!NOTE] This is not an official Rossum project. It is a community-developed integration built on top of the Rossum API.

[!NOTE] API is stable starting from 1.0.0. Breaking changes will follow SemVer (released as 2.0.0+).

Quick Start

# Set environment variables
export ROSSUM_API_TOKEN="your-api-token"
export ROSSUM_API_BASE_URL="https://api.elis.rossum.ai/v1"

# Run the MCP server
uv pip install rossum-mcp
rossum-mcp

Or run from source:

git clone https://github.com/stancld/rossum-agents.git
cd rossum-mcp/rossum-mcp
uv sync
python rossum_mcp/server.py

Claude Desktop Configuration

Configure Claude Desktop (~/Library/Application Support/Claude/claude_desktop_config.json on Mac):

{
  "mcpServers": {
    "rossum": {
      "command": "python",
      "args": ["/path/to/rossum-mcp/rossum-mcp/rossum_mcp/server.py"],
      "env": {
        "ROSSUM_API_TOKEN": "your-api-token",
        "ROSSUM_API_BASE_URL": "https://api.elis.rossum.ai/v1",
        "ROSSUM_MCP_MODE": "read-write"
      }
    }
  }
}

Environment Variables

Variable Required Description
ROSSUM_API_TOKEN Yes Your Rossum API authentication token
ROSSUM_API_BASE_URL Yes Base URL for the Rossum API
ROSSUM_MCP_MODE No read-write (default) or read-only

Read-Only Mode

Set ROSSUM_MCP_MODE=read-only to disable all CREATE, UPDATE, and UPLOAD operations. Only GET and LIST operations will be available.

Available Tools

The server provides 56 tools organized into categories:

Category Tools Description
Document Processing 7 Upload documents, retrieve/update/confirm/delete annotations
Queue Management 9 Create, configure, delete, and list queues
Schema Management 8 Define, modify, and delete field structures
Engine Management 6 Configure extraction and splitting engines
Extensions & Rules 11 Webhooks, serverless functions, business rules
Workspace Management 4 Organize and delete workspaces
User Management 3 List users and roles
Relations 4 Annotation and document relations
Email Templates 3 Automated email responses
Tool Discovery 1 Dynamic tool loading
Tool List by Category

Document Processing: upload_document, get_annotation, list_annotations, start_annotation, bulk_update_annotation_fields, confirm_annotation, delete_annotation

Queue Management: get_queue, list_queues, get_queue_schema, get_queue_engine, create_queue, create_queue_from_template, get_queue_template_names, update_queue, delete_queue

Schema Management: get_schema, list_schemas, create_schema, update_schema, patch_schema, get_schema_tree_structure, prune_schema_fields, delete_schema

Engine Management: get_engine, list_engines, create_engine, update_engine, create_engine_field, get_engine_fields

Extensions & Rules: get_hook, list_hooks, create_hook, update_hook, list_hook_templates, create_hook_from_template, list_hook_logs, delete_hook, get_rule, list_rules, delete_rule

Workspace Management: get_workspace, list_workspaces, create_workspace, delete_workspace

User Management: get_user, list_users, list_user_roles

Relations: get_relation, list_relations, get_document_relation, list_document_relations

Email Templates: get_email_template, list_email_templates, create_email_template

Tool Discovery: list_tool_categories

For detailed API documentation with parameters and examples, see TOOLS.md.

Annotation Workflow

Documents progress through these states:

importing → to_review → reviewing → confirmed → exporting → exported

Key points:

  • Wait for to_review before processing
  • Call start_annotation before updating fields
  • Call confirm_annotation to finalize

Example Workflows

Upload and Monitor

# 1. Upload document
upload_document(file_path="/path/to/invoice.pdf", queue_id=12345)

# 2. Get annotation ID
annotations = list_annotations(queue_id=12345)

# 3. Check status
annotation = get_annotation(annotation_id=annotations[0].id)

Update Fields

# 1. Start annotation (moves to 'reviewing')
start_annotation(annotation_id=12345)

# 2. Get content with field IDs
annotation = get_annotation(annotation_id=12345, sideloads=['content'])

# 3. Update fields using datapoint IDs
bulk_update_annotation_fields(
    annotation_id=12345,
    operations=[{"op": "replace", "id": 67890, "value": {"content": {"value": "INV-001"}}}]
)

# 4. Confirm
confirm_annotation(annotation_id=12345)

License

MIT License - see LICENSE file for details.

Resources

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rossum_mcp-1.0.1.tar.gz (34.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rossum_mcp-1.0.1-py3-none-any.whl (36.7 kB view details)

Uploaded Python 3

File details

Details for the file rossum_mcp-1.0.1.tar.gz.

File metadata

  • Download URL: rossum_mcp-1.0.1.tar.gz
  • Upload date:
  • Size: 34.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rossum_mcp-1.0.1.tar.gz
Algorithm Hash digest
SHA256 1a3fd74ba0af8fbd18f6a573724dd9e73948734803913009568b6314a2564f42
MD5 ec3a20dc7887225493117aa7ef7aab1a
BLAKE2b-256 41ccbc4ec633332f3f02c6009fa0e4883288d6b8f092cd3460d7c374a44741d8

See more details on using hashes here.

File details

Details for the file rossum_mcp-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: rossum_mcp-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 36.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rossum_mcp-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9dcecc311f1d10fb1c2d2da94e5fcef165cf610d713a2865f6b9a254ae97a92e
MD5 e329a0eadb380d29e1991dcb928402eb
BLAKE2b-256 3d46680132c705bef9a1a5d9b368951efd78ee0241205ee40d9bc5c8fc8a10d2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page