@aikidosec/mcp 0.0.1 → 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 +674 -0
- package/README.dev.md +46 -0
- package/README.md +82 -2
- package/dist/assets/gitleaks.aikido.toml +1668 -0
- package/dist/assets/gitleaks_linux_arm64 +0 -0
- package/dist/assets/gitleaks_linux_x32 +0 -0
- package/dist/assets/gitleaks_linux_x64 +0 -0
- package/dist/assets/gitleaks_mac_arm64 +0 -0
- package/dist/assets/gitleaks_mac_x64 +0 -0
- package/dist/assets/gitleaks_win_arm64.exe +0 -0
- package/dist/assets/gitleaks_win_x32.exe +0 -0
- package/dist/assets/gitleaks_win_x64.exe +0 -0
- package/dist/index.js +458 -0
- package/package.json +41 -5
package/README.dev.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Developer Guide for aikido-mcp-server
|
|
2
|
+
A TypeScript implementation of an MCP (Model Context Protocol).
|
|
3
|
+
|
|
4
|
+
## Project Structure
|
|
5
|
+
- `src/` — TypeScript source code
|
|
6
|
+
- `dist/` — Compiled output (after build)
|
|
7
|
+
- `build.js` — Build script
|
|
8
|
+
- `.github/workflows/` — CI/CD workflows
|
|
9
|
+
|
|
10
|
+
## Development Setup
|
|
11
|
+
1. Install dependencies:
|
|
12
|
+
```sh
|
|
13
|
+
npm install
|
|
14
|
+
```
|
|
15
|
+
2. Build the project:
|
|
16
|
+
```sh
|
|
17
|
+
npm run build
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Testing MCP Locally Using [modelcontextprotocol/inspector](https://github.com/modelcontextprotocol/inspector)
|
|
21
|
+
```sh
|
|
22
|
+
npm run mcp-inspect
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Example mcp.json File to Test Integration in IDEs
|
|
26
|
+
```json
|
|
27
|
+
{
|
|
28
|
+
"mcpServers": {
|
|
29
|
+
"aikido": {
|
|
30
|
+
"type": "local",
|
|
31
|
+
"command": "node",
|
|
32
|
+
"args": [
|
|
33
|
+
"PATH_TO_REPO_ON_YOUR_MACHINE/aikido-mcp-server/dist/index.js"
|
|
34
|
+
],
|
|
35
|
+
"environment": {
|
|
36
|
+
"AIKIDO_API_KEY": "your-api-key-here"
|
|
37
|
+
},
|
|
38
|
+
"allowedTools": [
|
|
39
|
+
"aikido_sast_scan",
|
|
40
|
+
"aikido_full_scan",
|
|
41
|
+
"aikido_secrets_scan"
|
|
42
|
+
]
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
```
|
package/README.md
CHANGED
|
@@ -1,2 +1,82 @@
|
|
|
1
|
-
# Aikido MCP
|
|
2
|
-
|
|
1
|
+
# Aikido MCP Server
|
|
2
|
+
|
|
3
|
+
A lightweight Model Context Protocol (MCP) server that exposes Aikido’s Code and Secrets Scan as a tool for AI coding agents and IDEs. It lets your agent scan code and returns machine-readable findings you can triage or fix.
|
|
4
|
+
|
|
5
|
+
## Prerequisites
|
|
6
|
+
- **Node.js** 18 or newer
|
|
7
|
+
- An **Aikido API key** (get yours from [Aikido Security](https://app.aikido.dev))
|
|
8
|
+
|
|
9
|
+
## Configuration
|
|
10
|
+
|
|
11
|
+
### API Key Setup
|
|
12
|
+
|
|
13
|
+
The MCP server requires an Aikido API key to authenticate with the Aikido API. You can provide it in two ways:
|
|
14
|
+
|
|
15
|
+
1. **Via MCP Configuration (Recommended)**: Set the `AIKIDO_API_KEY` environment variable in your MCP configuration file
|
|
16
|
+
2. **Via System Environment Variable**: Set `AIKIDO_API_KEY` as a system environment variable
|
|
17
|
+
|
|
18
|
+
## Add to your IDE or agent
|
|
19
|
+
Below are example configurations to add to your the Aikido MCP to your IDE.
|
|
20
|
+
|
|
21
|
+
### Cursor
|
|
22
|
+
|
|
23
|
+
Go to `Settings` > `Cursor Settings` > `MCP & Integrations` > `New MCP server`
|
|
24
|
+
|
|
25
|
+
Add the following configuration to your Cursor `~/.cursor/mcp.json` file. See [Cursor MCP docs](https://docs.cursor.com/en/context/mcp) for more info.
|
|
26
|
+
|
|
27
|
+
```json
|
|
28
|
+
{
|
|
29
|
+
"mcpServers": {
|
|
30
|
+
"aikido": {
|
|
31
|
+
"command": "npx",
|
|
32
|
+
"args": ["-y", "@aikidosec/mcp"],
|
|
33
|
+
"env": {
|
|
34
|
+
"AIKIDO_API_KEY": "your-api-key-here"
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
**Note**: Replace `"your-api-key-here"` with your actual Aikido API key.
|
|
42
|
+
|
|
43
|
+
### Windsurf
|
|
44
|
+
|
|
45
|
+
Add the following config to `~/.codeium/windsurf/mcp_config.json`. See [Windsurf MCP docs](https://docs.windsurf.com/windsurf/cascade/mcp) for more info.
|
|
46
|
+
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"mcpServers": {
|
|
50
|
+
"aikido": {
|
|
51
|
+
"command": "npx",
|
|
52
|
+
"args": ["-y", "@aikidosec/mcp"],
|
|
53
|
+
"env": {
|
|
54
|
+
"AIKIDO_API_KEY": "your-api-key-here"
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
**Note**: Replace `"your-api-key-here"` with your actual Aikido API key.
|
|
62
|
+
|
|
63
|
+
### VS Code
|
|
64
|
+
|
|
65
|
+
Open the VS Code Command Palette by using Ctrl+⇧Shift+P or ⌘Command+⇧Shift+P (macOS). Type `MCP: Open User Configuration`.
|
|
66
|
+
Add the following config to the MCP config file. See [VS Code MCP docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more info.
|
|
67
|
+
|
|
68
|
+
```json
|
|
69
|
+
{
|
|
70
|
+
"servers": {
|
|
71
|
+
"aikido": {
|
|
72
|
+
"command": "npx",
|
|
73
|
+
"args": ["-y", "@aikidosec/mcp"],
|
|
74
|
+
"env": {
|
|
75
|
+
"AIKIDO_API_KEY": "your-api-key-here"
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
**Note**: Replace `"your-api-key-here"` with your actual Aikido API key.
|