suprema-biostar-mcp 1.0.1__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 (61) hide show
  1. biostar_x_mcp_server/__init__.py +25 -0
  2. biostar_x_mcp_server/__main__.py +15 -0
  3. biostar_x_mcp_server/config.py +87 -0
  4. biostar_x_mcp_server/handlers/__init__.py +35 -0
  5. biostar_x_mcp_server/handlers/access_handler.py +2162 -0
  6. biostar_x_mcp_server/handlers/audit_handler.py +489 -0
  7. biostar_x_mcp_server/handlers/auth_handler.py +216 -0
  8. biostar_x_mcp_server/handlers/base_handler.py +228 -0
  9. biostar_x_mcp_server/handlers/card_handler.py +746 -0
  10. biostar_x_mcp_server/handlers/device_handler.py +4344 -0
  11. biostar_x_mcp_server/handlers/door_handler.py +3969 -0
  12. biostar_x_mcp_server/handlers/event_handler.py +1331 -0
  13. biostar_x_mcp_server/handlers/file_handler.py +212 -0
  14. biostar_x_mcp_server/handlers/help_web_handler.py +379 -0
  15. biostar_x_mcp_server/handlers/log_handler.py +1051 -0
  16. biostar_x_mcp_server/handlers/navigation_handler.py +109 -0
  17. biostar_x_mcp_server/handlers/occupancy_handler.py +541 -0
  18. biostar_x_mcp_server/handlers/user_handler.py +3568 -0
  19. biostar_x_mcp_server/schemas/__init__.py +21 -0
  20. biostar_x_mcp_server/schemas/access.py +158 -0
  21. biostar_x_mcp_server/schemas/audit.py +73 -0
  22. biostar_x_mcp_server/schemas/auth.py +24 -0
  23. biostar_x_mcp_server/schemas/cards.py +128 -0
  24. biostar_x_mcp_server/schemas/devices.py +496 -0
  25. biostar_x_mcp_server/schemas/doors.py +306 -0
  26. biostar_x_mcp_server/schemas/events.py +104 -0
  27. biostar_x_mcp_server/schemas/files.py +7 -0
  28. biostar_x_mcp_server/schemas/help.py +29 -0
  29. biostar_x_mcp_server/schemas/logs.py +33 -0
  30. biostar_x_mcp_server/schemas/occupancy.py +19 -0
  31. biostar_x_mcp_server/schemas/tool_response.py +29 -0
  32. biostar_x_mcp_server/schemas/users.py +166 -0
  33. biostar_x_mcp_server/server.py +335 -0
  34. biostar_x_mcp_server/session.py +221 -0
  35. biostar_x_mcp_server/tool_manager.py +172 -0
  36. biostar_x_mcp_server/tools/__init__.py +45 -0
  37. biostar_x_mcp_server/tools/access.py +510 -0
  38. biostar_x_mcp_server/tools/audit.py +227 -0
  39. biostar_x_mcp_server/tools/auth.py +59 -0
  40. biostar_x_mcp_server/tools/cards.py +269 -0
  41. biostar_x_mcp_server/tools/categories.py +197 -0
  42. biostar_x_mcp_server/tools/devices.py +1552 -0
  43. biostar_x_mcp_server/tools/doors.py +865 -0
  44. biostar_x_mcp_server/tools/events.py +305 -0
  45. biostar_x_mcp_server/tools/files.py +28 -0
  46. biostar_x_mcp_server/tools/help.py +80 -0
  47. biostar_x_mcp_server/tools/logs.py +123 -0
  48. biostar_x_mcp_server/tools/navigation.py +89 -0
  49. biostar_x_mcp_server/tools/occupancy.py +91 -0
  50. biostar_x_mcp_server/tools/users.py +1113 -0
  51. biostar_x_mcp_server/utils/__init__.py +31 -0
  52. biostar_x_mcp_server/utils/category_mapper.py +206 -0
  53. biostar_x_mcp_server/utils/decorators.py +101 -0
  54. biostar_x_mcp_server/utils/language_detector.py +51 -0
  55. biostar_x_mcp_server/utils/search.py +42 -0
  56. biostar_x_mcp_server/utils/timezone.py +122 -0
  57. suprema_biostar_mcp-1.0.1.dist-info/METADATA +163 -0
  58. suprema_biostar_mcp-1.0.1.dist-info/RECORD +61 -0
  59. suprema_biostar_mcp-1.0.1.dist-info/WHEEL +4 -0
  60. suprema_biostar_mcp-1.0.1.dist-info/entry_points.txt +2 -0
  61. suprema_biostar_mcp-1.0.1.dist-info/licenses/LICENSE +21 -0
@@ -0,0 +1,163 @@
1
+ Metadata-Version: 2.4
2
+ Name: suprema-biostar-mcp
3
+ Version: 1.0.1
4
+ Summary: MCP Server for Suprema BioStar X - Access Control System Integration for AI Assistants
5
+ Project-URL: Homepage, https://www.supremainc.com
6
+ Project-URL: Documentation, https://docs.supremainc.com/en/platform/biostar_x
7
+ Project-URL: Repository, https://github.com/anthropics/mcp-servers
8
+ Author-email: "Suprema Inc." <support@supremainc.com>
9
+ License: MIT
10
+ License-File: LICENSE
11
+ Keywords: access-control,ai-assistant,biostar,claude,mcp,security,suprema
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: MIT License
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Topic :: Security
21
+ Classifier: Topic :: System :: Systems Administration
22
+ Requires-Python: >=3.10
23
+ Requires-Dist: httpx>=0.24.0
24
+ Requires-Dist: mcp>=1.0.0
25
+ Requires-Dist: openpyxl>=3.1.0
26
+ Requires-Dist: psutil>=5.9.0
27
+ Requires-Dist: pydantic>=2.0.0
28
+ Requires-Dist: python-dotenv>=1.0.0
29
+ Requires-Dist: pyyaml>=6.0.1
30
+ Provides-Extra: dev
31
+ Requires-Dist: black>=23.0.0; extra == 'dev'
32
+ Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
33
+ Requires-Dist: pytest>=7.0.0; extra == 'dev'
34
+ Requires-Dist: ruff>=0.1.0; extra == 'dev'
35
+ Description-Content-Type: text/markdown
36
+
37
+ # Suprema BioStar MCP Server
38
+
39
+ MCP (Model Context Protocol) server for **Suprema BioStar X** - Next-generation access control platform integration for AI assistants.
40
+
41
+ > **🚀 One-Click Installation**: `uvx suprema-biostar-mcp`
42
+
43
+ ## Features
44
+
45
+ - **129+ Tools**: Full BioStar X API coverage (users, doors, devices, access control, events, and more)
46
+ - **Lightweight**: No heavy ML dependencies (~50MB vs 900MB)
47
+ - **Live Documentation**: Real-time docs from docs.supremainc.com
48
+ - **Multi-language**: Korean and English support
49
+ - **Easy Setup**: Works with Claude Desktop, Claude Code, and any MCP client
50
+
51
+ ## Quick Start
52
+
53
+ ### 1. Add to Claude Desktop
54
+
55
+ Edit your Claude Desktop config file:
56
+
57
+ - **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
58
+ - **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
59
+
60
+ ```json
61
+ {
62
+ "mcpServers": {
63
+ "suprema-biostar": {
64
+ "command": "uvx",
65
+ "args": ["suprema-biostar-mcp"],
66
+ "env": {
67
+ "BIOSTAR_URL": "https://your-biostar-server.com",
68
+ "BIOSTAR_USERNAME": "admin",
69
+ "BIOSTAR_PASSWORD": "your-password"
70
+ }
71
+ }
72
+ }
73
+ }
74
+ ```
75
+
76
+ ### 2. Restart Claude Desktop
77
+
78
+ That's it! 🎉
79
+
80
+ ## Configuration
81
+
82
+ | Environment Variable | Required | Description |
83
+ |---------------------|----------|-------------|
84
+ | `BIOSTAR_URL` | ✅ | BioStar X server URL (e.g., `https://192.168.1.100`) |
85
+ | `BIOSTAR_USERNAME` | ✅ | Login username |
86
+ | `BIOSTAR_PASSWORD` | ✅ | Login password |
87
+ | `VERIFY_SSL` | ❌ | SSL verification (default: `true`) |
88
+ | `API_TIMEOUT` | ❌ | API timeout in seconds (default: `30`) |
89
+
90
+ ### Changing Credentials
91
+
92
+ 1. Edit `claude_desktop_config.json`
93
+ 2. Update the `env` values
94
+ 3. Restart Claude Desktop
95
+
96
+ ## Available Tools (129+)
97
+
98
+ | Category | Tools | Description |
99
+ |----------|-------|-------------|
100
+ | **auth** | 4 | Login, logout, session management |
101
+ | **users** | 23 | User CRUD, groups, CSV import/export |
102
+ | **doors** | 22 | Door control, groups, APB settings |
103
+ | **access** | 13 | Access groups and levels |
104
+ | **devices** | 38 | Device management, network config |
105
+ | **cards** | 5 | Card creation (CSN, Wiegand, QR) |
106
+ | **events** | 6 | Event search, logs, export |
107
+ | **audit** | 6 | Audit trail tracking |
108
+ | **occupancy** | 2 | Occupancy analysis |
109
+ | **logs** | 5 | Server log analysis |
110
+ | **files** | 1 | File reading (CSV, PDF) |
111
+ | **navigation** | 1 | UI navigation |
112
+ | **help** | 3 | Documentation search |
113
+
114
+ ## Example Usage
115
+
116
+ Once connected to Claude:
117
+
118
+ ```
119
+ "List all users"
120
+ "Create a user named John Smith"
121
+ "Open the main entrance door"
122
+ "Show access events from today"
123
+ "How do I configure anti-passback?"
124
+ ```
125
+
126
+ ## Alternative Installation
127
+
128
+ ### Using pip
129
+
130
+ ```bash
131
+ pip install suprema-biostar-mcp
132
+ suprema-biostar-mcp
133
+ ```
134
+
135
+ ### From source
136
+
137
+ ```bash
138
+ git clone https://github.com/supremainc/suprema-biostar-mcp.git
139
+ cd suprema-biostar-mcp
140
+ pip install -e .
141
+ python -m biostar_x_mcp_server
142
+ ```
143
+
144
+ ## Requirements
145
+
146
+ - Python 3.10+
147
+ - BioStar X server with API access
148
+ - Network connectivity to BioStar server
149
+ - [uv](https://docs.astral.sh/uv/) for `uvx` command (recommended)
150
+
151
+ ## Documentation
152
+
153
+ - **BioStar X Docs**: https://docs.supremainc.com/en/platform/biostar_x
154
+ - **MCP Protocol**: https://modelcontextprotocol.io
155
+
156
+ ## Support
157
+
158
+ - **Suprema Support**: https://www.supremainc.com/support
159
+ - **Documentation**: https://docs.supremainc.com
160
+
161
+ ---
162
+
163
+ Made with ❤️ by [Suprema Inc.](https://www.supremainc.com)
@@ -0,0 +1,61 @@
1
+ biostar_x_mcp_server/__init__.py,sha256=c0-TimXKCB0Y8DZNxqB1p6K5ls4Lur57nULBmjfoVaI,564
2
+ biostar_x_mcp_server/__main__.py,sha256=PE7VsJJ8S7_WdFlp2cmXK7DCxR8biXCyHTgwS6HcW-0,333
3
+ biostar_x_mcp_server/config.py,sha256=e0JSYTOxSFW3IsE3ychc20tBJqPv0K513y-J3uFd3Rs,2830
4
+ biostar_x_mcp_server/server.py,sha256=pLaqOnwYsVBs3yLNvkiGu1f2DVH5fo-ZKJUj_XHYBC0,12150
5
+ biostar_x_mcp_server/session.py,sha256=glMu4B5GxhzQ9Qrx1ixrNzykbYOBOHEGlpFz5plm4Dk,8132
6
+ biostar_x_mcp_server/tool_manager.py,sha256=KQoud2RreGY3vvFvcZAu0yhwqqAmYzX180jL_Nw6EAo,6268
7
+ biostar_x_mcp_server/handlers/__init__.py,sha256=fZzjY6lLyfMeaT2DPemFzZzpTbpD_8cjIvUIA_kEHOU,988
8
+ biostar_x_mcp_server/handlers/access_handler.py,sha256=pnqSb1KE_z5HIE9nSH05XCkWqAAdNlkXc3LR93DTy0Q,102782
9
+ biostar_x_mcp_server/handlers/audit_handler.py,sha256=TqDhqJ71pJQrhXJQOG9bqAdzSo3pQtcdTbhfeYDQKcY,20190
10
+ biostar_x_mcp_server/handlers/auth_handler.py,sha256=OpgAc8WEz-H7I1nrLJiq7P2JKox9ZnR9b9Sfx7QQP9g,9657
11
+ biostar_x_mcp_server/handlers/base_handler.py,sha256=kq-xiR51nqCZqqrlHVVMFpk1d5Jt2nnKfcSRdh5EDGI,8906
12
+ biostar_x_mcp_server/handlers/card_handler.py,sha256=-FirNW38f5NMipEQGKH2r9JjIUM95JrUS3urjj9SIYE,30958
13
+ biostar_x_mcp_server/handlers/device_handler.py,sha256=w7xqxUcJlCJdyiD5_s7pn9xVGeBJwtGT03oyodMIt0A,194686
14
+ biostar_x_mcp_server/handlers/door_handler.py,sha256=K30varhRDcK0c_FjYDrtGinLZdoI0Q8kl0-3HyRRggk,181109
15
+ biostar_x_mcp_server/handlers/event_handler.py,sha256=DYLqgxxBXOzaCaCNKkydjb8ewoFyy_OZX5eYM72Xc0A,60972
16
+ biostar_x_mcp_server/handlers/file_handler.py,sha256=SsrH8MsWZAyXGiWcj8_T14jnNVxKBKXnyXNarTlrJJo,8930
17
+ biostar_x_mcp_server/handlers/help_web_handler.py,sha256=bsUtAJO6-gVFVGfLly2mwKCQpH8EqqqMGSf12K4jAXE,15704
18
+ biostar_x_mcp_server/handlers/log_handler.py,sha256=HLn54xVu6WAkZ2BPGj7Uq3w_0sys0bEUDmOiuGksIpM,49184
19
+ biostar_x_mcp_server/handlers/navigation_handler.py,sha256=gA9sKVsEOcLCBY8NG97XYgWRdphJp0InCut-8KE9szs,4047
20
+ biostar_x_mcp_server/handlers/occupancy_handler.py,sha256=z-vP70KRkDbVZ1lNskcWfCb6r2Uy-htIYTKVIbW4pu8,26843
21
+ biostar_x_mcp_server/handlers/user_handler.py,sha256=ZHN9Sf0qwgTF7D8RcKGGQAmtNIyYqRv52BPRESMSaXM,169961
22
+ biostar_x_mcp_server/schemas/__init__.py,sha256=rUkCWWp-Hf7lZMx4Z8T-K_ydPGuKIrnVWEqDwbO6U9g,451
23
+ biostar_x_mcp_server/schemas/access.py,sha256=KM91sITs0YGeCkywkG9ayUK-dBbWmzixVKwKQXvLRzI,9485
24
+ biostar_x_mcp_server/schemas/audit.py,sha256=P_Cqc87uVduQoGcdOBAZSihIbVOq_s5HT4o5TGFeBP8,4163
25
+ biostar_x_mcp_server/schemas/auth.py,sha256=Dm9xcCvkJve1TvKtAz1w3gclc4r84ORbgkZOKLily_Y,768
26
+ biostar_x_mcp_server/schemas/cards.py,sha256=aAq0wI89RSSWaY9e1AT7r9K5s0d7ldUNlQYbJ-v4g8I,5963
27
+ biostar_x_mcp_server/schemas/devices.py,sha256=GQKlM28W19OOH58hOYK_HOpabZlyz6BF-eFLevbQNj8,32585
28
+ biostar_x_mcp_server/schemas/doors.py,sha256=wPBaCPvBDf5PFHaRDqLxudYgO5JNtQhwQ0BE6KQLnpY,19746
29
+ biostar_x_mcp_server/schemas/events.py,sha256=jrxLzj_Txx23e6ntwoZsB89NMKtYy0oe8RrkeTx5XNk,8100
30
+ biostar_x_mcp_server/schemas/files.py,sha256=qkOcgNH4fh2pcFkTKT9R2PZp26oqY3tTQqnkyunXj2w,239
31
+ biostar_x_mcp_server/schemas/help.py,sha256=BwIjY75XjuaEFZYTg807a5i_8EYfva9EFqCXoYDB0Ls,1632
32
+ biostar_x_mcp_server/schemas/logs.py,sha256=w_qpuzDYmazba-niUT04ltCDogJwIi9uulqKk31W4mE,1973
33
+ biostar_x_mcp_server/schemas/occupancy.py,sha256=K3rDin05SiGuVFrPZd8Cx6PWgcxJFBFdIoHtzvhfiMA,1095
34
+ biostar_x_mcp_server/schemas/tool_response.py,sha256=THGJuTC9zgDisVUYyhF1xB_jffoUqOVlnD-rJCBGCWE,1190
35
+ biostar_x_mcp_server/schemas/users.py,sha256=73QLF60BkgKNjt4jxGDtY1EJFr0PIBJBw0D5T2fnlQ8,11989
36
+ biostar_x_mcp_server/tools/__init__.py,sha256=HcQKVOTtyoNJTvAdqktSgOCTuHkViuOxQsy7S0NkaGM,1053
37
+ biostar_x_mcp_server/tools/access.py,sha256=kiipY9doDB7WDOtVfwmLcT7R1nUbMi0JIRVwpI_wx5M,20389
38
+ biostar_x_mcp_server/tools/audit.py,sha256=uyv7iE2rftLEQdC1Wsx7T6-Vn0JdrfbI3jKowYPLX1Q,7668
39
+ biostar_x_mcp_server/tools/auth.py,sha256=biFMcnjKzZIP-zWOvrf8pVnem-yY2b5TYZZa3wOckj0,2634
40
+ biostar_x_mcp_server/tools/cards.py,sha256=wXrnJMXAezyhuMHKPe_mTsoiEUDzqBrWXS0tDislAK8,11689
41
+ biostar_x_mcp_server/tools/categories.py,sha256=tUM7By7qux3us1cMTwc6BTbY3W9K3jIVqL_VT4-oYKY,6085
42
+ biostar_x_mcp_server/tools/devices.py,sha256=Lq-KkzKlYoq2sE41kP5L61Hm_HR47JBuwaRBs6__ekk,63972
43
+ biostar_x_mcp_server/tools/doors.py,sha256=szT_OIWHKBUyXbd55M9jKSdbipB_Of-b3aeB5ONX9dY,36999
44
+ biostar_x_mcp_server/tools/events.py,sha256=ndY2bK23DaGhLT25pt6KfRKVjK-bHAOC-SGdVkJW20g,13012
45
+ biostar_x_mcp_server/tools/files.py,sha256=zCCQ1bupYalWcXvR8bzSEGe7eKwiBXlj_O6Q0JfDYgY,1064
46
+ biostar_x_mcp_server/tools/help.py,sha256=M1pfZu_fdLlcLqs-kKXtbmt10bgow6Fx-efuBpkaBHE,2853
47
+ biostar_x_mcp_server/tools/logs.py,sha256=5YF1bkpCcyJJm-LdpElFI_j3TrsxxIuySrZU0Io8Biw,5325
48
+ biostar_x_mcp_server/tools/navigation.py,sha256=bRQREsi9Vm18d7svZKVjUkyeADKRCswvuQIYsUm2gMc,3794
49
+ biostar_x_mcp_server/tools/occupancy.py,sha256=wi5rZ6LZmTH_j13dmmqpc_kA2G2THAz-tdppG4WZIsc,2793
50
+ biostar_x_mcp_server/tools/users.py,sha256=LiMvqBLqcAvYgk4aosh0-3nE2U1yldkVtebYrbvWbTY,46733
51
+ biostar_x_mcp_server/utils/__init__.py,sha256=1XCi0dnqrF80q72oC75tqi65MEZV5ldRTUgIezYYcKM,655
52
+ biostar_x_mcp_server/utils/category_mapper.py,sha256=FQtwojzdFtiYmykvmosIdbIr8dg7me_iHUzQxGvZkJE,7731
53
+ biostar_x_mcp_server/utils/decorators.py,sha256=p8Zh6HwuP80sA0o_2B1rYG3H9o_5kki2SgLwqyWnizw,3092
54
+ biostar_x_mcp_server/utils/language_detector.py,sha256=gO4jSbHFl3QpWwXOJxcLCnHzxq_MGyGoccWNtbHsFcc,1465
55
+ biostar_x_mcp_server/utils/search.py,sha256=Wum130sIeEpMLhHJsUINd56vUYUDtSCQ8SJX02GSKl0,1332
56
+ biostar_x_mcp_server/utils/timezone.py,sha256=vB3EcAd1ExopRiMOmyp2FqxAF8UcfmhxNfJ_Nc1NyWM,4743
57
+ suprema_biostar_mcp-1.0.1.dist-info/METADATA,sha256=K0ry1q3ju8xLUQ_GxgKESogntSPECm_wK4DZinWykpU,4868
58
+ suprema_biostar_mcp-1.0.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
59
+ suprema_biostar_mcp-1.0.1.dist-info/entry_points.txt,sha256=DX5MSXxdgiFbE6Aezg3DcMXojUv3QWkq1U_9FZzKHG4,73
60
+ suprema_biostar_mcp-1.0.1.dist-info/licenses/LICENSE,sha256=QqZFelJ6EKRm0vB1AIZ5yKKA4HryNm0FfUlvq5o4LzY,1090
61
+ suprema_biostar_mcp-1.0.1.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.28.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ suprema-biostar-mcp = biostar_x_mcp_server.server:main
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Suprema Inc.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.