ciso-assistant-api 0.1.0__tar.gz

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 (81) hide show
  1. ciso_assistant_api-0.1.0/LICENSE +21 -0
  2. ciso_assistant_api-0.1.0/MANIFEST.in +4 -0
  3. ciso_assistant_api-0.1.0/PKG-INFO +223 -0
  4. ciso_assistant_api-0.1.0/README.md +193 -0
  5. ciso_assistant_api-0.1.0/ciso_assistant_api/__init__.py +63 -0
  6. ciso_assistant_api-0.1.0/ciso_assistant_api/__main__.py +5 -0
  7. ciso_assistant_api-0.1.0/ciso_assistant_api/agent/AGENTS.md +12 -0
  8. ciso_assistant_api-0.1.0/ciso_assistant_api/agent/CRON.md +12 -0
  9. ciso_assistant_api-0.1.0/ciso_assistant_api/agent/CRON_LOG.md +5 -0
  10. ciso_assistant_api-0.1.0/ciso_assistant_api/agent/HEARTBEAT.md +28 -0
  11. ciso_assistant_api-0.1.0/ciso_assistant_api/agent/IDENTITY.md +15 -0
  12. ciso_assistant_api-0.1.0/ciso_assistant_api/agent/MCP_AGENTS.md +13 -0
  13. ciso_assistant_api-0.1.0/ciso_assistant_api/agent/USER.md +7 -0
  14. ciso_assistant_api-0.1.0/ciso_assistant_api/agent/icon.png +0 -0
  15. ciso_assistant_api-0.1.0/ciso_assistant_api/agent/mcp_config.json +39 -0
  16. ciso_assistant_api-0.1.0/ciso_assistant_api/agent_server.py +85 -0
  17. ciso_assistant_api-0.1.0/ciso_assistant_api/api/__init__.py +1 -0
  18. ciso_assistant_api-0.1.0/ciso_assistant_api/api/_operation_manifest.py +14117 -0
  19. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_analytics_metrology.py +962 -0
  20. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_assets.py +532 -0
  21. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_auth_users.py +673 -0
  22. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_base.py +301 -0
  23. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_chat.py +822 -0
  24. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_compliance.py +2573 -0
  25. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_crq.py +621 -0
  26. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_ebios_rm.py +1549 -0
  27. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_evidence.py +897 -0
  28. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_frameworks_libraries.py +1276 -0
  29. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_governance.py +1312 -0
  30. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_incidents.py +397 -0
  31. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_integrations.py +647 -0
  32. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_privacy.py +1445 -0
  33. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_resilience.py +1867 -0
  34. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_risk_management.py +1637 -0
  35. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_security_findings.py +764 -0
  36. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_settings.py +435 -0
  37. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_tasks_timeline.py +867 -0
  38. ciso_assistant_api-0.1.0/ciso_assistant_api/api/api_client_third_party.py +1119 -0
  39. ciso_assistant_api-0.1.0/ciso_assistant_api/api_client.py +56 -0
  40. ciso_assistant_api-0.1.0/ciso_assistant_api/auth.py +85 -0
  41. ciso_assistant_api-0.1.0/ciso_assistant_api/ciso_assistant_models.py +44 -0
  42. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/__init__.py +84 -0
  43. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_analytics_metrology.py +206 -0
  44. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_assets.py +122 -0
  45. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_auth_users.py +148 -0
  46. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_chat.py +176 -0
  47. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_compliance.py +486 -0
  48. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_crq.py +174 -0
  49. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_custom_api.py +47 -0
  50. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_ebios_rm.py +294 -0
  51. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_evidence.py +182 -0
  52. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_frameworks_libraries.py +244 -0
  53. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_governance.py +242 -0
  54. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_incidents.py +102 -0
  55. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_integrations.py +144 -0
  56. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_privacy.py +272 -0
  57. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_resilience.py +443 -0
  58. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_risk_management.py +294 -0
  59. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_security_findings.py +158 -0
  60. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_settings.py +118 -0
  61. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_tasks_timeline.py +172 -0
  62. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp/mcp_third_party.py +214 -0
  63. ciso_assistant_api-0.1.0/ciso_assistant_api/mcp_server.py +78 -0
  64. ciso_assistant_api-0.1.0/ciso_assistant_api/specs/ciso_assistant.json +1 -0
  65. ciso_assistant_api-0.1.0/ciso_assistant_api.egg-info/PKG-INFO +223 -0
  66. ciso_assistant_api-0.1.0/ciso_assistant_api.egg-info/SOURCES.txt +79 -0
  67. ciso_assistant_api-0.1.0/ciso_assistant_api.egg-info/dependency_links.txt +1 -0
  68. ciso_assistant_api-0.1.0/ciso_assistant_api.egg-info/entry_points.txt +3 -0
  69. ciso_assistant_api-0.1.0/ciso_assistant_api.egg-info/requires.txt +18 -0
  70. ciso_assistant_api-0.1.0/ciso_assistant_api.egg-info/top_level.txt +6 -0
  71. ciso_assistant_api-0.1.0/pyproject.toml +59 -0
  72. ciso_assistant_api-0.1.0/requirements.txt +5 -0
  73. ciso_assistant_api-0.1.0/scripts/generate_from_openapi.py +478 -0
  74. ciso_assistant_api-0.1.0/setup.cfg +4 -0
  75. ciso_assistant_api-0.1.0/tests/__init__.py +0 -0
  76. ciso_assistant_api-0.1.0/tests/conftest.py +40 -0
  77. ciso_assistant_api-0.1.0/tests/test_auth.py +42 -0
  78. ciso_assistant_api-0.1.0/tests/test_ciso_assistant_brute_force_coverage.py +107 -0
  79. ciso_assistant_api-0.1.0/tests/test_ciso_assistant_coverage.py +84 -0
  80. ciso_assistant_api-0.1.0/tests/test_mcp_server.py +32 -0
  81. ciso_assistant_api-0.1.0/tests/test_startup.py +35 -0
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Audel Rouhi
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.
@@ -0,0 +1,4 @@
1
+ include LICENSE
2
+ include README.md
3
+ include requirements.txt
4
+ recursive-include ciso_assistant_api *.md *.json *.yaml *.yml *.py
@@ -0,0 +1,223 @@
1
+ Metadata-Version: 2.4
2
+ Name: ciso-assistant-api
3
+ Version: 0.1.0
4
+ Summary: CISO Assistant API + MCP Server + A2A Agent — 100% API coverage
5
+ Author-email: Audel Rouhi <knucklessg1@gmail.com>
6
+ License: MIT
7
+ Classifier: Development Status :: 4 - Beta
8
+ Classifier: License :: OSI Approved :: MIT License
9
+ Classifier: Environment :: Console
10
+ Classifier: Operating System :: POSIX :: Linux
11
+ Classifier: Programming Language :: Python :: 3
12
+ Requires-Python: <3.15,>=3.11
13
+ Description-Content-Type: text/markdown
14
+ License-File: LICENSE
15
+ Requires-Dist: agent-utilities>=0.51.0
16
+ Requires-Dist: python-dotenv>=1.0.0
17
+ Requires-Dist: requests>=2.32.0
18
+ Provides-Extra: mcp
19
+ Requires-Dist: agent-utilities[mcp]>=0.51.0; extra == "mcp"
20
+ Provides-Extra: agent
21
+ Requires-Dist: agent-utilities[agent,logfire]>=0.51.0; extra == "agent"
22
+ Provides-Extra: all
23
+ Requires-Dist: ciso-assistant-api[agent,mcp]>=0.1.0; extra == "all"
24
+ Provides-Extra: test
25
+ Requires-Dist: pytest-xdist>=3.6.0; extra == "test"
26
+ Requires-Dist: pytest; extra == "test"
27
+ Requires-Dist: pytest-asyncio; extra == "test"
28
+ Requires-Dist: pytest-cov; extra == "test"
29
+ Dynamic: license-file
30
+
31
+ # CISO Assistant - A2A | AG-UI | MCP
32
+
33
+ ![PyPI - Version](https://img.shields.io/pypi/v/ciso-assistant-api)
34
+ ![MCP Server](https://badge.mcpx.dev?type=server 'MCP Server')
35
+ ![PyPI - Downloads](https://img.shields.io/pypi/dd/ciso-assistant-api)
36
+ ![GitHub Repo stars](https://img.shields.io/github/stars/Knuckles-Team/ciso-assistant-api)
37
+ ![GitHub forks](https://img.shields.io/github/forks/Knuckles-Team/ciso-assistant-api)
38
+ ![GitHub contributors](https://img.shields.io/github/contributors/Knuckles-Team/ciso-assistant-api)
39
+ ![PyPI - License](https://img.shields.io/pypi/l/ciso-assistant-api)
40
+ ![GitHub](https://img.shields.io/github/license/Knuckles-Team/ciso-assistant-api)
41
+
42
+ ![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/Knuckles-Team/ciso-assistant-api)
43
+ ![GitHub pull requests](https://img.shields.io/github/issues-pr/Knuckles-Team/ciso-assistant-api)
44
+ ![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/Knuckles-Team/ciso-assistant-api)
45
+ ![GitHub issues](https://img.shields.io/github/issues/Knuckles-Team/ciso-assistant-api)
46
+
47
+ ![GitHub top language](https://img.shields.io/github/languages/top/Knuckles-Team/ciso-assistant-api)
48
+ ![GitHub language count](https://img.shields.io/github/languages/count/Knuckles-Team/ciso-assistant-api)
49
+ ![GitHub repo size](https://img.shields.io/github/repo-size/Knuckles-Team/ciso-assistant-api)
50
+ ![GitHub repo file count (file type)](https://img.shields.io/github/directory-file-count/Knuckles-Team/ciso-assistant-api)
51
+ ![PyPI - Wheel](https://img.shields.io/pypi/wheel/ciso-assistant-api)
52
+ ![PyPI - Implementation](https://img.shields.io/pypi/implementation/ciso-assistant-api)
53
+
54
+ *Version: 0.1.0*
55
+
56
+ ## Overview
57
+
58
+ **CISO Assistant** is a production-grade Python API client, Model Context Protocol
59
+ (MCP) server, and A2A agent for [CISO Assistant](https://github.com/intuitem/ciso-assistant-community),
60
+ intuitem's open-source GRC platform for Risk Management, AppSec, Compliance &
61
+ Audit, TPRM, BIA, Privacy, and Reporting.
62
+
63
+ It provides **100% coverage of the CISO Assistant REST API** — every one of the
64
+ **~1,565 operations** in the drf-spectacular schema is exposed as both a typed
65
+ client method and an action-routed MCP tool. The client, MCP tools, and a
66
+ machine-readable coverage manifest are all **generated from the vendored OpenAPI
67
+ spec** (`ciso_assistant_api/specs/ciso_assistant.json`) by
68
+ `scripts/generate_from_openapi.py`, and a coverage test asserts the three sets
69
+ stay in lock-step.
70
+
71
+ ### Key Features
72
+
73
+ - **100% Action-Routed MCP Tools** — one consolidated tool per domain (e.g.
74
+ `ciso_assistant_compliance`, `ciso_assistant_risk_management`,
75
+ `ciso_assistant_incidents`) takes an `action` plus a `params_json` payload and
76
+ routes to the underlying API method. 19 domain tools (mirroring the published
77
+ documentation categories) cover every endpoint without flooding the IDE tool list.
78
+ - **Full CISO Assistant surface** — Analytics & Metrology, Assets, Authentication
79
+ & Users, Compliance, EBIOS-RM, Evidence & Attachments, Frameworks & Libraries,
80
+ Governance, Incidents, Integrations, Privacy, Quantitative Risk (CRQ),
81
+ Resilience, Risk Management, Security Exceptions & Findings, Settings, Tasks &
82
+ Timeline, and Third-Party Risk Management.
83
+ - **Knox token auth** — a pre-minted Knox token *or* a username/password pair
84
+ exchanged for a token at `POST /api/iam/login/`, plus OIDC delegation (RFC 8693)
85
+ via `agent-utilities`.
86
+ - **Resilient** — honours `429` `Retry-After`, retries transient `5xx`, and
87
+ transparently follows DRF `next` pagination links.
88
+
89
+ ## MCP
90
+
91
+ ### Using as an MCP Server
92
+
93
+ The MCP Server runs in `stdio` (local) or `streamable-http` (networked) mode.
94
+ Each domain is a tool gated by a `{TAG}TOOL` environment variable (default `True`),
95
+ so you can scope the surface (e.g. set `CHATTOOL=False` to drop the chat domain).
96
+
97
+ #### Environment Variables
98
+
99
+ | Variable | Description |
100
+ | --- | --- |
101
+ | `CISO_ASSISTANT_URL` | Backend host URL, e.g. `https://ciso.arpa` or `http://localhost:8000`. |
102
+ | `CISO_ASSISTANT_TOKEN` | Pre-minted Knox token. |
103
+ | `CISO_ASSISTANT_USERNAME` / `CISO_ASSISTANT_PASSWORD` | Credentials exchanged for a token at `POST /api/iam/login/`. |
104
+ | `CISO_ASSISTANT_SSL_VERIFY` | Verify TLS (default `True`). |
105
+ | `<DOMAIN>TOOL` | Toggle a domain tool, e.g. `INCIDENTSTOOL`, `COMPLIANCETOOL`, `RISK_MANAGEMENTTOOL` (default `True`). |
106
+
107
+ #### Run in stdio mode (default):
108
+ ```bash
109
+ export CISO_ASSISTANT_URL="https://ciso.arpa"
110
+ export CISO_ASSISTANT_TOKEN="your_token"
111
+ ciso-assistant-mcp --transport "stdio"
112
+ ```
113
+
114
+ #### Run in HTTP mode:
115
+ ```bash
116
+ export CISO_ASSISTANT_URL="https://ciso.arpa"
117
+ export CISO_ASSISTANT_TOKEN="your_token"
118
+ ciso-assistant-mcp --transport "streamable-http" --host "0.0.0.0" --port "8000"
119
+ ```
120
+
121
+ ### Tool Domains
122
+
123
+ `analytics_metrology`, `assets`, `auth_users`, `chat`, `compliance`, `crq`,
124
+ `ebios_rm`, `evidence`, `frameworks_libraries`, `governance`, `incidents`,
125
+ `integrations`, `privacy`, `resilience`, `risk_management`, `security_findings`,
126
+ `settings`, `tasks_timeline`, `third_party` — plus `custom_api` (a raw REST
127
+ escape hatch).
128
+
129
+ ## A2A Agent
130
+
131
+ ### Run A2A Server
132
+ ```bash
133
+ export CISO_ASSISTANT_URL="https://ciso.arpa"
134
+ export CISO_ASSISTANT_TOKEN="your_token"
135
+ ciso-assistant-agent --provider openai --model-id gpt-4o --api-key sk-...
136
+ ```
137
+
138
+ ## Docker
139
+
140
+ ### Build
141
+
142
+ ```bash
143
+ docker build -t ciso-assistant-api .
144
+ ```
145
+
146
+ ### Run MCP Server
147
+
148
+ ```bash
149
+ docker run -d \
150
+ --name ciso-assistant-api \
151
+ -p 8000:8000 \
152
+ -e TRANSPORT=http \
153
+ -e CISO_ASSISTANT_URL="https://ciso.arpa" \
154
+ -e CISO_ASSISTANT_TOKEN="your_token" \
155
+ knucklessg1/ciso-assistant-api:latest
156
+ ```
157
+
158
+ ### Deploy with Docker Compose
159
+
160
+ ```yaml
161
+ services:
162
+ ciso-assistant-api:
163
+ image: knucklessg1/ciso-assistant-api:latest
164
+ environment:
165
+ - HOST=0.0.0.0
166
+ - PORT=8000
167
+ - TRANSPORT=http
168
+ - CISO_ASSISTANT_URL=https://ciso.arpa
169
+ - CISO_ASSISTANT_TOKEN=your_token
170
+ ports:
171
+ - 8000:8000
172
+ ```
173
+
174
+ #### Configure `mcp.json` for AI Integration (e.g. Claude Desktop)
175
+
176
+ ```json
177
+ {
178
+ "mcpServers": {
179
+ "ciso_assistant": {
180
+ "command": "uv",
181
+ "args": [
182
+ "run",
183
+ "--with",
184
+ "ciso-assistant-api",
185
+ "ciso-assistant-mcp"
186
+ ],
187
+ "env": {
188
+ "CISO_ASSISTANT_URL": "https://ciso.arpa",
189
+ "CISO_ASSISTANT_TOKEN": "your_token"
190
+ }
191
+ }
192
+ }
193
+ }
194
+ ```
195
+
196
+ ## Install Python Package
197
+
198
+ ```bash
199
+ python -m pip install ciso-assistant-api
200
+ ```
201
+ ```bash
202
+ uv pip install ciso-assistant-api
203
+ ```
204
+
205
+ ## Documentation
206
+
207
+ The complete documentation is published as the
208
+ [official documentation site](https://knuckles-team.github.io/ciso-assistant-api/) and is
209
+ the source of truth for installation, usage, and deployment.
210
+
211
+ | Page | Covers |
212
+ | --- | --- |
213
+ | [Overview](https://knuckles-team.github.io/ciso-assistant-api/overview/) | the action-routed tool surface and architecture |
214
+ | [Installation](https://knuckles-team.github.io/ciso-assistant-api/installation/) | pip, source, extras, prebuilt Docker image |
215
+ | [Usage (API / CLI / MCP)](https://knuckles-team.github.io/ciso-assistant-api/usage/) | the MCP tools, the `Api` client, the CLI |
216
+ | [Deployment](https://knuckles-team.github.io/ciso-assistant-api/deployment/) | run the MCP and agent servers, Compose, env config |
217
+
218
+ ## Repository Owners
219
+
220
+ <img width="100%" height="180em" src="https://github-readme-stats.vercel.app/api?username=Knucklessg1&show_icons=true&hide_border=true&&count_private=true&include_all_commits=true" />
221
+
222
+ ![GitHub followers](https://img.shields.io/github/followers/Knucklessg1)
223
+ ![GitHub User's stars](https://img.shields.io/github/stars/Knucklessg1)
@@ -0,0 +1,193 @@
1
+ # CISO Assistant - A2A | AG-UI | MCP
2
+
3
+ ![PyPI - Version](https://img.shields.io/pypi/v/ciso-assistant-api)
4
+ ![MCP Server](https://badge.mcpx.dev?type=server 'MCP Server')
5
+ ![PyPI - Downloads](https://img.shields.io/pypi/dd/ciso-assistant-api)
6
+ ![GitHub Repo stars](https://img.shields.io/github/stars/Knuckles-Team/ciso-assistant-api)
7
+ ![GitHub forks](https://img.shields.io/github/forks/Knuckles-Team/ciso-assistant-api)
8
+ ![GitHub contributors](https://img.shields.io/github/contributors/Knuckles-Team/ciso-assistant-api)
9
+ ![PyPI - License](https://img.shields.io/pypi/l/ciso-assistant-api)
10
+ ![GitHub](https://img.shields.io/github/license/Knuckles-Team/ciso-assistant-api)
11
+
12
+ ![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/Knuckles-Team/ciso-assistant-api)
13
+ ![GitHub pull requests](https://img.shields.io/github/issues-pr/Knuckles-Team/ciso-assistant-api)
14
+ ![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/Knuckles-Team/ciso-assistant-api)
15
+ ![GitHub issues](https://img.shields.io/github/issues/Knuckles-Team/ciso-assistant-api)
16
+
17
+ ![GitHub top language](https://img.shields.io/github/languages/top/Knuckles-Team/ciso-assistant-api)
18
+ ![GitHub language count](https://img.shields.io/github/languages/count/Knuckles-Team/ciso-assistant-api)
19
+ ![GitHub repo size](https://img.shields.io/github/repo-size/Knuckles-Team/ciso-assistant-api)
20
+ ![GitHub repo file count (file type)](https://img.shields.io/github/directory-file-count/Knuckles-Team/ciso-assistant-api)
21
+ ![PyPI - Wheel](https://img.shields.io/pypi/wheel/ciso-assistant-api)
22
+ ![PyPI - Implementation](https://img.shields.io/pypi/implementation/ciso-assistant-api)
23
+
24
+ *Version: 0.1.0*
25
+
26
+ ## Overview
27
+
28
+ **CISO Assistant** is a production-grade Python API client, Model Context Protocol
29
+ (MCP) server, and A2A agent for [CISO Assistant](https://github.com/intuitem/ciso-assistant-community),
30
+ intuitem's open-source GRC platform for Risk Management, AppSec, Compliance &
31
+ Audit, TPRM, BIA, Privacy, and Reporting.
32
+
33
+ It provides **100% coverage of the CISO Assistant REST API** — every one of the
34
+ **~1,565 operations** in the drf-spectacular schema is exposed as both a typed
35
+ client method and an action-routed MCP tool. The client, MCP tools, and a
36
+ machine-readable coverage manifest are all **generated from the vendored OpenAPI
37
+ spec** (`ciso_assistant_api/specs/ciso_assistant.json`) by
38
+ `scripts/generate_from_openapi.py`, and a coverage test asserts the three sets
39
+ stay in lock-step.
40
+
41
+ ### Key Features
42
+
43
+ - **100% Action-Routed MCP Tools** — one consolidated tool per domain (e.g.
44
+ `ciso_assistant_compliance`, `ciso_assistant_risk_management`,
45
+ `ciso_assistant_incidents`) takes an `action` plus a `params_json` payload and
46
+ routes to the underlying API method. 19 domain tools (mirroring the published
47
+ documentation categories) cover every endpoint without flooding the IDE tool list.
48
+ - **Full CISO Assistant surface** — Analytics & Metrology, Assets, Authentication
49
+ & Users, Compliance, EBIOS-RM, Evidence & Attachments, Frameworks & Libraries,
50
+ Governance, Incidents, Integrations, Privacy, Quantitative Risk (CRQ),
51
+ Resilience, Risk Management, Security Exceptions & Findings, Settings, Tasks &
52
+ Timeline, and Third-Party Risk Management.
53
+ - **Knox token auth** — a pre-minted Knox token *or* a username/password pair
54
+ exchanged for a token at `POST /api/iam/login/`, plus OIDC delegation (RFC 8693)
55
+ via `agent-utilities`.
56
+ - **Resilient** — honours `429` `Retry-After`, retries transient `5xx`, and
57
+ transparently follows DRF `next` pagination links.
58
+
59
+ ## MCP
60
+
61
+ ### Using as an MCP Server
62
+
63
+ The MCP Server runs in `stdio` (local) or `streamable-http` (networked) mode.
64
+ Each domain is a tool gated by a `{TAG}TOOL` environment variable (default `True`),
65
+ so you can scope the surface (e.g. set `CHATTOOL=False` to drop the chat domain).
66
+
67
+ #### Environment Variables
68
+
69
+ | Variable | Description |
70
+ | --- | --- |
71
+ | `CISO_ASSISTANT_URL` | Backend host URL, e.g. `https://ciso.arpa` or `http://localhost:8000`. |
72
+ | `CISO_ASSISTANT_TOKEN` | Pre-minted Knox token. |
73
+ | `CISO_ASSISTANT_USERNAME` / `CISO_ASSISTANT_PASSWORD` | Credentials exchanged for a token at `POST /api/iam/login/`. |
74
+ | `CISO_ASSISTANT_SSL_VERIFY` | Verify TLS (default `True`). |
75
+ | `<DOMAIN>TOOL` | Toggle a domain tool, e.g. `INCIDENTSTOOL`, `COMPLIANCETOOL`, `RISK_MANAGEMENTTOOL` (default `True`). |
76
+
77
+ #### Run in stdio mode (default):
78
+ ```bash
79
+ export CISO_ASSISTANT_URL="https://ciso.arpa"
80
+ export CISO_ASSISTANT_TOKEN="your_token"
81
+ ciso-assistant-mcp --transport "stdio"
82
+ ```
83
+
84
+ #### Run in HTTP mode:
85
+ ```bash
86
+ export CISO_ASSISTANT_URL="https://ciso.arpa"
87
+ export CISO_ASSISTANT_TOKEN="your_token"
88
+ ciso-assistant-mcp --transport "streamable-http" --host "0.0.0.0" --port "8000"
89
+ ```
90
+
91
+ ### Tool Domains
92
+
93
+ `analytics_metrology`, `assets`, `auth_users`, `chat`, `compliance`, `crq`,
94
+ `ebios_rm`, `evidence`, `frameworks_libraries`, `governance`, `incidents`,
95
+ `integrations`, `privacy`, `resilience`, `risk_management`, `security_findings`,
96
+ `settings`, `tasks_timeline`, `third_party` — plus `custom_api` (a raw REST
97
+ escape hatch).
98
+
99
+ ## A2A Agent
100
+
101
+ ### Run A2A Server
102
+ ```bash
103
+ export CISO_ASSISTANT_URL="https://ciso.arpa"
104
+ export CISO_ASSISTANT_TOKEN="your_token"
105
+ ciso-assistant-agent --provider openai --model-id gpt-4o --api-key sk-...
106
+ ```
107
+
108
+ ## Docker
109
+
110
+ ### Build
111
+
112
+ ```bash
113
+ docker build -t ciso-assistant-api .
114
+ ```
115
+
116
+ ### Run MCP Server
117
+
118
+ ```bash
119
+ docker run -d \
120
+ --name ciso-assistant-api \
121
+ -p 8000:8000 \
122
+ -e TRANSPORT=http \
123
+ -e CISO_ASSISTANT_URL="https://ciso.arpa" \
124
+ -e CISO_ASSISTANT_TOKEN="your_token" \
125
+ knucklessg1/ciso-assistant-api:latest
126
+ ```
127
+
128
+ ### Deploy with Docker Compose
129
+
130
+ ```yaml
131
+ services:
132
+ ciso-assistant-api:
133
+ image: knucklessg1/ciso-assistant-api:latest
134
+ environment:
135
+ - HOST=0.0.0.0
136
+ - PORT=8000
137
+ - TRANSPORT=http
138
+ - CISO_ASSISTANT_URL=https://ciso.arpa
139
+ - CISO_ASSISTANT_TOKEN=your_token
140
+ ports:
141
+ - 8000:8000
142
+ ```
143
+
144
+ #### Configure `mcp.json` for AI Integration (e.g. Claude Desktop)
145
+
146
+ ```json
147
+ {
148
+ "mcpServers": {
149
+ "ciso_assistant": {
150
+ "command": "uv",
151
+ "args": [
152
+ "run",
153
+ "--with",
154
+ "ciso-assistant-api",
155
+ "ciso-assistant-mcp"
156
+ ],
157
+ "env": {
158
+ "CISO_ASSISTANT_URL": "https://ciso.arpa",
159
+ "CISO_ASSISTANT_TOKEN": "your_token"
160
+ }
161
+ }
162
+ }
163
+ }
164
+ ```
165
+
166
+ ## Install Python Package
167
+
168
+ ```bash
169
+ python -m pip install ciso-assistant-api
170
+ ```
171
+ ```bash
172
+ uv pip install ciso-assistant-api
173
+ ```
174
+
175
+ ## Documentation
176
+
177
+ The complete documentation is published as the
178
+ [official documentation site](https://knuckles-team.github.io/ciso-assistant-api/) and is
179
+ the source of truth for installation, usage, and deployment.
180
+
181
+ | Page | Covers |
182
+ | --- | --- |
183
+ | [Overview](https://knuckles-team.github.io/ciso-assistant-api/overview/) | the action-routed tool surface and architecture |
184
+ | [Installation](https://knuckles-team.github.io/ciso-assistant-api/installation/) | pip, source, extras, prebuilt Docker image |
185
+ | [Usage (API / CLI / MCP)](https://knuckles-team.github.io/ciso-assistant-api/usage/) | the MCP tools, the `Api` client, the CLI |
186
+ | [Deployment](https://knuckles-team.github.io/ciso-assistant-api/deployment/) | run the MCP and agent servers, Compose, env config |
187
+
188
+ ## Repository Owners
189
+
190
+ <img width="100%" height="180em" src="https://github-readme-stats.vercel.app/api?username=Knucklessg1&show_icons=true&hide_border=true&&count_private=true&include_all_commits=true" />
191
+
192
+ ![GitHub followers](https://img.shields.io/github/followers/Knucklessg1)
193
+ ![GitHub User's stars](https://img.shields.io/github/stars/Knucklessg1)
@@ -0,0 +1,63 @@
1
+ #!/usr/bin/env python
2
+
3
+ import importlib
4
+ import inspect
5
+ import warnings
6
+
7
+ # Suppress RequestsDependencyWarning due to chardet 6.x / requests 2.32.x mismatch
8
+ # Centralized here to ensure it runs before any sub-package imports
9
+ warnings.filterwarnings("ignore", message=".*urllib3.*or chardet.*")
10
+
11
+ __all__: list[str] = []
12
+
13
+ CORE_MODULES = [
14
+ "ciso_assistant_api.api_client",
15
+ ]
16
+
17
+ OPTIONAL_MODULES = {
18
+ "ciso_assistant_api.agent_server": "agent",
19
+ "ciso_assistant_api.mcp_server": "mcp",
20
+ }
21
+
22
+
23
+ def _import_module_safely(module_name: str):
24
+ """Try to import a module and return it, or None if not available."""
25
+ try:
26
+ return importlib.import_module(module_name)
27
+ except ImportError:
28
+ return None
29
+
30
+
31
+ def _expose_members(module):
32
+ """Expose public classes and functions from a module into globals and __all__."""
33
+ for name, obj in inspect.getmembers(module):
34
+ if (inspect.isclass(obj) or inspect.isfunction(obj)) and not name.startswith(
35
+ "_"
36
+ ):
37
+ globals()[name] = obj
38
+ __all__.append(name)
39
+
40
+
41
+ for module_name in CORE_MODULES:
42
+ try:
43
+ module = importlib.import_module(module_name)
44
+ _expose_members(module)
45
+ except ImportError:
46
+ pass
47
+
48
+ for module_name, extra_name in OPTIONAL_MODULES.items():
49
+ module = _import_module_safely(module_name)
50
+ globals()[f"_{extra_name.upper()}_AVAILABLE"] = module is not None
51
+ if module is not None:
52
+ _expose_members(module)
53
+
54
+ __all__.extend(["_MCP_AVAILABLE", "_AGENT_AVAILABLE"])
55
+
56
+
57
+ """
58
+ ciso-assistant-api
59
+
60
+ Python CISO Assistant API client + MCP server + A2A agent with 100% API coverage
61
+
62
+ CONCEPT:CISO-001 — CISO Assistant GRC connector (api-client + MCP + A2A).
63
+ """
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/python
2
+ from ciso_assistant_api.agent_server import agent_server
3
+
4
+ if __name__ == "__main__":
5
+ agent_server()
@@ -0,0 +1,12 @@
1
+ # AGENTS.md - Known A2A Peer Agents
2
+ Last updated: 2026-06-15
3
+
4
+ This file is the local registry of other A2A agents this agent can discover and call.
5
+
6
+ ## Registered A2A Peers
7
+
8
+ | Name | Endpoint URL | Description | Capabilities | Auth | Notes / Last Connected |
9
+ |-----------------|---------------------------------|--------------------------------------|----------------------------------|-----------|------------------------|
10
+ | SearchMaster | http://search-agent:9000/a2a | Advanced web researcher | web_search, summarize, browse | none | 2026-06-15 |
11
+
12
+ *Add new rows manually or let the agent call `register_a2a_peer(...)`.*
@@ -0,0 +1,12 @@
1
+ # CRON.md - Persistent Scheduled Tasks
2
+ Last updated: 2026-06-15
3
+
4
+ ## Active Tasks
5
+
6
+ | ID | Name | Interval (min) | Prompt | Last run | Next approx |
7
+ |-------------|-------------------|----------------|-------------------------------------|-------------------|-------------|
8
+ | heartbeat | Heartbeat | 30 | @HEARTBEAT.md | — | — |
9
+ | log-cleanup | Log Cleanup | 720 | __internal:cleanup_cron_log | — | — |
10
+
11
+ *Edit this table to add/remove tasks. The agent reloads it periodically.*
12
+ *Use `@filename.md` in the Prompt column to load a multi-line prompt from a workspace file.*
@@ -0,0 +1,5 @@
1
+ # CRON_LOG.md - Scheduled Task History
2
+ Last updated: 2026-06-15
3
+
4
+ | Timestamp | Task ID | Status | Message |
5
+ |-----------|---------|--------|---------|
@@ -0,0 +1,28 @@
1
+ # Heartbeat — Periodic Self-Check
2
+
3
+ You are running a scheduled heartbeat. Perform these checks and report results concisely.
4
+
5
+ ## Checks
6
+
7
+ 1. **Tool Availability** — Call `list_tools` or equivalent to verify your MCP tools are reachable. Report any connection failures.
8
+ 2. **Memory Review** — Query the **Knowledge Graph** for any pending follow-up tasks, architectural decisions, or action items.
9
+ 3. **Cron Log** — Read `CRON_LOG.md` and check for recent errors (❌). Summarize any failures from the last 24 hours.
10
+ 4. **Peer Agents** — Read `AGENTS.md` and note if any registered peers need attention.
11
+ 5. **Domain-Specific Checks**:
12
+ - **Service Health**: Check service health status and scan recent logs for critical errors using available tools.
13
+ 6. **Self-Diagnostics** — Report your current model, available tool count, and any anomalies.
14
+
15
+ ## Response Format
16
+
17
+ If everything is healthy:
18
+ ```
19
+ HEARTBEAT_OK — All systems nominal. [tool_count] tools available. No pending actions.
20
+ ```
21
+
22
+ If issues found:
23
+ ```
24
+ HEARTBEAT_ALERT — [summary of issues found]
25
+ - Issue 1: ...
26
+ - Issue 2: ...
27
+ - Action needed: ...
28
+ ```
@@ -0,0 +1,15 @@
1
+ # IDENTITY.md - CISO Assistant Agent Identity
2
+
3
+ ## [default]
4
+ * **Name:** CISO Assistant Agent
5
+ * **Role:** Python CISO Assistant API client + MCP server + A2A agent with 100% API coverage
6
+ * **Emoji:** 🤖
7
+
8
+ ### System Prompt
9
+ You are the CISO Assistant Agent.
10
+ You must always first run `list_skills` to show all skills.
11
+ Then, use the `mcp-client` universal skill and check the reference documentation for `ciso-assistant-api.md` to discover the exact tags and tools available for your capabilities.
12
+
13
+ ### Capabilities
14
+ - **MCP Operations**: Leverage the `mcp-client` skill to interact with the target MCP server. Refer to `ciso-assistant-api.md` for specific tool capabilities.
15
+ - **Custom Agent**: Handle custom tasks or general tasks.
@@ -0,0 +1,13 @@
1
+ # MCP_AGENTS.md - Dynamic Agent Registry
2
+
3
+ This file tracks the generated agents from MCP servers. You can manually modify the 'Tools' list to customize agent expertise.
4
+
5
+ ## Agent Mapping Table
6
+
7
+ | Name | Description | System Prompt | Tools | Tag | Source MCP |
8
+ |------|-------------|---------------|-------|-----|------------|
9
+
10
+ ## Tool Inventory Table
11
+
12
+ | Tool Name | Description | Tag | Source |
13
+ |-----------|-------------|-----|--------|
@@ -0,0 +1,7 @@
1
+ # USER.md - About the Human
2
+
3
+ * **Name:** User
4
+ * **Preferred name:** User
5
+ * **Timezone:** America/Chicago
6
+ * **Location:** Chicago, Illinois
7
+ * **Style:** Technical, concise, no fluff
@@ -0,0 +1,39 @@
1
+ {
2
+ "mcpServers": {
3
+ "ciso-assistant-api": {
4
+ "command": "uv",
5
+ "args": [
6
+ "run",
7
+ "ciso-assistant-mcp"
8
+ ],
9
+ "env": {
10
+ "FASTMCP_LOG_LEVEL": "<YOUR_FASTMCP_LOG_LEVEL>",
11
+ "CISO_ASSISTANT_URL": "<YOUR_CISO_ASSISTANT_URL>",
12
+ "CISO_ASSISTANT_TOKEN": "<YOUR_CISO_ASSISTANT_TOKEN>",
13
+ "CISO_ASSISTANT_USERNAME": "<YOUR_CISO_ASSISTANT_USERNAME>",
14
+ "CISO_ASSISTANT_PASSWORD": "<YOUR_CISO_ASSISTANT_PASSWORD>",
15
+ "CISO_ASSISTANT_SSL_VERIFY": "True",
16
+ "ANALYTICS_METROLOGYTOOL": "True",
17
+ "ASSETSTOOL": "True",
18
+ "AUTH_USERSTOOL": "True",
19
+ "CHATTOOL": "True",
20
+ "COMPLIANCETOOL": "True",
21
+ "CRQTOOL": "True",
22
+ "EBIOS_RMTOOL": "True",
23
+ "EVIDENCETOOL": "True",
24
+ "FRAMEWORKS_LIBRARIESTOOL": "True",
25
+ "GOVERNANCETOOL": "True",
26
+ "INCIDENTSTOOL": "True",
27
+ "INTEGRATIONSTOOL": "True",
28
+ "PRIVACYTOOL": "True",
29
+ "RESILIENCETOOL": "True",
30
+ "RISK_MANAGEMENTTOOL": "True",
31
+ "SECURITY_FINDINGSTOOL": "True",
32
+ "SETTINGSTOOL": "True",
33
+ "TASKS_TIMELINETOOL": "True",
34
+ "THIRD_PARTYTOOL": "True",
35
+ "CUSTOM_APITOOL": "True"
36
+ }
37
+ }
38
+ }
39
+ }