rossum-mcp 0.4.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

rossum_mcp-1.0.1.dist-info/METADATA

@@ -0,0 +1,241 @@
+Metadata-Version: 2.4
+Name: rossum-mcp
+Version: 1.0.1
+Summary: MCP server for AI-powered Rossum orchestration: document workflows, debug pipelines automatically, and configure intelligent document processing through natural language.
+Author-email: "Dan Stancl (Rossum AI)" <daniel.stancl@gmail.com>
+License: MIT
+Keywords: mcp,rossum,document-processing
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastmcp>=2.0.0
+Requires-Dist: pydantic>2.0.0
+Requires-Dist: rossum-api>=3.8.0
+Provides-Extra: docs
+Requires-Dist: myst-parser>=2.0.0; extra == "docs"
+Requires-Dist: sphinx>=7.0.0; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints>=1.25.0; extra == "docs"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=2.0.0; extra == "docs"
+Provides-Extra: tests
+Requires-Dist: coverage>=7.0.0; extra == "tests"
+Requires-Dist: pytest>=7.0.0; extra == "tests"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "tests"
+Requires-Dist: pytest-cov>=4.0.0; extra == "tests"
+Requires-Dist: redis>=7.0.0; extra == "tests"
+Provides-Extra: all
+Requires-Dist: coverage>=7.0.0; extra == "all"
+Requires-Dist: fastmcp>=2.0.0; extra == "all"
+Requires-Dist: myst-parser>=2.0.0; extra == "all"
+Requires-Dist: pydantic>2.0.0; extra == "all"
+Requires-Dist: pytest>=7.0.0; extra == "all"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "all"
+Requires-Dist: redis>=7.0.0; extra == "all"
+Requires-Dist: rossum-api>=3.8.0; extra == "all"
+Requires-Dist: sphinx>=7.0.0; extra == "all"
+Requires-Dist: sphinx-autodoc-typehints>=1.25.0; extra == "all"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "all"
+Requires-Dist: sphinx-rtd-theme>=2.0.0; extra == "all"
+Dynamic: license-file
+
+# Rossum MCP Server
+
+<div align="center">
+
+**MCP server for AI-powered Rossum document processing. 56 tools for queues, schemas, hooks, engines, and more.**
+
+[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://stancld.github.io/rossum-agents/)
+[![Python](https://img.shields.io/pypi/pyversions/rossum-mcp.svg)](https://pypi.org/project/rossum-mcp/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![PyPI - rossum-mcp](https://img.shields.io/pypi/v/rossum-mcp?label=rossum-mcp)](https://pypi.org/project/rossum-mcp/)
+[![Coverage](https://codecov.io/gh/stancld/rossum-agents/branch/master/graph/badge.svg?flag=rossum-mcp)](https://codecov.io/gh/stancld/rossum-agents)
+[![MCP Tools](https://img.shields.io/badge/MCP_Tools-56-blue.svg)](#available-tools)
+
+[![Rossum API](https://img.shields.io/badge/Rossum-API-orange.svg)](https://github.com/rossumai/rossum-api)
+[![MCP](https://img.shields.io/badge/MCP-compatible-green.svg)](https://modelcontextprotocol.io/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+
+</div>
+
+> [!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
+
+```bash
+# 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:
+
+```bash
+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):
+
+```json
+{
+  "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 |
+
+<details>
+<summary><strong>Tool List by Category</strong></summary>
+
+**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`
+
+</details>
+
+For detailed API documentation with parameters and examples, see [TOOLS.md](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
+
+```python
+# 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
+
+```python
+# 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](LICENSE) file for details.
+
+## Resources
+
+- [Full Documentation](https://stancld.github.io/rossum-agents/)
+- [Tools Reference](TOOLS.md)
+- [Rossum API Documentation](https://elis.rossum.ai/api/docs/)
+- [Model Context Protocol](https://modelcontextprotocol.io/)
+- [Main Repository](https://github.com/stancld/rossum-agents)

rossum_mcp-1.0.1.dist-info/RECORD

@@ -0,0 +1,25 @@
+rossum_mcp/__init__.py,sha256=76_5unf43DE01lMmn6fXhlZawCdTEyjFCe1AnXb4X3s,58
+rossum_mcp/logging_config.py,sha256=OH5G6K4wH_g-m55FdRO1BYXIDtOop-lD9Ps_mTMQ8eY,4792
+rossum_mcp/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rossum_mcp/server.py,sha256=r9YO5Lt0lZ2iwqCBnMAVE3yhjHXvFlU9sZb4NknjOXQ,1959
+rossum_mcp/tools/__init__.py,sha256=70BqRQUnMqQL30VXO2PRJAIwCYu9JAC9B7nIvw0MvCY,1428
+rossum_mcp/tools/annotations.py,sha256=bzi6AuJDIrKEx-xqjW0WwHSygDTWpVoqAuUTPsTZJeQ,7532
+rossum_mcp/tools/base.py,sha256=b_XIytigoU9p244kA1HhCuqUbah36RFdtQMMxQpDA40,2243
+rossum_mcp/tools/catalog.py,sha256=nCgAJPlWQqI684qGO0iZc-ncw1n0YlJbF3ZeSaU0xSs,8002
+rossum_mcp/tools/discovery.py,sha256=coZyzrEDN5CwaglobFQlSPRql69c6mcqjmNz6tulkBU,1288
+rossum_mcp/tools/document_relations.py,sha256=7-mdRyRXXZRtRsL_ntZpfpWbMVYS5NUKW6yya4AzmNQ,2169
+rossum_mcp/tools/email_templates.py,sha256=euAxDml6LY3BbElCPwHkHkvcyCGz6wjtg4HvgYzcuto,4649
+rossum_mcp/tools/engines.py,sha256=6Q_gmATzb4eOwSjCmbsZAGm9unsogAfi2b-GyZ9Zyhc,6617
+rossum_mcp/tools/hooks.py,sha256=v1yKA8TtWQiZQkY_LYUC5lm8WRX4qMSeIkI2Z8m1OK0,12830
+rossum_mcp/tools/queues.py,sha256=QtGCt6pSMDmARoa9_L1fSzWjeMGFJSQLoW_sgSoBbwA,11063
+rossum_mcp/tools/relations.py,sha256=ko1_v6meM2zCEmnhaDQt-T4uX_XJcRV4-X-Pxsu_prQ,2016
+rossum_mcp/tools/rules.py,sha256=EAAVfdTMuOgvORpXxzgBox-P2MlvL3Vo6CcdDTzqQuM,2052
+rossum_mcp/tools/schemas.py,sha256=9QTV24SaTrzKUPkzYuOjL1b9vmVVPJee-crbWWF7RRo,30230
+rossum_mcp/tools/users.py,sha256=uVojYtUQs4KorQxgmmPRNJtExS4GbzyckZ1W4Y_0Qrk,3047
+rossum_mcp/tools/workspaces.py,sha256=miV8XeJxdWQctx6RuYJXmnbNmNDL0SKcG-Senq6cWk0,3338
+rossum_mcp-1.0.1.dist-info/licenses/LICENSE,sha256=5nqARgtmPvoIU-1o1az3i8Qi2WOHYIn03vD6haewvEI,1087
+rossum_mcp-1.0.1.dist-info/METADATA,sha256=y1IqueqUlCsxaQcZ5BkB9gQKl-bMPhR6RSVAQGtlcCk,8991
+rossum_mcp-1.0.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+rossum_mcp-1.0.1.dist-info/entry_points.txt,sha256=eth2XELk0QGw9-_H3QL8PQ0OE-RDfzipbSvRy0EUc2c,54
+rossum_mcp-1.0.1.dist-info/top_level.txt,sha256=cziqyWFE89hFhCfsq60Fk6JcwslNtgP01WHIJ5plMEM,11
+rossum_mcp-1.0.1.dist-info/RECORD,,

{rossum_mcp-0.4.0.dist-info → rossum_mcp-1.0.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

rossum_mcp-1.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Rossum MCP Server Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.