Rossum MCP Server

Getting Started:

  • Installation
    • Prerequisites
    • Installation Methods
      • From GitHub
      • With Documentation Support
      • From Source (Development)
    • Environment Variables
  • Usage
    • Running the MCP Server
    • Using with MCP Clients
      • Claude Desktop Configuration
    • Using with Smolagents
    • Available Tools
      • upload_document
      • get_annotation
      • list_annotations
      • get_queue
      • get_schema
      • get_queue_schema
  • Annotation Status Workflow
    • Annotation States
    • Important Considerations
    • Example Workflows
      • Single Document Upload
      • Bulk Document Upload
    • Error Handling

Reference:

  • API Reference
    • RossumMCPServer
      • RossumMCPServer
        • RossumMCPServer.__init__()
        • RossumMCPServer.upload_document()
        • RossumMCPServer.get_annotation()
        • RossumMCPServer.list_annotations()
        • RossumMCPServer.get_queue()
        • RossumMCPServer.get_schema()
        • RossumMCPServer.get_queue_schema()
        • RossumMCPServer.setup_handlers()
        • RossumMCPServer.run()
      • async_main()
      • main()
      • Main Server Class
        • RossumMCPServer
      • Methods
        • Document Upload
        • Annotation Retrieval
        • Queue and Schema
        • Server Management
      • Functions
        • async_main()
        • main()
  • MCP to Rossum SDK Mapping
    • Overview
    • Tool-to-SDK Mapping
      • upload_document
      • get_annotation
      • list_annotations
      • get_queue
      • get_schema
      • get_queue_schema
    • Async Wrapper Pattern
    • Rossum API Resources
    • Authentication
    • Error Handling

Examples:

  • Examples
    • Available Examples
      • Plotting Tool
        • Overview
        • Quick Example
        • Chart Types
        • Integration Pattern
        • Implementation Details
        • Running the Example
        • API Reference
        • See Also
    • Building Your Own Agents
      • Example Pattern
      • Integration with AI Agents
    • Next Steps
Rossum MCP Server
  • Index

Index

_ | A | G | L | M | R | S | U

_

  • __init__() (rossum_mcp.server.RossumMCPServer method), [1]
  • _get_annotation_sync() (rossum_mcp.server.RossumMCPServer method)
  • _get_queue_schema_sync() (rossum_mcp.server.RossumMCPServer method)
  • _get_queue_sync() (rossum_mcp.server.RossumMCPServer method)
  • _get_schema_sync() (rossum_mcp.server.RossumMCPServer method)
  • _list_annotations_sync() (rossum_mcp.server.RossumMCPServer method)
  • _upload_document_sync() (rossum_mcp.server.RossumMCPServer method)

A

  • async_main() (in module rossum_mcp.server), [1]

G

  • get_annotation() (rossum_mcp.server.RossumMCPServer method), [1], [2]
  • get_queue() (rossum_mcp.server.RossumMCPServer method), [1], [2]
  • get_queue_schema() (rossum_mcp.server.RossumMCPServer method), [1], [2]
  • get_schema() (rossum_mcp.server.RossumMCPServer method), [1], [2]

L

  • list_annotations() (rossum_mcp.server.RossumMCPServer method), [1], [2]

M

  • main() (in module rossum_mcp.server), [1]
  • module
    • rossum_mcp.server

R

  • rossum_mcp.server
    • module
  • RossumMCPServer (class in rossum_mcp.server), [1]
  • run() (rossum_mcp.server.RossumMCPServer method), [1], [2]

S

  • setup_handlers() (rossum_mcp.server.RossumMCPServer method), [1], [2]

U

  • upload_document() (rossum_mcp.server.RossumMCPServer method), [1], [2]

© Copyright 2025, Dan Stancl.

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