You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,18 +4,17 @@ Welcome and thank you for considering contributing to the Checkmarx Kiro Power p
4
4
5
5
Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.
6
6
7
-
8
7
## Quicklinks
9
8
10
9
-[Contributing to Checkmarx Kiro Power](#contributing-to-checkmarx-kiro-power)
11
-
-[Quicklinks](#quicklinks)
12
-
-[Code of Conduct](#code-of-conduct)
13
-
-[Getting Started](#getting-started)
14
-
-[Issues](#issues)
15
-
-[Templates](#templates)
16
-
-[Pull Requests](#pull-requests)
17
-
-[Templates](#templates-1)
18
-
-[Resources](#resources)
10
+
-[Quicklinks](#quicklinks)
11
+
-[Code of Conduct](#code-of-conduct)
12
+
-[Getting Started](#getting-started)
13
+
-[Issues](#issues)
14
+
-[Templates](#templates)
15
+
-[Pull Requests](#pull-requests)
16
+
-[Templates](#templates-1)
17
+
-[Resources](#resources)
19
18
20
19
## Code of Conduct
21
20
@@ -42,6 +41,7 @@ If you find an Issue that addresses the problem you're having, please add your o
42
41
### Templates
43
42
44
43
The following templates will be used within Checkmarx github repositories
@@ -58,7 +58,7 @@ PRs to our source are always welcome and can be a quick way to get your fix or i
58
58
59
59
For changes that address core functionality or would require breaking changes (e.g. a major release), please open an Issue to discuss your proposal first.
60
60
61
-
In general, we follow the _fork-and-pull_ Git workflow
61
+
In general, we follow the *fork-and-pull* Git workflow
62
62
63
63
1. Fork the repository to your own Github account
64
64
2. Clone the project to your machine
@@ -67,7 +67,7 @@ In general, we follow the _fork-and-pull_ Git workflow
67
67
5. Push changes to your fork
68
68
6. Open a PR in our repository and follow the PR template so that we can efficiently review and assess the changes. *Ensure an associated Issue has been accepted by the Checkmarx team.*
69
69
70
-
### Templates
70
+
### Pull Request Template
71
71
72
72
The following template will be used within Checkmarx github repositories
Copy file name to clipboardExpand all lines: README.md
+20-14Lines changed: 20 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
# Checkmarx Developer Assist Power for Kiro
2
2
3
-
This repo is the public repo for installing the "Checkmarx Developer Assist" Power into the Kiro (Amazon's AI agent) IDE. A Kiro Power is a packaged extension that adds specialized capabilities to the Kiro AI development environment. Extensive docs on what powers are, how to install them, and how to use them can be found here: https://kiro.dev/docs/powers/.
3
+
This repo is the public repo for installing the "Checkmarx Developer Assist" Power into the Kiro (Amazon's AI agent) IDE. A Kiro Power is a packaged extension that adds specialized capabilities to the Kiro AI development environment. Extensive docs on what powers are, how to install them, and how to use them can be found here: <https://kiro.dev/docs/powers/>.
4
4
5
5
The Checkmarx Power brings AI-powered application security scanning directly into your development workflow, enabling real-time vulnerability detection and remediation for SAST, secrets, IaC, containers, and open source dependencies.
6
6
7
7
## How to Use
8
8
9
9
### Prerequisites
10
10
11
-
1.**Kiro IDE** - Free tier available at [kiro.ai](https://kiro.ai)
11
+
1.**Kiro IDE** - Free tier available at [kiro.dev/pricing](https://kiro.dev/pricing/)
12
12
2.**Checkmarx One Account** with Developer Assist enabled
13
13
- Subscribe via [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-xbxjoco7f6xwi)
14
14
- Or sign up at [Checkmarx One](https://checkmarx.com)
@@ -18,7 +18,7 @@ The Checkmarx Power brings AI-powered application security scanning directly int
18
18
19
19
### Installation
20
20
21
-
**Install via GitHub**
21
+
#### Install via GitHub
22
22
23
23
1. Open Kiro IDE
24
24
2. Access the Powers panel:
@@ -95,7 +95,7 @@ Once the Checkmarx Power is installed in the Kiro IDE, you'll be able to use all
95
95
96
96
Simply chat with Kiro and ask for security help:
97
97
98
-
```
98
+
```text
99
99
You: "Can you check if there are any security vulnerabilities in this code?"
100
100
101
101
Kiro: [Uses Checkmarx codeRemediation to scan and analyze]
@@ -120,6 +120,7 @@ For detailed workflows and examples, see [POWER.md](checkmarx-power/POWER.md).
120
120
**Solutions:**
121
121
122
122
1.**Verify your Checkmarx One base URL is correct**:
123
+
123
124
```bash
124
125
# Your URL should look like one of these:
125
126
https://eu.ast.checkmarx.net
@@ -134,6 +135,7 @@ For detailed workflows and examples, see [POWER.md](checkmarx-power/POWER.md).
134
135
- Generate a new key if needed
135
136
136
137
3.**Ensure the URL format in mcp.json is correct**:
138
+
137
139
```json
138
140
"url": "<base_url>/api/security-mcp/mcp"
139
141
```
@@ -151,23 +153,27 @@ For detailed workflows and examples, see [POWER.md](checkmarx-power/POWER.md).
151
153
### Remediation Tool Errors
152
154
153
155
**Error:** "Remediation not available for this risk type"
156
+
154
157
- Some risk types may require manual remediation
155
158
- Check [POWER.md](checkmarx-power/POWER.md) for supported remediation types
156
159
157
160
**Error:** "Package remediation failed"
161
+
158
162
- Verify the package name and version are correct
159
163
- Check if a remediated version exists in the package registry
160
164
- Consider alternative packages with equivalent functionality
161
165
162
166
**Error:** "Language not supported"
167
+
163
168
- ASCA currently supports: Java, JavaScript (Node.js), C#, Go, and Python
164
169
- Other languages may be added in future releases
165
170
166
171
### Verifying Your Setup
167
172
168
173
Run these checks to verify everything is working:
169
174
170
-
**1. Check MCP Configuration**
175
+
#### 1. Check MCP Configuration
176
+
171
177
```json
172
178
// Your mcp.json should have valid values (not placeholders):
173
179
{
@@ -183,16 +189,19 @@ Run these checks to verify everything is working:
183
189
}
184
190
```
185
191
186
-
**2. Test Authentication**
192
+
#### 2. Test Authentication
193
+
187
194
- Open Kiro chat
188
195
- Ask: "Can you use Checkmarx to check for vulnerabilities?"
189
196
- If configured correctly, Kiro will acknowledge it can use Checkmarx tools
190
197
191
-
**3. Verify Checkmarx One Access**
198
+
#### 3. Verify Checkmarx One Access
199
+
192
200
- Log in to your Checkmarx One portal in a browser
193
201
- Ensure you can access the portal successfully
194
202
195
-
**4. Check Power Installation**
203
+
#### 4. Check Power Installation
204
+
196
205
- In Kiro Powers panel, verify "Checkmarx" appears in the list
197
206
- Ensure it's enabled (not greyed out)
198
207
@@ -209,11 +218,10 @@ Run these checks to verify everything is working:
209
218
## Documentation & Support
210
219
211
220
-**Full Documentation**: See [POWER.md](checkmarx-power/POWER.md) for detailed workflows, troubleshooting, and best practices
0 commit comments