sapwebguimcp 0.20.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (174) hide show
  1. _sapwebguimcp_version.py +1 -0
  2. sapwebguimcp/__init__.py +38 -0
  3. sapwebguimcp/backend/__init__.py +19 -0
  4. sapwebguimcp/backend/manager.py +87 -0
  5. sapwebguimcp/backend/webgui/__init__.py +1 -0
  6. sapwebguimcp/backend/webgui/backend.py +1685 -0
  7. sapwebguimcp/backend/webgui/browser.py +571 -0
  8. sapwebguimcp/backend/webgui/chrome_finder.py +212 -0
  9. sapwebguimcp/backend/webgui/js/__init__.py +1 -0
  10. sapwebguimcp/backend/webgui/js/check_field_type.js +129 -0
  11. sapwebguimcp/backend/webgui/js/check_popup.js +164 -0
  12. sapwebguimcp/backend/webgui/js/click_table_cell.js +127 -0
  13. sapwebguimcp/backend/webgui/js/detect_form_fields.js +126 -0
  14. sapwebguimcp/backend/webgui/js/discover_buttons.js +81 -0
  15. sapwebguimcp/backend/webgui/js/discover_fields.js +158 -0
  16. sapwebguimcp/backend/webgui/js/extract_sap_user.js +26 -0
  17. sapwebguimcp/backend/webgui/js/extract_screen_info.js +41 -0
  18. sapwebguimcp/backend/webgui/js/extract_screen_text.js +86 -0
  19. sapwebguimcp/backend/webgui/js/extract_status_bar.js +150 -0
  20. sapwebguimcp/backend/webgui/js/extract_table_data.js +264 -0
  21. sapwebguimcp/backend/webgui/js/fill_form_fields.js +112 -0
  22. sapwebguimcp/backend/webgui/js/find_field_utils.js +226 -0
  23. sapwebguimcp/backend/webgui/js/find_main_input.js +61 -0
  24. sapwebguimcp/backend/webgui/js/get_dropdown_options.js +87 -0
  25. sapwebguimcp/backend/webgui/js/read_se16n_selection_rows.js +112 -0
  26. sapwebguimcp/backend/webgui/js/select_dropdown_option.js +148 -0
  27. sapwebguimcp/backend/webgui/js/set_field.js +103 -0
  28. sapwebguimcp/backend/webgui/js/set_language_field.js +17 -0
  29. sapwebguimcp/backend/webgui/js/set_okcode_field.js +16 -0
  30. sapwebguimcp/backend/webgui/js/wait_for_sap_ready.js +18 -0
  31. sapwebguimcp/backend/webgui/js_helpers.py +42 -0
  32. sapwebguimcp/backend/webgui/models/__init__.py +0 -0
  33. sapwebguimcp/backend/webgui/models/browser_results.py +83 -0
  34. sapwebguimcp/backend/webgui/models/session_registry.py +279 -0
  35. sapwebguimcp/backend/webgui/parsers/__init__.py +23 -0
  36. sapwebguimcp/backend/webgui/parsers/screen_state_parser.py +129 -0
  37. sapwebguimcp/backend/webgui/parsers/se09_parser.py +207 -0
  38. sapwebguimcp/backend/webgui/parsers/se16_parser.py +309 -0
  39. sapwebguimcp/backend/webgui/parsers/se24_parser.py +335 -0
  40. sapwebguimcp/backend/webgui/parsers/se37_parser.py +282 -0
  41. sapwebguimcp/backend/webgui/parsers/se93_parser.py +188 -0
  42. sapwebguimcp/backend/webgui/parsers/slg1_parser.py +302 -0
  43. sapwebguimcp/backend/webgui/parsers/sm30_parser.py +332 -0
  44. sapwebguimcp/backend/webgui/parsers/sm37_parser.py +233 -0
  45. sapwebguimcp/backend/webgui/parsers/spro_parser.py +175 -0
  46. sapwebguimcp/backend/webgui/parsers/st22_parser.py +507 -0
  47. sapwebguimcp/backend/webgui/types.py +12 -0
  48. sapwebguimcp/backend/webgui/utils.py +61 -0
  49. sapwebguimcp/catalog/__init__.py +78 -0
  50. sapwebguimcp/catalog/loader.py +114 -0
  51. sapwebguimcp/catalog/models.py +528 -0
  52. sapwebguimcp/catalog/scraper.py +440 -0
  53. sapwebguimcp/catalog/search.py +218 -0
  54. sapwebguimcp/classcatalog/__init__.py +17 -0
  55. sapwebguimcp/classcatalog/loader.py +66 -0
  56. sapwebguimcp/classcatalog/models.py +36 -0
  57. sapwebguimcp/classcatalog/search.py +83 -0
  58. sapwebguimcp/data/__init__.py +1 -0
  59. sapwebguimcp/data/classes.json +20 -0
  60. sapwebguimcp/data/function_modules.json +27152 -0
  61. sapwebguimcp/data/sap_field_registry.json +98 -0
  62. sapwebguimcp/data/sap_knowledge.md +399 -0
  63. sapwebguimcp/data/tables.json +4311 -0
  64. sapwebguimcp/data/transactions.json +58824 -0
  65. sapwebguimcp/demo/__init__.py +0 -0
  66. sapwebguimcp/demo/render_readme_demo.py +510 -0
  67. sapwebguimcp/fmcatalog/__init__.py +17 -0
  68. sapwebguimcp/fmcatalog/loader.py +66 -0
  69. sapwebguimcp/fmcatalog/models.py +80 -0
  70. sapwebguimcp/fmcatalog/search.py +108 -0
  71. sapwebguimcp/lang/ADDING_A_LANGUAGE.md +128 -0
  72. sapwebguimcp/lang/__init__.py +205 -0
  73. sapwebguimcp/lang/backends.py +235 -0
  74. sapwebguimcp/lang/de.py +309 -0
  75. sapwebguimcp/lang/en.py +299 -0
  76. sapwebguimcp/lang/invariant.py +45 -0
  77. sapwebguimcp/lang/it.py +346 -0
  78. sapwebguimcp/lang/schema.py +570 -0
  79. sapwebguimcp/lang/sources.py +326 -0
  80. sapwebguimcp/lang/text.py +366 -0
  81. sapwebguimcp/logging_config.py +262 -0
  82. sapwebguimcp/loghandlers/__init__.py +5 -0
  83. sapwebguimcp/loghandlers/feedback_issue_handler.py +247 -0
  84. sapwebguimcp/mcp_session.py +43 -0
  85. sapwebguimcp/middleware/__init__.py +5 -0
  86. sapwebguimcp/middleware/logging.py +232 -0
  87. sapwebguimcp/models/README.md +106 -0
  88. sapwebguimcp/models/__init__.py +296 -0
  89. sapwebguimcp/models/abapgit_models.py +128 -0
  90. sapwebguimcp/models/alv_models.py +38 -0
  91. sapwebguimcp/models/base.py +144 -0
  92. sapwebguimcp/models/config.py +309 -0
  93. sapwebguimcp/models/intent_models.py +68 -0
  94. sapwebguimcp/models/middleware.py +139 -0
  95. sapwebguimcp/models/quick_report_models.py +51 -0
  96. sapwebguimcp/models/sap_results.py +538 -0
  97. sapwebguimcp/models/screen_state.py +82 -0
  98. sapwebguimcp/models/se09_models.py +59 -0
  99. sapwebguimcp/models/se11_models.py +81 -0
  100. sapwebguimcp/models/se16_models.py +63 -0
  101. sapwebguimcp/models/se24_edit_models.py +15 -0
  102. sapwebguimcp/models/se24_models.py +228 -0
  103. sapwebguimcp/models/se37_edit_models.py +14 -0
  104. sapwebguimcp/models/se37_models.py +89 -0
  105. sapwebguimcp/models/se38_edit_models.py +15 -0
  106. sapwebguimcp/models/se93_models.py +79 -0
  107. sapwebguimcp/models/slg1_models.py +55 -0
  108. sapwebguimcp/models/sm30_models.py +67 -0
  109. sapwebguimcp/models/sm37_models.py +53 -0
  110. sapwebguimcp/models/spro_models.py +51 -0
  111. sapwebguimcp/models/st22_models.py +58 -0
  112. sapwebguimcp/prompts/README.md +63 -0
  113. sapwebguimcp/prompts/__init__.py +138 -0
  114. sapwebguimcp/prompts/abapgit_workflow.md +144 -0
  115. sapwebguimcp/prompts/create_business_partner.md +174 -0
  116. sapwebguimcp/prompts/explore_class.md +65 -0
  117. sapwebguimcp/prompts/explore_function_module.md +74 -0
  118. sapwebguimcp/prompts/explore_table.md +82 -0
  119. sapwebguimcp/prompts/se16_bulk_read.md +89 -0
  120. sapwebguimcp/resources/__init__.py +6 -0
  121. sapwebguimcp/resources/feedback_resource.py +35 -0
  122. sapwebguimcp/resources/intent_resource.py +30 -0
  123. sapwebguimcp/server.py +346 -0
  124. sapwebguimcp/session_language.py +91 -0
  125. sapwebguimcp/skills/README.md +256 -0
  126. sapwebguimcp/skills/__init__.py +13 -0
  127. sapwebguimcp/skills/examples/create_business_partner_bp.md +221 -0
  128. sapwebguimcp/skills/examples/create_contract_account_caa1.md +221 -0
  129. sapwebguimcp/skills/examples/general_navigation.md +154 -0
  130. sapwebguimcp/skills/examples/monitor_process_documents_idxgc.md +242 -0
  131. sapwebguimcp/tables/__init__.py +39 -0
  132. sapwebguimcp/tables/loader.py +71 -0
  133. sapwebguimcp/tables/models.py +47 -0
  134. sapwebguimcp/tables/scraper.py +245 -0
  135. sapwebguimcp/tables/search.py +114 -0
  136. sapwebguimcp/tools/README.md +331 -0
  137. sapwebguimcp/tools/__init__.py +73 -0
  138. sapwebguimcp/tools/abapgit_tools.py +1501 -0
  139. sapwebguimcp/tools/browser_tools.py +550 -0
  140. sapwebguimcp/tools/catalog_tools.py +156 -0
  141. sapwebguimcp/tools/class_tools.py +115 -0
  142. sapwebguimcp/tools/confirmation_helpers.py +111 -0
  143. sapwebguimcp/tools/edit_helpers.py +37 -0
  144. sapwebguimcp/tools/feedback_tools.py +203 -0
  145. sapwebguimcp/tools/field_helpers.py +208 -0
  146. sapwebguimcp/tools/fm_tools.py +158 -0
  147. sapwebguimcp/tools/intent_tools.py +82 -0
  148. sapwebguimcp/tools/quick_report_tools.py +404 -0
  149. sapwebguimcp/tools/sap_list_connections_impl.py +76 -0
  150. sapwebguimcp/tools/sap_login_impl.py +88 -0
  151. sapwebguimcp/tools/sap_tools.py +1724 -0
  152. sapwebguimcp/tools/screen_state_helpers.py +151 -0
  153. sapwebguimcp/tools/se09_tools.py +422 -0
  154. sapwebguimcp/tools/se11_tools.py +544 -0
  155. sapwebguimcp/tools/se16_tools.py +890 -0
  156. sapwebguimcp/tools/se24_edit_tools.py +286 -0
  157. sapwebguimcp/tools/se24_tools.py +263 -0
  158. sapwebguimcp/tools/se37_edit_tools.py +230 -0
  159. sapwebguimcp/tools/se37_tools.py +224 -0
  160. sapwebguimcp/tools/se38_edit_tools.py +234 -0
  161. sapwebguimcp/tools/se93_tools.py +190 -0
  162. sapwebguimcp/tools/session_tools.py +221 -0
  163. sapwebguimcp/tools/slg1_tools.py +263 -0
  164. sapwebguimcp/tools/sm30_tools.py +247 -0
  165. sapwebguimcp/tools/sm37_tools.py +340 -0
  166. sapwebguimcp/tools/spro_tools.py +325 -0
  167. sapwebguimcp/tools/st22_tools.py +438 -0
  168. sapwebguimcp/tools/table_tools.py +138 -0
  169. sapwebguimcp/utils.py +251 -0
  170. sapwebguimcp-0.20.2.dist-info/METADATA +696 -0
  171. sapwebguimcp-0.20.2.dist-info/RECORD +174 -0
  172. sapwebguimcp-0.20.2.dist-info/WHEEL +4 -0
  173. sapwebguimcp-0.20.2.dist-info/entry_points.txt +2 -0
  174. sapwebguimcp-0.20.2.dist-info/licenses/LICENSE +21 -0
@@ -0,0 +1 @@
1
+ version = "0.20.2"
@@ -0,0 +1,38 @@
1
+ """
2
+ SAP Web GUI MCP Server - Browser automation for SAP Web GUI via Model Context Protocol.
3
+
4
+ This package provides an MCP server that enables Claude and other AI assistants
5
+ to interact with SAP Web GUI through browser automation.
6
+
7
+ Example usage with Claude Code:
8
+ 1. Configure the MCP server in your claude settings
9
+ 2. Ask Claude to login to SAP and run transactions
10
+
11
+ For extending with new tools, see: src/sapwebguimcp/server.py
12
+ For creating skills, see: src/sapwebguimcp/skills/README.md
13
+ """
14
+
15
+ from typing import TYPE_CHECKING
16
+
17
+ __version__ = "0.1.0"
18
+
19
+ # Lazy imports to avoid RuntimeWarning when running `python -m sapwebguimcp.server`
20
+ # The warning occurs because __init__.py imports server before runpy executes it as __main__
21
+ if TYPE_CHECKING:
22
+ from sapwebguimcp.server import main, mcp
23
+
24
+
25
+ def __getattr__(name: str) -> object:
26
+ """Lazy import for main and mcp to avoid early server import."""
27
+ if name in ("main", "mcp"):
28
+ # Import inside function to defer loading until actually needed.
29
+ # If we import at module level, running `python -m sapwebguimcp.server`
30
+ # causes a RuntimeWarning because this __init__.py loads server.py
31
+ # BEFORE runpy can execute it as __main__.
32
+ from sapwebguimcp import server # pylint: disable=import-outside-toplevel
33
+
34
+ return getattr(server, name)
35
+ raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
36
+
37
+
38
+ __all__ = ["main", "mcp", "__version__"]
@@ -0,0 +1,19 @@
1
+ """Backend abstraction layer for SAP UI interaction."""
2
+
3
+ from sapwebguimcp.backend.manager import (
4
+ close_backend,
5
+ get_backend,
6
+ get_backend_manager,
7
+ reset_backend_manager,
8
+ )
9
+ from sapwebguimcp.backend.webgui.types import AriaSnapshot
10
+ from sapwebguimcp.models.base import CheckActivateResult
11
+
12
+ __all__ = [
13
+ "AriaSnapshot",
14
+ "CheckActivateResult",
15
+ "close_backend",
16
+ "get_backend",
17
+ "get_backend_manager",
18
+ "reset_backend_manager",
19
+ ]
@@ -0,0 +1,87 @@
1
+ """Backend manager — singleton entry point for tools."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import logging
6
+
7
+ from sapwebguimcp.backend.webgui.backend import WebGuiBackend
8
+ from sapwebguimcp.backend.webgui.browser import close_browser_manager, get_browser_manager
9
+ from sapwebguimcp.session_language import set_session_language
10
+
11
+ logger = logging.getLogger(__name__)
12
+
13
+
14
+ class BackendManager: # pylint: disable=too-few-public-methods
15
+ """Manages WebGUI backend instances across sessions."""
16
+
17
+ def __init__(self) -> None:
18
+ self._backends: dict[str, WebGuiBackend] = {} # Cache by session ID
19
+ self._page_ids: dict[str, int] = {} # Track page identity for cache invalidation
20
+
21
+ async def get_or_create(
22
+ self,
23
+ session: str | None = None,
24
+ agent_id: str | None = None,
25
+ tool_name: str = "",
26
+ ) -> WebGuiBackend:
27
+ """Get or create the WebGUI backend instance for the given session.
28
+
29
+ Caches WebGuiBackend instances by session ID. Returns cached instance
30
+ if the underlying page is still the same, creates a new one otherwise.
31
+ """
32
+ browser_manager = await get_browser_manager()
33
+ page = await browser_manager.get_or_create_session_page_checked(session, agent_id, tool_name)
34
+ session_key = session or browser_manager.registry.primary_session
35
+ # Same registry WebGuiBackend._get_registry() records the language in.
36
+ set_session_language(browser_manager.registry.language_of(session_key))
37
+ cached = self._backends.get(session_key)
38
+ if cached is not None and self._page_ids.get(session_key) == id(page):
39
+ return cached
40
+ backend = WebGuiBackend(page)
41
+ self._backends[session_key] = backend
42
+ self._page_ids[session_key] = id(page)
43
+ return backend
44
+
45
+ async def close(self) -> None:
46
+ """Shut down the browser and release resources."""
47
+ await close_browser_manager()
48
+ self._backends.clear()
49
+ self._page_ids.clear()
50
+
51
+
52
+ # -- Singleton --
53
+
54
+ _backend_manager: BackendManager | None = None # pylint: disable=invalid-name
55
+
56
+
57
+ def get_backend_manager() -> BackendManager:
58
+ """Get the global BackendManager singleton (lazy init)."""
59
+ global _backend_manager # noqa: PLW0603 # pylint: disable=global-statement
60
+ if _backend_manager is None:
61
+ _backend_manager = BackendManager()
62
+ return _backend_manager
63
+
64
+
65
+ async def get_backend(
66
+ session: str | None = None,
67
+ agent_id: str | None = None,
68
+ tool_name: str = "",
69
+ ) -> WebGuiBackend:
70
+ """Convenience: get a backend instance for the given session.
71
+
72
+ This is the primary entry point for all tools.
73
+ """
74
+ manager = get_backend_manager()
75
+ return await manager.get_or_create(session, agent_id, tool_name)
76
+
77
+
78
+ async def close_backend() -> None:
79
+ """Shut down the active backend (called during server shutdown)."""
80
+ if _backend_manager is not None:
81
+ await _backend_manager.close()
82
+
83
+
84
+ def reset_backend_manager() -> None:
85
+ """Reset the singleton (for testing)."""
86
+ global _backend_manager # noqa: PLW0603 # pylint: disable=global-statement
87
+ _backend_manager = None
@@ -0,0 +1 @@
1
+ """WebGUI backend implementation using Playwright/CDP."""