Rossum MCP Server

Getting Started:

  • Installation
    • Prerequisites
    • Installation Methods
      • Installing MCP Server Only
      • Installing Agent Only
      • Installing Agent Client Only
      • Installing Deploy Package Only
      • Installing All Packages (Workspace)
      • From GitHub (Direct)
    • Environment Variables
      • Configuration Options
      • Read-Only vs Read-Write Mode
  • Usage
    • Running the MCP Server
    • Using with MCP Clients
      • Claude Desktop Configuration
    • Running the AI Agent
    • Using Rossum Deploy
      • Python API
      • CLI Commands
      • Cross-Organization Deployment
    • Using with AI Agents
    • Available Tools
      • upload_document
      • get_annotation
      • list_annotations
      • get_queue
      • get_schema
      • get_queue_schema
      • get_queue_engine
      • get_queue_template_names
      • create_queue_from_template
      • create_queue
      • update_queue
      • delete_queue
      • update_schema
      • patch_schema
      • update_engine
      • create_schema
      • delete_schema
      • get_engine
      • list_engines
      • create_engine
      • create_engine_field
      • get_engine_fields
      • start_annotation
      • bulk_update_annotation_fields
      • confirm_annotation
      • delete_annotation
      • 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 Management
      • get_relation
      • list_relations
      • get_document_relation
      • list_document_relations
      • Email Template Tools
        • get_email_template
        • list_email_templates
        • create_email_template
    • Agent Tools
      • File System Tools
        • write_file
      • Knowledge Base Tools
        • search_knowledge_base
      • Hook Debugging Tools
        • evaluate_python_hook
        • debug_hook
      • Multi-Environment Tools
        • spawn_mcp_connection
        • call_on_connection
        • close_connection
      • Skills Tools
        • load_skill
      • Agent Deployment Tools
        • deploy_pull
        • deploy_diff
        • deploy_push
        • deploy_copy_org
        • deploy_copy_workspace
        • deploy_compare_workspaces
        • deploy_to_org
    • Deployment Tools
      • Workspace
      • pull
      • diff
      • push
      • CLI Usage
      • Comparison with deployment-manager
  • Annotation Status Workflow
    • Annotation States
    • Important Considerations
    • Example Workflows
      • Single Document Upload
      • Bulk Document Upload
    • Error Handling

Reference:

  • API Reference
    • RossumMCPServer
      • Main Server Class
      • Methods
        • Document Upload
        • Annotation Retrieval
        • Queue and Schema
        • Server Management
      • Functions
  • MCP to Rossum SDK Mapping
    • Overview
    • Tool-to-SDK Mapping
      • upload_document
      • get_annotation
      • list_annotations
      • get_queue
      • get_schema
      • get_queue_schema
      • get_queue_engine
      • get_queue_template_names
      • create_queue_from_template
      • create_queue
      • update_queue
      • update_schema
      • update_engine
      • list_hooks
      • create_hook
      • list_rules
      • update_hook
      • list_hook_templates
      • create_hook_from_template
      • patch_schema
      • get_user
      • list_users
      • list_user_roles
      • list_tool_categories
    • Delete Operations
      • delete_annotation
      • delete_queue
      • delete_schema
      • delete_hook
      • delete_rule
      • delete_workspace
    • Async Wrapper Pattern
    • Rossum API Resources
    • Authentication
    • Error Handling
  • Skills & Sub-Agents
    • Skills
      • Loading Skills
      • Available Skills
        • Rossum Deployment Skill
        • Hook Debugging Skill
        • Schema Patching Skill
        • Schema Pruning Skill
        • Organization Setup Skill
        • UI Settings Skill
    • Dynamic Tool Loading
      • How It Works
      • Loading Tools
      • Available Categories
      • Automatic Pre-loading
    • Sub-Agents
      • Hook Debug Sub-Agent
      • Knowledge Base Sub-Agent
      • Schema Patching Sub-Agent
      • Sub-Agent Architecture

Examples:

  • Examples
    • Real-World Use Cases
      • Example 1: Aurora Splitting & Sorting Demo
      • Example 2: Hook Analysis & Documentation
      • Example 3: Queue Setup with Knowledge Warmup
    • Building Your Own Agents
      • Example Pattern
      • Integration with AI Agents
    • Next Steps
Rossum MCP Server
  • Search

© Copyright 2025, Dan Stancl.

Built with Sphinx using a theme provided by Read the Docs.