@inkog-io/mcp 1.0.0
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.
- package/LICENSE +190 -0
- package/README.md +265 -0
- package/dist/api/client.d.ts +108 -0
- package/dist/api/client.d.ts.map +1 -0
- package/dist/api/client.js +288 -0
- package/dist/api/client.js.map +1 -0
- package/dist/api/types.d.ts +286 -0
- package/dist/api/types.d.ts.map +1 -0
- package/dist/api/types.js +21 -0
- package/dist/api/types.js.map +1 -0
- package/dist/config.d.ts +68 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +130 -0
- package/dist/config.js.map +1 -0
- package/dist/index.d.ts +19 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +203 -0
- package/dist/index.js.map +1 -0
- package/dist/tools/audit-a2a.d.ts +20 -0
- package/dist/tools/audit-a2a.d.ts.map +1 -0
- package/dist/tools/audit-a2a.js +382 -0
- package/dist/tools/audit-a2a.js.map +1 -0
- package/dist/tools/audit-mcp.d.ts +16 -0
- package/dist/tools/audit-mcp.d.ts.map +1 -0
- package/dist/tools/audit-mcp.js +259 -0
- package/dist/tools/audit-mcp.js.map +1 -0
- package/dist/tools/compliance.d.ts +14 -0
- package/dist/tools/compliance.d.ts.map +1 -0
- package/dist/tools/compliance.js +255 -0
- package/dist/tools/compliance.js.map +1 -0
- package/dist/tools/explain.d.ts +14 -0
- package/dist/tools/explain.d.ts.map +1 -0
- package/dist/tools/explain.js +202 -0
- package/dist/tools/explain.js.map +1 -0
- package/dist/tools/governance.d.ts +16 -0
- package/dist/tools/governance.d.ts.map +1 -0
- package/dist/tools/governance.js +200 -0
- package/dist/tools/governance.js.map +1 -0
- package/dist/tools/index.d.ts +50 -0
- package/dist/tools/index.d.ts.map +1 -0
- package/dist/tools/index.js +94 -0
- package/dist/tools/index.js.map +1 -0
- package/dist/tools/mlbom.d.ts +18 -0
- package/dist/tools/mlbom.d.ts.map +1 -0
- package/dist/tools/mlbom.js +344 -0
- package/dist/tools/mlbom.js.map +1 -0
- package/dist/tools/scan.d.ts +15 -0
- package/dist/tools/scan.d.ts.map +1 -0
- package/dist/tools/scan.js +270 -0
- package/dist/tools/scan.js.map +1 -0
- package/dist/utils/file-reader.d.ts +55 -0
- package/dist/utils/file-reader.d.ts.map +1 -0
- package/dist/utils/file-reader.js +269 -0
- package/dist/utils/file-reader.js.map +1 -0
- package/package.json +64 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to the Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
Copyright 2024 Inkog.io
|
|
179
|
+
|
|
180
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
181
|
+
you may not use this file except in compliance with the License.
|
|
182
|
+
You may obtain a copy of the License at
|
|
183
|
+
|
|
184
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
185
|
+
|
|
186
|
+
Unless required by applicable law or agreed to in writing, software
|
|
187
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
188
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
189
|
+
See the License for the specific language governing permissions and
|
|
190
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,265 @@
|
|
|
1
|
+
# Inkog MCP Server
|
|
2
|
+
|
|
3
|
+
AI Security Platform for the Agentic Era - Available in Claude, ChatGPT, Cursor, and any MCP-compatible client.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@inkog-io/mcp)
|
|
6
|
+
[](LICENSE)
|
|
7
|
+
[](https://modelcontextprotocol.io)
|
|
8
|
+
|
|
9
|
+
## What is Inkog?
|
|
10
|
+
|
|
11
|
+
Inkog is the **AI Security Platform (AISP)** for securing AI agents. It provides:
|
|
12
|
+
|
|
13
|
+
- **Vulnerability Scanning**: Detect prompt injection, infinite loops, token bombing, SQL injection via LLM
|
|
14
|
+
- **AGENTS.md Governance**: Validate that code behavior matches governance declarations
|
|
15
|
+
- **Compliance Reporting**: Generate reports for EU AI Act, NIST AI RMF, ISO 42001, OWASP LLM Top 10
|
|
16
|
+
- **MCP Server Auditing**: Security audit any MCP server from the registry
|
|
17
|
+
- **MLBOM Generation**: Create Machine Learning Bill of Materials for supply chain visibility
|
|
18
|
+
- **Multi-Agent Security**: Audit Agent-to-Agent communications for security risks
|
|
19
|
+
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
### Claude Desktop
|
|
23
|
+
|
|
24
|
+
Add to your `claude_desktop_config.json`:
|
|
25
|
+
|
|
26
|
+
```json
|
|
27
|
+
{
|
|
28
|
+
"mcpServers": {
|
|
29
|
+
"inkog": {
|
|
30
|
+
"command": "npx",
|
|
31
|
+
"args": ["-y", "@inkog-io/mcp"],
|
|
32
|
+
"env": {
|
|
33
|
+
"INKOG_API_KEY": "sk_live_your_api_key"
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Cursor
|
|
41
|
+
|
|
42
|
+
Add to your Cursor MCP settings:
|
|
43
|
+
|
|
44
|
+
```json
|
|
45
|
+
{
|
|
46
|
+
"mcpServers": {
|
|
47
|
+
"inkog": {
|
|
48
|
+
"command": "npx",
|
|
49
|
+
"args": ["-y", "@inkog-io/mcp"],
|
|
50
|
+
"env": {
|
|
51
|
+
"INKOG_API_KEY": "sk_live_your_api_key"
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Global Installation
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
npm install -g @inkog-io/mcp
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Getting Your API Key
|
|
65
|
+
|
|
66
|
+
1. Sign up for free at [app.inkog.io](https://app.inkog.io)
|
|
67
|
+
2. Copy your API key from the dashboard
|
|
68
|
+
3. Set it as `INKOG_API_KEY` environment variable
|
|
69
|
+
|
|
70
|
+
## Available Tools
|
|
71
|
+
|
|
72
|
+
### P0 - Core Security (Essential)
|
|
73
|
+
|
|
74
|
+
| Tool | Description |
|
|
75
|
+
|------|-------------|
|
|
76
|
+
| `inkog_scan` | Scan AI agent code for security vulnerabilities |
|
|
77
|
+
| `inkog_verify_governance` | Validate AGENTS.md declarations match actual code behavior |
|
|
78
|
+
|
|
79
|
+
### P1 - Enterprise Features
|
|
80
|
+
|
|
81
|
+
| Tool | Description |
|
|
82
|
+
|------|-------------|
|
|
83
|
+
| `inkog_compliance_report` | Generate EU AI Act, NIST, OWASP compliance reports |
|
|
84
|
+
| `inkog_explain_finding` | Get detailed remediation guidance for findings |
|
|
85
|
+
| `inkog_audit_mcp_server` | Security audit any MCP server |
|
|
86
|
+
| `inkog_generate_mlbom` | Generate ML Bill of Materials (CycloneDX, SPDX) |
|
|
87
|
+
|
|
88
|
+
### P2 - Multi-Agent Security
|
|
89
|
+
|
|
90
|
+
| Tool | Description |
|
|
91
|
+
|------|-------------|
|
|
92
|
+
| `inkog_audit_a2a` | Audit Agent-to-Agent communications |
|
|
93
|
+
|
|
94
|
+
## Tool Details
|
|
95
|
+
|
|
96
|
+
### inkog_scan
|
|
97
|
+
|
|
98
|
+
Scan AI agent code for security vulnerabilities.
|
|
99
|
+
|
|
100
|
+
```
|
|
101
|
+
Arguments:
|
|
102
|
+
path (required) File or directory path to scan
|
|
103
|
+
policy (optional) Security policy: low-noise, balanced, comprehensive, governance, eu-ai-act
|
|
104
|
+
output (optional) Output format: summary, detailed, sarif
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
**Example**: "Scan my LangChain agent for vulnerabilities"
|
|
108
|
+
|
|
109
|
+
### inkog_verify_governance
|
|
110
|
+
|
|
111
|
+
Validate that AGENTS.md declarations match actual code behavior. **This is Inkog's unique differentiator** - no other tool does governance verification.
|
|
112
|
+
|
|
113
|
+
```
|
|
114
|
+
Arguments:
|
|
115
|
+
path (required) Path to directory containing AGENTS.md and agent code
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
**Example**: "Verify my agent's governance declarations"
|
|
119
|
+
|
|
120
|
+
### inkog_compliance_report
|
|
121
|
+
|
|
122
|
+
Generate compliance reports for regulatory frameworks.
|
|
123
|
+
|
|
124
|
+
```
|
|
125
|
+
Arguments:
|
|
126
|
+
path (required) Path to scan
|
|
127
|
+
framework (optional) eu-ai-act, nist-ai-rmf, iso-42001, owasp-llm-top-10, all
|
|
128
|
+
format (optional) markdown, json, pdf
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
**Example**: "Generate an EU AI Act compliance report for my agent"
|
|
132
|
+
|
|
133
|
+
### inkog_explain_finding
|
|
134
|
+
|
|
135
|
+
Get detailed explanation and remediation guidance for a security finding.
|
|
136
|
+
|
|
137
|
+
```
|
|
138
|
+
Arguments:
|
|
139
|
+
finding_id (optional) Finding ID from scan results
|
|
140
|
+
pattern (optional) Pattern name (e.g., prompt-injection, infinite-loop)
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
**Example**: "Explain how to fix prompt injection vulnerabilities"
|
|
144
|
+
|
|
145
|
+
### inkog_audit_mcp_server
|
|
146
|
+
|
|
147
|
+
Security audit any MCP server from the registry or GitHub.
|
|
148
|
+
|
|
149
|
+
```
|
|
150
|
+
Arguments:
|
|
151
|
+
server_name (optional) MCP server name from registry (e.g., "github", "slack")
|
|
152
|
+
repository_url (optional) Direct GitHub repository URL
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
**Example**: "Audit the GitHub MCP server for security issues"
|
|
156
|
+
|
|
157
|
+
### inkog_generate_mlbom
|
|
158
|
+
|
|
159
|
+
Generate a Machine Learning Bill of Materials listing all AI components.
|
|
160
|
+
|
|
161
|
+
```
|
|
162
|
+
Arguments:
|
|
163
|
+
path (required) Path to agent codebase
|
|
164
|
+
format (optional) cyclonedx, spdx, json
|
|
165
|
+
include_vulnerabilities (optional) Include known CVEs (default: true)
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
**Example**: "Generate an MLBOM for my AI project"
|
|
169
|
+
|
|
170
|
+
### inkog_audit_a2a
|
|
171
|
+
|
|
172
|
+
Audit Agent-to-Agent communications for security risks.
|
|
173
|
+
|
|
174
|
+
```
|
|
175
|
+
Arguments:
|
|
176
|
+
path (required) Path to multi-agent codebase
|
|
177
|
+
protocol (optional) a2a, crewai, langgraph, auto-detect
|
|
178
|
+
check_delegation_chains (optional) Check for infinite loops (default: true)
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
**Example**: "Audit my CrewAI multi-agent system for security risks"
|
|
182
|
+
|
|
183
|
+
## Supported Frameworks
|
|
184
|
+
|
|
185
|
+
Inkog works with all major AI agent frameworks:
|
|
186
|
+
|
|
187
|
+
- LangChain / LangGraph
|
|
188
|
+
- CrewAI
|
|
189
|
+
- AutoGen
|
|
190
|
+
- n8n
|
|
191
|
+
- Flowise
|
|
192
|
+
- Dify
|
|
193
|
+
- Microsoft Copilot Studio
|
|
194
|
+
- Custom implementations
|
|
195
|
+
|
|
196
|
+
## Configuration
|
|
197
|
+
|
|
198
|
+
All configuration is done via environment variables:
|
|
199
|
+
|
|
200
|
+
| Variable | Description | Default |
|
|
201
|
+
|----------|-------------|---------|
|
|
202
|
+
| `INKOG_API_KEY` | Your API key (required) | - |
|
|
203
|
+
| `INKOG_API_URL` | API base URL | `https://api.inkog.io` |
|
|
204
|
+
| `INKOG_API_VERSION` | API version | `v1` |
|
|
205
|
+
| `INKOG_API_TIMEOUT` | Request timeout (ms) | `30000` |
|
|
206
|
+
| `INKOG_LOG_LEVEL` | Log level | `info` |
|
|
207
|
+
| `INKOG_LOG_FORMAT` | Log format (json/text) | `json` |
|
|
208
|
+
|
|
209
|
+
## Development
|
|
210
|
+
|
|
211
|
+
```bash
|
|
212
|
+
# Install dependencies
|
|
213
|
+
npm install
|
|
214
|
+
|
|
215
|
+
# Build
|
|
216
|
+
npm run build
|
|
217
|
+
|
|
218
|
+
# Run in development mode
|
|
219
|
+
npm run dev
|
|
220
|
+
|
|
221
|
+
# Run tests
|
|
222
|
+
npm test
|
|
223
|
+
|
|
224
|
+
# Lint
|
|
225
|
+
npm run lint
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
## Why Inkog?
|
|
229
|
+
|
|
230
|
+
### The Only Tool with AGENTS.md Verification
|
|
231
|
+
|
|
232
|
+
Inkog is the **only security tool** that can validate your agent's governance declarations against its actual code behavior. This is essential for:
|
|
233
|
+
|
|
234
|
+
- **EU AI Act Article 14** compliance (human oversight)
|
|
235
|
+
- **Enterprise governance** requirements
|
|
236
|
+
- **Preventing governance drift** as code evolves
|
|
237
|
+
|
|
238
|
+
### Purpose-Built for AI Agents
|
|
239
|
+
|
|
240
|
+
Unlike traditional security scanners (Snyk, Semgrep, SonarQube), Inkog understands AI-specific vulnerabilities:
|
|
241
|
+
|
|
242
|
+
- Prompt injection attacks
|
|
243
|
+
- Infinite loops and token bombing
|
|
244
|
+
- SQL injection via LLM output
|
|
245
|
+
- Cross-tenant data leakage
|
|
246
|
+
- Recursive tool calling
|
|
247
|
+
|
|
248
|
+
### Multi-Framework Support
|
|
249
|
+
|
|
250
|
+
Inkog's Universal IR (Intermediate Representation) works with any agent framework. Add one integration, get security for all frameworks.
|
|
251
|
+
|
|
252
|
+
## License
|
|
253
|
+
|
|
254
|
+
Apache-2.0 - see [LICENSE](LICENSE)
|
|
255
|
+
|
|
256
|
+
## Links
|
|
257
|
+
|
|
258
|
+
- [Documentation](https://docs.inkog.io)
|
|
259
|
+
- [Dashboard](https://app.inkog.io)
|
|
260
|
+
- [Website](https://inkog.io)
|
|
261
|
+
- [GitHub](https://github.com/inkog-io/inkog-mcp)
|
|
262
|
+
|
|
263
|
+
---
|
|
264
|
+
|
|
265
|
+
Built with security by [Inkog.io](https://inkog.io)
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Inkog API Client
|
|
3
|
+
*
|
|
4
|
+
* Enterprise-grade HTTP client for communicating with the Inkog API.
|
|
5
|
+
* Features:
|
|
6
|
+
* - Automatic retry with exponential backoff
|
|
7
|
+
* - Request/response validation
|
|
8
|
+
* - Structured error handling
|
|
9
|
+
* - Configurable timeouts
|
|
10
|
+
* - API key authentication
|
|
11
|
+
*/
|
|
12
|
+
import { type Config } from '../config.js';
|
|
13
|
+
import type { A2AAuditResponse, A2AProtocol, ComplianceFramework, ComplianceReportResponse, ExplainResponse, GovernanceVerifyResponse, McpAuditResponse, MlbomFormat, MlbomResponse, ScanResponse, SecurityPolicy } from './types.js';
|
|
14
|
+
export declare class InkogApiError extends Error {
|
|
15
|
+
readonly code: string;
|
|
16
|
+
readonly statusCode: number;
|
|
17
|
+
readonly details?: Record<string, unknown> | undefined;
|
|
18
|
+
constructor(message: string, code: string, statusCode: number, details?: Record<string, unknown> | undefined);
|
|
19
|
+
}
|
|
20
|
+
export declare class InkogAuthError extends InkogApiError {
|
|
21
|
+
constructor(message?: string);
|
|
22
|
+
}
|
|
23
|
+
export declare class InkogRateLimitError extends InkogApiError {
|
|
24
|
+
readonly retryAfter: number;
|
|
25
|
+
constructor(retryAfter: number, message?: string);
|
|
26
|
+
}
|
|
27
|
+
export declare class InkogNetworkError extends Error {
|
|
28
|
+
readonly cause?: Error | undefined;
|
|
29
|
+
constructor(message: string, cause?: Error | undefined);
|
|
30
|
+
}
|
|
31
|
+
interface FileInput {
|
|
32
|
+
path: string;
|
|
33
|
+
content: string;
|
|
34
|
+
}
|
|
35
|
+
export declare class InkogClient {
|
|
36
|
+
private readonly config;
|
|
37
|
+
private readonly apiKey;
|
|
38
|
+
constructor(config?: Partial<Config>, apiKey?: string);
|
|
39
|
+
/**
|
|
40
|
+
* Check if client has valid API key
|
|
41
|
+
*/
|
|
42
|
+
hasApiKey(): boolean;
|
|
43
|
+
/**
|
|
44
|
+
* Make authenticated API request with retry logic
|
|
45
|
+
*/
|
|
46
|
+
private request;
|
|
47
|
+
private sleep;
|
|
48
|
+
/**
|
|
49
|
+
* Scan files for AI agent vulnerabilities
|
|
50
|
+
*/
|
|
51
|
+
scan(files: FileInput[], options?: {
|
|
52
|
+
policy?: SecurityPolicy;
|
|
53
|
+
output?: 'summary' | 'detailed' | 'sarif';
|
|
54
|
+
}): Promise<ScanResponse>;
|
|
55
|
+
/**
|
|
56
|
+
* Verify AGENTS.md governance declarations against actual code.
|
|
57
|
+
* Either provide files directly, or reference a previous scan by scanId.
|
|
58
|
+
*/
|
|
59
|
+
verifyGovernance(files: FileInput[], options?: {
|
|
60
|
+
scanId?: string;
|
|
61
|
+
}): Promise<GovernanceVerifyResponse>;
|
|
62
|
+
/**
|
|
63
|
+
* Generate compliance report for a regulatory framework.
|
|
64
|
+
* Either provide files directly, or reference a previous scan by scanId.
|
|
65
|
+
*/
|
|
66
|
+
generateComplianceReport(files: FileInput[], options?: {
|
|
67
|
+
framework?: ComplianceFramework | 'all';
|
|
68
|
+
format?: 'markdown' | 'json' | 'pdf';
|
|
69
|
+
scanId?: string;
|
|
70
|
+
}): Promise<ComplianceReportResponse>;
|
|
71
|
+
/**
|
|
72
|
+
* Get detailed explanation and remediation for a finding or pattern
|
|
73
|
+
*/
|
|
74
|
+
explainFinding(options: {
|
|
75
|
+
findingId?: string;
|
|
76
|
+
pattern?: string;
|
|
77
|
+
}): Promise<ExplainResponse>;
|
|
78
|
+
/**
|
|
79
|
+
* Security audit an MCP server from the registry or GitHub
|
|
80
|
+
*/
|
|
81
|
+
auditMcpServer(options: {
|
|
82
|
+
serverName?: string;
|
|
83
|
+
repositoryUrl?: string;
|
|
84
|
+
}): Promise<McpAuditResponse>;
|
|
85
|
+
/**
|
|
86
|
+
* Generate ML Bill of Materials (MLBOM).
|
|
87
|
+
* Either provide files directly, or reference a previous scan by scanId.
|
|
88
|
+
*/
|
|
89
|
+
generateMlbom(files: FileInput[], options?: {
|
|
90
|
+
format?: MlbomFormat;
|
|
91
|
+
includeVulnerabilities?: boolean;
|
|
92
|
+
scanId?: string;
|
|
93
|
+
}): Promise<MlbomResponse>;
|
|
94
|
+
/**
|
|
95
|
+
* Audit Agent-to-Agent (A2A) communications.
|
|
96
|
+
* Either provide files directly, or reference a previous scan by scanId.
|
|
97
|
+
*/
|
|
98
|
+
auditA2A(files: FileInput[], options?: {
|
|
99
|
+
protocol?: A2AProtocol;
|
|
100
|
+
checkDelegationChains?: boolean;
|
|
101
|
+
scanId?: string;
|
|
102
|
+
}): Promise<A2AAuditResponse>;
|
|
103
|
+
}
|
|
104
|
+
export declare function getClient(): InkogClient;
|
|
105
|
+
export declare function createClient(config?: Partial<Config>, apiKey?: string): InkogClient;
|
|
106
|
+
export declare function resetClient(): void;
|
|
107
|
+
export {};
|
|
108
|
+
//# sourceMappingURL=client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAEL,KAAK,MAAM,EAGZ,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EACV,gBAAgB,EAChB,WAAW,EAEX,mBAAmB,EACnB,wBAAwB,EACxB,eAAe,EACf,wBAAwB,EACxB,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,YAAY,EACZ,cAAc,EACf,MAAM,YAAY,CAAC;AAMpB,qBAAa,aAAc,SAAQ,KAAK;aAGpB,IAAI,EAAE,MAAM;aACZ,UAAU,EAAE,MAAM;aAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;gBAHjD,OAAO,EAAE,MAAM,EACC,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YAAA;CAKpD;AAED,qBAAa,cAAe,SAAQ,aAAa;gBACnC,OAAO,SAAmE;CAIvF;AAED,qBAAa,mBAAoB,SAAQ,aAAa;aAElC,UAAU,EAAE,MAAM;gBAAlB,UAAU,EAAE,MAAM,EAClC,OAAO,SAAwB;CAKlC;AAED,qBAAa,iBAAkB,SAAQ,KAAK;aAGxB,KAAK,CAAC,EAAE,KAAK;gBAD7B,OAAO,EAAE,MAAM,EACC,KAAK,CAAC,EAAE,KAAK,YAAA;CAKhC;AAeD,UAAU,SAAS;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAMD,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM;IAKrD;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;OAEG;YACW,OAAO;IAoGrB,OAAO,CAAC,KAAK;IAQb;;OAEG;IACG,IAAI,CACR,KAAK,EAAE,SAAS,EAAE,EAClB,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,cAAc,CAAC;QACxB,MAAM,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,OAAO,CAAC;KAC3C,GACA,OAAO,CAAC,YAAY,CAAC;IAYxB;;;OAGG;IACG,gBAAgB,CACpB,KAAK,EAAE,SAAS,EAAE,EAClB,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAC5B,OAAO,CAAC,wBAAwB,CAAC;IAgBpC;;;OAGG;IACG,wBAAwB,CAC5B,KAAK,EAAE,SAAS,EAAE,EAClB,OAAO,CAAC,EAAE;QACR,SAAS,CAAC,EAAE,mBAAmB,GAAG,KAAK,CAAC;QACxC,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,KAAK,CAAC;QACrC,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GACA,OAAO,CAAC,wBAAwB,CAAC;IAmBpC;;OAEG;IACG,cAAc,CAAC,OAAO,EAAE;QAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC,eAAe,CAAC;IAc5B;;OAEG;IACG,cAAc,CAAC,OAAO,EAAE;QAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAY7B;;;OAGG;IACG,aAAa,CACjB,KAAK,EAAE,SAAS,EAAE,EAClB,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,sBAAsB,CAAC,EAAE,OAAO,CAAC;QACjC,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GACA,OAAO,CAAC,aAAa,CAAC;IAmBzB;;;OAGG;IACG,QAAQ,CACZ,KAAK,EAAE,SAAS,EAAE,EAClB,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,WAAW,CAAC;QACvB,qBAAqB,CAAC,EAAE,OAAO,CAAC;QAChC,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GACA,OAAO,CAAC,gBAAgB,CAAC;CAkB7B;AAQD,wBAAgB,SAAS,IAAI,WAAW,CAGvC;AAED,wBAAgB,YAAY,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,WAAW,CAEnF;AAED,wBAAgB,WAAW,IAAI,IAAI,CAElC"}
|