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

rossum_mcp/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "1.0.1"
+__version__ = "1.1.0"

rossum_mcp/server.py

@@ -29,6 +29,7 @@ from rossum_mcp.tools import (
     register_user_tools,
     register_workspace_tools,
 )
+from rossum_mcp.tools.base import get_mcp_mode, set_mcp_mode
 
 setup_logging(app_name="rossum-mcp-server", log_level="DEBUG", use_console=False)
 
@@ -36,12 +37,8 @@ logger = logging.getLogger(__name__)
 
 BASE_URL = os.environ["ROSSUM_API_BASE_URL"].rstrip("/")
 API_TOKEN = os.environ["ROSSUM_API_TOKEN"]
-MODE = os.environ.get("ROSSUM_MCP_MODE", "read-write").lower()
 
-if MODE not in ("read-only", "read-write"):
-    raise ValueError(f"Invalid ROSSUM_MCP_MODE: {MODE}. Must be 'read-only' or 'read-write'")
-
-logger.info(f"Rossum MCP Server starting in {MODE} mode")
+logger.info(f"Rossum MCP Server starting in {get_mcp_mode()} mode")
 
 mcp = FastMCP("rossum-mcp-server")
 client = AsyncRossumAPIClient(base_url=BASE_URL, credentials=Token(token=API_TOKEN))
@@ -60,6 +57,22 @@ register_user_tools(mcp, client)
 register_workspace_tools(mcp, client)
 
 
+@mcp.tool(description="Get the current MCP operation mode (read-only or read-write).")
+async def get_mcp_mode_tool() -> dict:
+    return {"mode": get_mcp_mode()}
+
+
+@mcp.tool(
+    description="Set the MCP operation mode. Use 'read-only' to disable write operations, 'read-write' to enable them."
+)
+async def set_mcp_mode_tool(mode: str) -> dict:
+    try:
+        set_mcp_mode(mode)
+        return {"message": f"MCP mode set to '{get_mcp_mode()}'"}
+    except ValueError as e:
+        return {"error": str(e)}
+
+
 def main() -> None:
     """Main entry point for console script."""
     mcp.run()

rossum_mcp/tools/base.py

@@ -13,11 +13,30 @@ if TYPE_CHECKING:
 logger = logging.getLogger(__name__)
 
 BASE_URL = os.environ.get("ROSSUM_API_BASE_URL", "").rstrip("/")
-MODE = os.environ.get("ROSSUM_MCP_MODE", "read-write").lower()
 
 # Marker used to indicate omitted fields in list responses
 TRUNCATED_MARKER = "<omitted>"
 
+VALID_MODES = ("read-only", "read-write")
+
+_mcp_mode = os.environ.get("ROSSUM_MCP_MODE", "read-write").lower()
+if _mcp_mode not in VALID_MODES:
+    raise ValueError(f"Invalid ROSSUM_MCP_MODE: {_mcp_mode}. Must be one of: {VALID_MODES}")
+
+
+def get_mcp_mode() -> str:
+    """Return the current MCP mode."""
+    return _mcp_mode
+
+
+def set_mcp_mode(mode: str) -> None:
+    """Set the MCP mode (case-insensitive)."""
+    global _mcp_mode
+    normalized = mode.lower()
+    if normalized not in VALID_MODES:
+        raise ValueError(f"Invalid mode '{mode}'. Must be one of: {VALID_MODES}")
+    _mcp_mode = normalized
+
 
 def build_resource_url(resource_type: str, resource_id: int) -> str:
     """Build a full URL for a Rossum API resource."""
@@ -26,7 +45,7 @@ def build_resource_url(resource_type: str, resource_id: int) -> str:
 
 def is_read_write_mode() -> bool:
     """Check if server is in read-write mode."""
-    return MODE == "read-write"
+    return _mcp_mode == "read-write"
 
 
 def truncate_dict_fields(data: dict[str, Any], fields: tuple[str, ...]) -> dict[str, Any]:

rossum_mcp/tools/catalog.py

@@ -139,6 +139,9 @@ TOOL_CATALOG: dict[str, ToolCategory] = {
         tools=[
             ToolInfo("get_rule", "Retrieve rule details"),
             ToolInfo("list_rules", "List validation rules"),
+            ToolInfo("create_rule", "Create validation rule", read_only=False),
+            ToolInfo("update_rule", "Full update rule (PUT)", read_only=False),
+            ToolInfo("patch_rule", "Partial update rule (PATCH)", read_only=False),
             ToolInfo("delete_rule", "Delete rule", read_only=False),
         ],
         keywords=["rule", "validation", "constraint"],

rossum_mcp/tools/rules.py

@@ -3,11 +3,12 @@
 from __future__ import annotations
 
 import logging
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Literal, TypedDict
 
+from rossum_api.domain_logic.resources import Resource
 from rossum_api.models.rule import Rule
 
-from rossum_mcp.tools.base import delete_resource
+from rossum_mcp.tools.base import build_resource_url, delete_resource, is_read_write_mode
 
 if TYPE_CHECKING:
     from fastmcp import FastMCP
@@ -16,6 +17,42 @@ if TYPE_CHECKING:
 logger = logging.getLogger(__name__)
 
 
+RuleActionType = Literal[
+    "show_message",
+    "add_automation_blocker",
+    "add_validation_source",
+    "change_queue",
+    "send_email",
+    "hide_field",
+    "show_field",
+    "show_hide_field",
+    "change_status",
+    "add_label",
+    "remove_label",
+    "custom",
+]
+
+
+class RuleActionPayload(TypedDict, total=False):
+    """Payload for rule actions. Fields depend on action type."""
+
+    type: Literal["info", "warning", "error"]  # for show_message
+    content: str  # message content or template
+    schema_id: str  # target field schema_id
+    queue_url: str  # for change_queue
+    status: str  # for change_status
+    label: str  # for add_label/remove_label
+
+
+class RuleAction(TypedDict):
+    """Rule action definition."""
+
+    id: str  # unique action identifier
+    type: RuleActionType
+    event: Literal["validation"]
+    payload: RuleActionPayload
+
+
 async def _get_rule(client: AsyncRossumAPIClient, rule_id: int) -> Rule:
     logger.debug(f"Retrieving rule: rule_id={rule_id}")
     rule: Rule = await client.retrieve_rule(rule_id)
@@ -41,6 +78,108 @@ async def _list_rules(
     return rules_list
 
 
+async def _create_rule(
+    client: AsyncRossumAPIClient,
+    name: str,
+    schema_id: int,
+    trigger_condition: str,
+    actions: list[RuleAction],
+    enabled: bool = True,
+    queue_ids: list[int] | None = None,
+) -> Rule | dict:
+    if not is_read_write_mode():
+        return {"error": "create_rule is not available in read-only mode"}
+
+    schema_url = build_resource_url("schemas", schema_id)
+    logger.info(f"Creating rule: name={name}, schema_id={schema_id}, enabled={enabled}")
+
+    rule_data: dict = {
+        "name": name,
+        "schema": schema_url,
+        "trigger_condition": trigger_condition,
+        "actions": actions,
+        "enabled": enabled,
+    }
+
+    if queue_ids is not None:
+        rule_data["queues"] = [build_resource_url("queues", qid) for qid in queue_ids]
+
+    logger.debug(f"Rule creation payload: {rule_data}")
+    rule: Rule = await client.create_new_rule(rule_data)
+    logger.info(f"Successfully created rule: id={rule.id}, name={rule.name}")
+    return rule
+
+
+async def _update_rule(
+    client: AsyncRossumAPIClient,
+    rule_id: int,
+    name: str,
+    trigger_condition: str,
+    actions: list[RuleAction],
+    enabled: bool,
+    queue_ids: list[int] | None = None,
+) -> Rule | dict:
+    """Full update (PUT) - all fields required."""
+    if not is_read_write_mode():
+        return {"error": "update_rule is not available in read-only mode"}
+
+    logger.info(f"Updating rule: rule_id={rule_id}, name={name}")
+    existing_rule: Rule = await client.retrieve_rule(rule_id)
+
+    rule_data: dict = {
+        "name": name,
+        "schema": existing_rule.schema,
+        "trigger_condition": trigger_condition,
+        "actions": actions,
+        "enabled": enabled,
+    }
+
+    if queue_ids is not None:
+        rule_data["queues"] = [build_resource_url("queues", qid) for qid in queue_ids]
+
+    logger.debug(f"Rule update payload: {rule_data}")
+    await client._http_client.update(Resource.Rule, rule_id, rule_data)
+    updated_rule: Rule = await client.retrieve_rule(rule_id)
+    logger.info(f"Successfully updated rule: id={updated_rule.id}")
+    return updated_rule
+
+
+async def _patch_rule(
+    client: AsyncRossumAPIClient,
+    rule_id: int,
+    name: str | None = None,
+    trigger_condition: str | None = None,
+    actions: list[RuleAction] | None = None,
+    enabled: bool | None = None,
+    queue_ids: list[int] | None = None,
+) -> Rule | dict:
+    """Partial update (PATCH) - only provided fields are updated."""
+    if not is_read_write_mode():
+        return {"error": "patch_rule is not available in read-only mode"}
+
+    logger.info(f"Patching rule: rule_id={rule_id}")
+
+    patch_data: dict = {}
+    if name is not None:
+        patch_data["name"] = name
+    if trigger_condition is not None:
+        patch_data["trigger_condition"] = trigger_condition
+    if actions is not None:
+        patch_data["actions"] = actions
+    if enabled is not None:
+        patch_data["enabled"] = enabled
+    if queue_ids is not None:
+        patch_data["queues"] = [build_resource_url("queues", qid) for qid in queue_ids]
+
+    if not patch_data:
+        return {"error": "No fields provided to update"}
+
+    logger.debug(f"Rule patch payload: {patch_data}")
+    updated_rule: Rule = await client.update_part_rule(rule_id, patch_data)
+    logger.info(f"Successfully patched rule: id={updated_rule.id}")
+    return updated_rule
+
+
 async def _delete_rule(client: AsyncRossumAPIClient, rule_id: int) -> dict:
     return await delete_resource("rule", rule_id, client.delete_rule)
 
@@ -58,6 +197,45 @@ def register_rule_tools(mcp: FastMCP, client: AsyncRossumAPIClient) -> None:
     ) -> list[Rule]:
         return await _list_rules(client, schema_id, organization_id, enabled)
 
+    @mcp.tool(
+        description="Create a new rule. Rules automate field operations based on trigger conditions (TxScript formulas like 'field.amount > 1000'). Actions require: id (unique str), type (show_message|hide_field|show_field|change_status|custom|etc), event (validation), payload (dict with type, content, schema_id for show_message). queue_ids limits rule to specific queues."
+    )
+    async def create_rule(
+        name: str,
+        schema_id: int,
+        trigger_condition: str,
+        actions: list[RuleAction],
+        enabled: bool = True,
+        queue_ids: list[int] | None = None,
+    ) -> Rule | dict:
+        return await _create_rule(client, name, schema_id, trigger_condition, actions, enabled, queue_ids)
+
+    @mcp.tool(
+        description="Full update of a rule (PUT). All fields required. Use patch_rule for partial updates. queue_ids limits rule to specific queues."
+    )
+    async def update_rule(
+        rule_id: int,
+        name: str,
+        trigger_condition: str,
+        actions: list[RuleAction],
+        enabled: bool,
+        queue_ids: list[int] | None = None,
+    ) -> Rule | dict:
+        return await _update_rule(client, rule_id, name, trigger_condition, actions, enabled, queue_ids)
+
+    @mcp.tool(
+        description="Partial update of a rule (PATCH). Only provided fields are updated. queue_ids limits rule to specific queues (empty list removes all)."
+    )
+    async def patch_rule(
+        rule_id: int,
+        name: str | None = None,
+        trigger_condition: str | None = None,
+        actions: list[RuleAction] | None = None,
+        enabled: bool | None = None,
+        queue_ids: list[int] | None = None,
+    ) -> Rule | dict:
+        return await _patch_rule(client, rule_id, name, trigger_condition, actions, enabled, queue_ids)
+
     @mcp.tool(description="Delete a rule.")
     async def delete_rule(rule_id: int) -> dict:
         return await _delete_rule(client, rule_id)

{rossum_mcp-1.0.1.dist-info → rossum_mcp-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rossum-mcp
-Version: 1.0.1
+Version: 1.1.0
 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
@@ -51,14 +51,14 @@ Dynamic: license-file
 
 <div align="center">
 
-**MCP server for AI-powered Rossum document processing. 56 tools for queues, schemas, hooks, engines, and more.**
+**MCP server for AI-powered Rossum document processing. 59 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)
+[![MCP Tools](https://img.shields.io/badge/MCP_Tools-59-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/)
@@ -127,9 +127,29 @@ Configure Claude Desktop (`~/Library/Application Support/Claude/claude_desktop_c
 
 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 **56 tools** organized into categories:
+The server provides **59 tools** organized into categories:
 
 | Category | Tools | Description |
 |----------|-------|-------------|
@@ -137,7 +157,7 @@ The server provides **56 tools** organized into categories:
 | **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 |
+| **Extensions & Rules** | 14 | 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 |
@@ -160,7 +180,7 @@ The server provides **56 tools** organized into categories:
 `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`
+`get_hook`, `list_hooks`, `create_hook`, `update_hook`, `list_hook_templates`, `create_hook_from_template`, `list_hook_logs`, `delete_hook`, `get_rule`, `list_rules`, `create_rule`, `update_rule`, `patch_rule`, `delete_rule`
 
 **Workspace Management:**
 `get_workspace`, `list_workspaces`, `create_workspace`, `delete_workspace`

{rossum_mcp-1.0.1.dist-info → rossum_mcp-1.1.0.dist-info}/RECORD

@@ -1,11 +1,11 @@
-rossum_mcp/__init__.py,sha256=76_5unf43DE01lMmn6fXhlZawCdTEyjFCe1AnXb4X3s,58
+rossum_mcp/__init__.py,sha256=Iq0Wpiois2btEXR6bHCxUOPDJCUSSksVZescvgFn2W4,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/server.py,sha256=6UViyT90CP8LouYgaxwSrSEdgJY1h0tpUjuqPNvbRKk,2338
 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/base.py,sha256=xNHQeJoQvxjd6NLG_6rJpmXyHqyI-XByjmvumkwsFzQ,2796
+rossum_mcp/tools/catalog.py,sha256=ZeMmjsvVMdUSS7gj5Mv8SO1y48G2Ak8XZtTpFkfUTPw,8246
 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
@@ -13,13 +13,13 @@ rossum_mcp/tools/engines.py,sha256=6Q_gmATzb4eOwSjCmbsZAGm9unsogAfi2b-GyZ9Zyhc,6
 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/rules.py,sha256=T-yZM9xMtZNZilOdm_go-9gIF3B6pxHS_qsLI_9OsWU,8214
 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-1.1.0.dist-info/licenses/LICENSE,sha256=5nqARgtmPvoIU-1o1az3i8Qi2WOHYIn03vD6haewvEI,1087
+rossum_mcp-1.1.0.dist-info/METADATA,sha256=ItaeeHBcKO7eY4Kpg4XU6Mu0_OOgQjxOw_4NSzEJb-Q,9644
+rossum_mcp-1.1.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+rossum_mcp-1.1.0.dist-info/entry_points.txt,sha256=eth2XELk0QGw9-_H3QL8PQ0OE-RDfzipbSvRy0EUc2c,54
+rossum_mcp-1.1.0.dist-info/top_level.txt,sha256=cziqyWFE89hFhCfsq60Fk6JcwslNtgP01WHIJ5plMEM,11
+rossum_mcp-1.1.0.dist-info/RECORD,,