Skip to content

Commit 3cce2b7

Browse files
committed
Refactor documentation for clarity and consistency; remove unused .checkmarxIgnored file
1 parent 5db80e5 commit 3cce2b7

6 files changed

Lines changed: 81 additions & 43 deletions

File tree

.vscode/.checkmarxIgnored

Lines changed: 0 additions & 1 deletion
This file was deleted.

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,17 @@ Welcome and thank you for considering contributing to the Checkmarx Kiro Power p
44

55
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.
66

7-
87
## Quicklinks
98

109
- [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)
1918

2019
## Code of Conduct
2120

@@ -42,6 +41,7 @@ If you find an Issue that addresses the problem you're having, please add your o
4241
### Templates
4342

4443
The following templates will be used within Checkmarx github repositories
44+
4545
- [Feature Request Template](.github/ISSUE_TEMPLATE/feature_request.yml)
4646
- [Bug Report Template](.github/ISSUE_TEMPLATE/bug_report.yml)
4747

@@ -58,7 +58,7 @@ PRs to our source are always welcome and can be a quick way to get your fix or i
5858

5959
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.
6060

61-
In general, we follow the _fork-and-pull_ Git workflow
61+
In general, we follow the *fork-and-pull* Git workflow
6262

6363
1. Fork the repository to your own Github account
6464
2. Clone the project to your machine
@@ -67,7 +67,7 @@ In general, we follow the _fork-and-pull_ Git workflow
6767
5. Push changes to your fork
6868
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.*
6969

70-
### Templates
70+
### Pull Request Template
7171

7272
The following template will be used within Checkmarx github repositories
7373

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Checkmarx Developer Assist Power for Kiro
22

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/>.
44

55
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.
66

77
## How to Use
88

99
### Prerequisites
1010

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/)
1212
2. **Checkmarx One Account** with Developer Assist enabled
1313
- Subscribe via [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-xbxjoco7f6xwi)
1414
- Or sign up at [Checkmarx One](https://checkmarx.com)
@@ -18,7 +18,7 @@ The Checkmarx Power brings AI-powered application security scanning directly int
1818

1919
### Installation
2020

21-
**Install via GitHub**
21+
#### Install via GitHub
2222

2323
1. Open Kiro IDE
2424
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
9595

9696
Simply chat with Kiro and ask for security help:
9797

98-
```
98+
```text
9999
You: "Can you check if there are any security vulnerabilities in this code?"
100100
101101
Kiro: [Uses Checkmarx codeRemediation to scan and analyze]
@@ -120,6 +120,7 @@ For detailed workflows and examples, see [POWER.md](checkmarx-power/POWER.md).
120120
**Solutions:**
121121

122122
1. **Verify your Checkmarx One base URL is correct**:
123+
123124
```bash
124125
# Your URL should look like one of these:
125126
https://eu.ast.checkmarx.net
@@ -134,6 +135,7 @@ For detailed workflows and examples, see [POWER.md](checkmarx-power/POWER.md).
134135
- Generate a new key if needed
135136

136137
3. **Ensure the URL format in mcp.json is correct**:
138+
137139
```json
138140
"url": "<base_url>/api/security-mcp/mcp"
139141
```
@@ -151,23 +153,27 @@ For detailed workflows and examples, see [POWER.md](checkmarx-power/POWER.md).
151153
### Remediation Tool Errors
152154

153155
**Error:** "Remediation not available for this risk type"
156+
154157
- Some risk types may require manual remediation
155158
- Check [POWER.md](checkmarx-power/POWER.md) for supported remediation types
156159

157160
**Error:** "Package remediation failed"
161+
158162
- Verify the package name and version are correct
159163
- Check if a remediated version exists in the package registry
160164
- Consider alternative packages with equivalent functionality
161165

162166
**Error:** "Language not supported"
167+
163168
- ASCA currently supports: Java, JavaScript (Node.js), C#, Go, and Python
164169
- Other languages may be added in future releases
165170

166171
### Verifying Your Setup
167172

168173
Run these checks to verify everything is working:
169174

170-
**1. Check MCP Configuration**
175+
#### 1. Check MCP Configuration
176+
171177
```json
172178
// Your mcp.json should have valid values (not placeholders):
173179
{
@@ -183,16 +189,19 @@ Run these checks to verify everything is working:
183189
}
184190
```
185191

186-
**2. Test Authentication**
192+
#### 2. Test Authentication
193+
187194
- Open Kiro chat
188195
- Ask: "Can you use Checkmarx to check for vulnerabilities?"
189196
- If configured correctly, Kiro will acknowledge it can use Checkmarx tools
190197

191-
**3. Verify Checkmarx One Access**
198+
#### 3. Verify Checkmarx One Access
199+
192200
- Log in to your Checkmarx One portal in a browser
193201
- Ensure you can access the portal successfully
194202

195-
**4. Check Power Installation**
203+
#### 4. Check Power Installation
204+
196205
- In Kiro Powers panel, verify "Checkmarx" appears in the list
197206
- Ensure it's enabled (not greyed out)
198207

@@ -209,11 +218,10 @@ Run these checks to verify everything is working:
209218
## Documentation & Support
210219

211220
- **Full Documentation**: See [POWER.md](checkmarx-power/POWER.md) for detailed workflows, troubleshooting, and best practices
212-
- **Checkmarx Docs**: https://docs.checkmarx.com/en/34965-405960-checkmarx-developer-assist.html
213-
- **Kiro Powers Guide**: https://kiro.dev/docs/powers/
221+
- **Checkmarx Docs**: <https://docs.checkmarx.com/en/34965-405960-checkmarx-developer-assist.html>
222+
- **Kiro Powers Guide**: <https://kiro.dev/docs/powers/>
214223
- **Support**: Contact Checkmarx Support or your account team
215224

216-
217225
## Open Source Project Health
218226

219227
This repository includes standard FOSS governance files:
@@ -226,6 +234,4 @@ This repository includes standard FOSS governance files:
226234
- [Maintainers](MAINTAINERS.md)
227235
- [Code Owners](.github/CODEOWNERS)
228236

229-
Issue and pull request templates are available under .github/.
230-
231-
237+
Issue and pull request templates are available under .github/.

SECURITY.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,4 @@ Use the form in [VULNERABILITY_REPORT.md](VULNERABILITY_REPORT.md) when submitti
4040
## Safe Harbor
4141

4242
If you act in good faith, avoid privacy violations, and do not disrupt systems,
43-
we will treat your report as authorized security research.
44-
43+
we will treat your report as authorized security research.

VULNERABILITY_REPORT.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,4 @@ Submit this form privately via:
4040
## Disclosure Preferences
4141

4242
- Public disclosure preference:
43-
- Requested coordination timeline:
44-
43+
- Requested coordination timeline:

0 commit comments

Comments
 (0)