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. 67 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, not a product (yet).

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-agents/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.

Runtime Mode Switching

Two tools allow dynamic mode control:

Tool Description
get_mcp_mode Returns current operation mode (read-only or read-write)
set_mcp_mode Switches between modes at runtime

Use case: Start in read-only mode for safe exploration, then switch to read-write when ready to make changes.

User: What mode are we in?
Assistant: [calls get_mcp_mode] → "read-only"

User: I'm ready to update the schema now.
Assistant: [calls set_mcp_mode("read-write")] → Mode switched to read-write
           [calls update_schema(...)]

Available Tools

The server provides 67 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 (Hooks) 9 Webhooks, serverless functions, testing
Rules & Actions 6 Business rules with triggers and actions
Workspace Management 4 Organize and delete workspaces
Organization Groups 2 View license groups across organizations
Organization Limits 1 Email sending limits and usage counters
User Management 5 Create, update, list users and roles
Relations 4 Annotation and document relations
Email Templates 3 Automated email responses
MCP Mode 2 Get/set read-only or read-write mode
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 (Hooks): get_hook, list_hooks, create_hook, update_hook, list_hook_templates, create_hook_from_template, test_hook, list_hook_logs, delete_hook

Rules & Actions: get_rule, list_rules, create_rule, update_rule, patch_rule, delete_rule

Workspace Management: get_workspace, list_workspaces, create_workspace, delete_workspace

Organization Groups: get_organization_group, list_organization_groups

Organization Limits: get_organization_limit

User Management: get_user, list_users, create_user, update_user, 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

MCP Mode: get_mcp_mode, set_mcp_mode

Tool Discovery: list_tool_categories

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

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.2.3.tar.gz (37.9 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.2.3-py3-none-any.whl (45.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rossum_mcp-1.2.3.tar.gz
  • Upload date:
  • Size: 37.9 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.2.3.tar.gz
Algorithm Hash digest
SHA256 dcae94f2311da36d529ee599a349b5ebd42d4bb4b57d440586942cd4028f91ab
MD5 89858f699e4b75deed6cb0b1a9582081
BLAKE2b-256 e549aeb6c92318b80cb1701719440744a6a9aabe2f525a72b62fc7d5dc824ec8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rossum_mcp-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 45.0 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.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8f5dc2c4997530325e4c51828208b2a8e99680fa8cc158ee26c198a07d1f3b0e
MD5 1498cfb7c080b17bc26f7a3d54f196cd
BLAKE2b-256 04c8a9a8cd949a7a9612f1349a304bb185c614cf7b41a7d7956c30938cb7dc7c

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