registry / @venizia/ignis-docs / 0.1.0

@venizia/ignis-docs@0.1.0

Interactive documentation site and MCP (Model Context Protocol) server for the Ignis Framework. Includes a VitePress-powered documentation site with guides, API references, and best practices. Ships an MCP server (CLI: ignis-docs-mcp) with 11 tools for AI

AI Security Review

scanned 44m ago · by lpm-firewall-ai

No confirmed malicious attack surface. The executable is a user-run MCP documentation server that reads bundled Markdown and exposes explicit tools for fixed-repository GitHub and npm registry lookups.

Static reason

One or more suspicious static signals were detected.

Trigger

User runs ignis-docs-mcp and invokes an MCP tool.

Impact

Returns requested documentation or public repository/package metadata; no credential collection, persistence, or mutation observed.

Mechanism

MCP documentation, source-browsing, and dependency-version lookup.

Rationale

The scanner signals are explained by an explicit MCP documentation service: documentation examples contain placeholder secrets, and network calls are user-invoked lookups to fixed public GitHub/npm endpoints. Source inspection found no install-time execution, harvesting, exfiltration, destructive behavior, or agent-control mutation.

Evidence

package.jsondist/mcp-server/index.jsdist/mcp-server/helpers/docs.helper.jsdist/mcp-server/helpers/github.helper.jsdist/mcp-server/tools/github/verify-dependencies.tool.jscontent/references/configuration/environment-variables.mddist/mcp-server/common/config.jsdist/mcp-server/common/paths.jsdist/mcp-server/tools/github/search-code.tool.jsdist/mcp-server/tools/github/list-project-files.tool.jsdist/mcp-server/tools/github/view-source-file.tool.js

Network endpoints3

api.github.comraw.githubusercontent.comregistry.npmjs.org

Decision evidence

public snapshot

AI called this Clean at 93.0% confidence as Benign with low false-positive risk.

Evidence for block

Evidence against

package.json has no preinstall, install, or postinstall hook; prepublishOnly is publisher-side build.
dist/mcp-server/index.js only starts an MCP stdio server after direct CLI execution.
dist/mcp-server/helpers/docs.helper.js reads bundled content/**/*.md for documentation search.
dist/mcp-server/helpers/github.helper.js only fetches the fixed VENIZIA-AI/ignis GitHub repository.
dist/mcp-server/tools/github/verify-dependencies.tool.js queries npm metadata only when its MCP tool is invoked.
No distributed JS uses child_process, eval/vm, or filesystem write/delete APIs.

Behavioral surface

Source

EnvironmentVarsFilesystemNetwork

Supply chain

HighEntropyStringsUrlStrings

ManifestNo manifest risk signals triggered.

scanned 23 file(s), 70.5 KB of source, external domains: api.github.com, raw.githubusercontent.com, registry.npmjs.org

Source & flagged code

23 flagged

content/references/configuration/environment-variables.mdView file

Lines 257-297markdown

257| `APP_ENV_MINIO_API_PORT` | No | `9000` | MinIO API port |

258| `APP_ENV_MINIO_ACCESS_KEY` | Yes* | - | Access key |

259| `APP_ENV_MINIO_SECRET_KEY` | Yes* | - | Secret key |

261

262*Required (by application convention) when wiring MinIO-backed storage.

263

264### Example

265

266```bash

267# Local MinIO

268APP_ENV_MINIO_HOST=localhost

269APP_ENV_MINIO_API_PORT=9000

270APP_ENV_MINIO_ACCESS_KEY=minioadmin

271APP_ENV_MINIO_SECRET_KEY=minioadmin

272APP_ENV_MINIO_USE_SSL=false

273

274# AWS S3

275APP_ENV_MINIO_HOST=s3.amazonaws.com

276APP_ENV_MINIO_API_PORT=443

277APP_ENV_MINIO_ACCESS_KEY=AKIAIOSFODNN7EXAMPLE

Critical

Critical Secret

Package contains a critical-looking secret pattern.

content/references/configuration/environment-variables.mdView on unpkg · L277

Critical

Secret Pattern

AWS access key ID in content/references/configuration/environment-variables.md

content/references/configuration/environment-variables.mdView on unpkg · L277

278APP_ENV_MINIO_SECRET_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

279APP_ENV_MINIO_USE_SSL=true

280```

281

282

283## Mail Variables

284

285> [!NOTE]

286> These are application-level conventions, not variables read by the framework. The Mail component's transporter receives its SMTP/OAuth2 configuration programmatically - your application wires these values in.

287

289|----------|----------|---------|-------------|

290| `APP_ENV_MAIL_HOST` | Yes* | - | SMTP host (e.g., `smtp.gmail.com`) |

291| `APP_ENV_MAIL_PORT` | No | - | SMTP port (e.g., `465`) |

292| `APP_ENV_MAIL_SECURE` | No | - | Use TLS |

293| `APP_ENV_MAIL_USER` | Yes* | - | SMTP username/email |

294| `APP_ENV_MAIL_CLIENT_ID` | Yes* | - | OAuth2 client ID |

295| `APP_ENV_MAIL_CLIENT_SECRET` | Yes* | - | OAuth2 client secret |

296| `APP_ENV_MAIL_REFRESH_TOKEN` | Yes* | - | OAuth2 refresh token |

297

content/references/base/repositories/advanced.mdView file

Lines 224-277markdown

224 hiddenProperties: ['password', 'secret', 'apiKey'],

225 },

226})

227export class User extends BaseEntity<typeof User.schema> {

228 static override schema = userTable;

229}

230```

231

232### Automatic Exclusion

233

234Hidden properties are excluded at the **SQL level** for maximum security:

235

236

content/references/base/models.mdView file

Lines 125-165markdown

125| `count()`, `existsWith()` | Can filter by hidden fields |

126| Direct connector query | **Included** (bypasses repository) |

127

128#### Important Notes

129

130- Hidden properties can still be used in `where` clauses for filtering

131- Data is still **stored** in the database - only excluded from query results

132- Use direct connector queries when you need to access hidden data:

content/extensions/components/mail/index.mdView file

Lines 311-351markdown

311**Internal queue (in-memory):**

312

313```typescript

314{

315 type: 'internal-queue',

316 internalQueue: {

317 identifier: 'mail-internal-queue',

318 },

319}

320```

content/extensions/helpers/redis/index.mdView file

Lines 101-141markdown

101| `onReady` | `(opts: { name: string; helper: IRedisHelper }) => void` | No | - | Fired when client is ready for commands |

102| `onError` | `(opts: { name: string; helper: IRedisHelper; error: unknown }) => void` | No | - | Fired on connection or command errors |

103

104### Retry strategy

105

106Backoff formula: `Math.max(Math.min(attempt * 2000, 5000), 1000)` - starting at 1 s, capped at 5 s. Reconnect stops when `attempt > maxRetry` (if `maxRetry > -1`). The framework always sets `maxRetriesPerRequest: null` internally, which is required for BullMQ compatibility.

content/extensions/helpers/kafka/schema-registry.mdView file

181patternName = generic_password severity = medium line = 181 matchedText = password...rd',

Medium

Secret Pattern

Hardcoded password in content/extensions/helpers/kafka/schema-registry.md

content/extensions/helpers/kafka/schema-registry.mdView on unpkg · L181

content/extensions/helpers/kafka/index.mdView file

209patternName = generic_password severity = medium line = 209 matchedText = password...rd',

Medium

Secret Pattern

Hardcoded password in content/extensions/helpers/kafka/index.md

content/extensions/helpers/kafka/index.mdView on unpkg · L209

content/extensions/helpers/queue/index.mdView file

132patternName = generic_password severity = medium line = 132 matchedText = password...rd',

Medium

Secret Pattern

Hardcoded password in content/extensions/helpers/queue/index.md

content/extensions/helpers/queue/index.mdView on unpkg · L132

465patternName = generic_password severity = medium line = 465 matchedText = password...rd',

Medium

Secret Pattern

Hardcoded password in content/extensions/helpers/queue/index.md

content/extensions/helpers/queue/index.mdView on unpkg · L465

content/guides/tutorials/building-a-crud-api.mdView file

139patternName = generic_password severity = medium line = 139 matchedText = const pa...ver!

Medium

Secret Pattern

Hardcoded password in content/guides/tutorials/building-a-crud-api.md

content/guides/tutorials/building-a-crud-api.mdView on unpkg · L139

content/best-practices/testing-strategies.mdView file

171patternName = generic_password severity = medium line = 171 matchedText = const us...' };

Medium

Secret Pattern

Hardcoded password in content/best-practices/testing-strategies.md

content/best-practices/testing-strategies.mdView on unpkg · L171

376patternName = generic_password severity = medium line = 376 matchedText = password...3!',

Medium

Secret Pattern

Hardcoded password in content/best-practices/testing-strategies.md

content/best-practices/testing-strategies.mdView on unpkg · L376

392patternName = generic_password severity = medium line = 392 matchedText = password...3!',

Medium

Secret Pattern

Hardcoded password in content/best-practices/testing-strategies.md

content/best-practices/testing-strategies.mdView on unpkg · L392

404patternName = generic_password severity = medium line = 404 matchedText = json: { ...' },

Medium

content/best-practices/code-style-standards/documentation.mdView file

73patternName = generic_password severity = medium line = 73 matchedText = * pass...3!',

Medium

Secret Pattern

Hardcoded password in content/best-practices/code-style-standards/documentation.md

content/best-practices/code-style-standards/documentation.mdView on unpkg · L73

Source & flagged code

23 flagged · loading source

content/references/configuration/environment-variables.mdView file

277patternName = aws_access_key severity = critical line = 277 matchedText = APP_ENV_...MPLE

Critical

Critical Secret

Package contains a critical-looking secret pattern.

content/references/configuration/environment-variables.mdView on unpkg · L277

277patternName = aws_access_key severity = critical line = 277 matchedText = APP_ENV_...MPLE

Critical

Secret Pattern

AWS access key ID in content/references/configuration/environment-variables.md

content/references/configuration/environment-variables.mdView on unpkg · L277

content/references/base/repositories/advanced.mdView file

244patternName = generic_password severity = medium line = 244 matchedText = data: { ...t' }

Medium

Secret Pattern

Hardcoded password in content/references/base/repositories/advanced.md

content/references/base/repositories/advanced.mdView on unpkg · L244

257patternName = generic_password severity = medium line = 257 matchedText = filter: ... } }

Medium

Secret Pattern

Hardcoded password in content/references/base/repositories/advanced.md

content/references/base/repositories/advanced.mdView on unpkg · L257

content/references/base/models.mdView file

145patternName = generic_password severity = medium line = 145 matchedText = // fullU....' }

Medium

Secret Pattern

Hardcoded password in content/references/base/models.md

content/references/base/models.mdView on unpkg · L145

content/extensions/components/mail/index.mdView file

331patternName = generic_password severity = medium line = 331 matchedText = password...rd',

Medium

Secret Pattern

Hardcoded password in content/extensions/components/mail/index.md

content/extensions/components/mail/index.mdView on unpkg · L331

content/extensions/helpers/redis/index.mdView file

121patternName = generic_password severity = medium line = 121 matchedText = redisOpt...' },

Medium

Secret Pattern

Hardcoded password in content/extensions/helpers/redis/index.md

content/extensions/helpers/redis/index.mdView on unpkg · L121

182patternName = generic_password severity = medium line = 182 matchedText = password...pass

Medium

Secret Pattern

Hardcoded password in content/extensions/helpers/redis/index.md

content/extensions/helpers/redis/index.mdView on unpkg · L182

296patternName = generic_password severity = medium line = 296 matchedText = password...et',

Medium

Secret Pattern

Hardcoded password in content/extensions/helpers/redis/index.md

content/extensions/helpers/redis/index.mdView on unpkg · L296

content/extensions/helpers/kafka/schema-registry.mdView file

181patternName = generic_password severity = medium line = 181 matchedText = password...rd',

Medium

Secret Pattern

Hardcoded password in content/extensions/helpers/kafka/schema-registry.md

content/extensions/helpers/kafka/schema-registry.mdView on unpkg · L181

content/extensions/helpers/kafka/index.mdView file

209patternName = generic_password severity = medium line = 209 matchedText = password...rd',

Medium

Secret Pattern

Hardcoded password in content/extensions/helpers/kafka/index.md

content/extensions/helpers/kafka/index.mdView on unpkg · L209

content/extensions/helpers/queue/index.mdView file

132patternName = generic_password severity = medium line = 132 matchedText = password...rd',

Medium

Secret Pattern

Hardcoded password in content/extensions/helpers/queue/index.md

content/extensions/helpers/queue/index.mdView on unpkg · L132

465patternName = generic_password severity = medium line = 465 matchedText = password...rd',

Medium

Secret Pattern

Hardcoded password in content/extensions/helpers/queue/index.md

content/extensions/helpers/queue/index.mdView on unpkg · L465

content/guides/tutorials/building-a-crud-api.mdView file

139patternName = generic_password severity = medium line = 139 matchedText = const pa...ver!

Medium

Secret Pattern

Hardcoded password in content/guides/tutorials/building-a-crud-api.md

content/guides/tutorials/building-a-crud-api.mdView on unpkg · L139

content/best-practices/testing-strategies.mdView file

171patternName = generic_password severity = medium line = 171 matchedText = const us...' };

Medium

Secret Pattern

Hardcoded password in content/best-practices/testing-strategies.md

content/best-practices/testing-strategies.mdView on unpkg · L171

376patternName = generic_password severity = medium line = 376 matchedText = password...3!',

Medium

Secret Pattern

Hardcoded password in content/best-practices/testing-strategies.md

content/best-practices/testing-strategies.mdView on unpkg · L376

392patternName = generic_password severity = medium line = 392 matchedText = password...3!',

Medium

Secret Pattern

Hardcoded password in content/best-practices/testing-strategies.md

content/best-practices/testing-strategies.mdView on unpkg · L392

404patternName = generic_password severity = medium line = 404 matchedText = json: { ...' },

Medium

Secret Pattern

Hardcoded password in content/best-practices/testing-strategies.md

content/best-practices/testing-strategies.mdView on unpkg · L404

409patternName = generic_password severity = medium line = 409 matchedText = json: { ...' },

Medium

Secret Pattern

Hardcoded password in content/best-practices/testing-strategies.md

content/best-practices/testing-strategies.mdView on unpkg · L409

420patternName = generic_password severity = medium line = 420 matchedText = json: { ...' },

Medium

Secret Pattern

Hardcoded password in content/best-practices/testing-strategies.md

content/best-practices/testing-strategies.mdView on unpkg · L420

449patternName = generic_password severity = medium line = 449 matchedText = json: { ...' },

Medium

Secret Pattern

Hardcoded password in content/best-practices/testing-strategies.md

content/best-practices/testing-strategies.mdView on unpkg · L449

452patternName = generic_password severity = medium line = 452 matchedText = json: { ...' },

Medium

Secret Pattern

Hardcoded password in content/best-practices/testing-strategies.md

content/best-practices/testing-strategies.mdView on unpkg · L452

content/best-practices/code-style-standards/documentation.mdView file

73patternName = generic_password severity = medium line = 73 matchedText = * pass...3!',

Medium

Secret Pattern

Hardcoded password in content/best-practices/code-style-standards/documentation.md

content/best-practices/code-style-standards/documentation.mdView on unpkg · L73

Findings

2 Critical23 Medium5 Low

CriticalCritical Secretcontent/references/configuration/environment-variables.md

CriticalSecret Patterncontent/references/configuration/environment-variables.md

MediumNetwork

MediumEnvironment Vars

MediumSecret Patterncontent/references/base/repositories/advanced.md

MediumSecret Patterncontent/references/base/models.md

MediumSecret Patterncontent/extensions/components/mail/index.md

MediumSecret Patterncontent/extensions/helpers/redis/index.md

MediumSecret Patterncontent/extensions/helpers/kafka/schema-registry.md

MediumSecret Patterncontent/extensions/helpers/kafka/index.md

MediumSecret Patterncontent/extensions/helpers/queue/index.md

MediumSecret Patterncontent/guides/tutorials/building-a-crud-api.md

MediumSecret Patterncontent/best-practices/testing-strategies.md

MediumSecret Patterncontent/best-practices/code-style-standards/documentation.md

LowNon Install Lifecycle Scripts

LowScripts Present

LowFilesystem

LowHigh Entropy Strings

LowUrl Strings

Source & flagged code

23 flagged

content/references/configuration/environment-variables.mdView file

Lines 257-297markdown

257| `APP_ENV_MINIO_API_PORT` | No | `9000` | MinIO API port |

258| `APP_ENV_MINIO_ACCESS_KEY` | Yes* | - | Access key |

259| `APP_ENV_MINIO_SECRET_KEY` | Yes* | - | Secret key |

261

262*Required (by application convention) when wiring MinIO-backed storage.

263

264### Example

265

266```bash

267# Local MinIO

268APP_ENV_MINIO_HOST=localhost

269APP_ENV_MINIO_API_PORT=9000

270APP_ENV_MINIO_ACCESS_KEY=minioadmin

271APP_ENV_MINIO_SECRET_KEY=minioadmin

272APP_ENV_MINIO_USE_SSL=false

273

274# AWS S3

275APP_ENV_MINIO_HOST=s3.amazonaws.com

276APP_ENV_MINIO_API_PORT=443

277APP_ENV_MINIO_ACCESS_KEY=AKIAIOSFODNN7EXAMPLE

Critical

Critical Secret

Package contains a critical-looking secret pattern.

content/references/configuration/environment-variables.mdView on unpkg · L277

Critical

Secret Pattern

AWS access key ID in content/references/configuration/environment-variables.md

content/references/configuration/environment-variables.mdView on unpkg · L277

278APP_ENV_MINIO_SECRET_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

279APP_ENV_MINIO_USE_SSL=true

280```

281

282

283## Mail Variables

284

285> [!NOTE]

287

289|----------|----------|---------|-------------|

290| `APP_ENV_MAIL_HOST` | Yes* | - | SMTP host (e.g., `smtp.gmail.com`) |

291| `APP_ENV_MAIL_PORT` | No | - | SMTP port (e.g., `465`) |

292| `APP_ENV_MAIL_SECURE` | No | - | Use TLS |

293| `APP_ENV_MAIL_USER` | Yes* | - | SMTP username/email |

294| `APP_ENV_MAIL_CLIENT_ID` | Yes* | - | OAuth2 client ID |

295| `APP_ENV_MAIL_CLIENT_SECRET` | Yes* | - | OAuth2 client secret |

296| `APP_ENV_MAIL_REFRESH_TOKEN` | Yes* | - | OAuth2 refresh token |

297

content/references/base/repositories/advanced.mdView file

Lines 224-277markdown

224 hiddenProperties: ['password', 'secret', 'apiKey'],

225 },

226})

227export class User extends BaseEntity<typeof User.schema> {

228 static override schema = userTable;

229}

230```

231

232### Automatic Exclusion

233

234Hidden properties are excluded at the **SQL level** for maximum security:

235

236

content/references/base/models.mdView file

Lines 125-165markdown

125| `count()`, `existsWith()` | Can filter by hidden fields |

126| Direct connector query | **Included** (bypasses repository) |

127

128#### Important Notes

129

130- Hidden properties can still be used in `where` clauses for filtering

131- Data is still **stored** in the database - only excluded from query results

132- Use direct connector queries when you need to access hidden data:

content/extensions/components/mail/index.mdView file

Lines 311-351markdown

311**Internal queue (in-memory):**

312

313```typescript

314{

315 type: 'internal-queue',

316 internalQueue: {

317 identifier: 'mail-internal-queue',

318 },

319}

320```

content/extensions/helpers/redis/index.mdView file

Lines 101-141markdown

101| `onReady` | `(opts: { name: string; helper: IRedisHelper }) => void` | No | - | Fired when client is ready for commands |

102| `onError` | `(opts: { name: string; helper: IRedisHelper; error: unknown }) => void` | No | - | Fired on connection or command errors |

103

104### Retry strategy

105

content/extensions/helpers/kafka/schema-registry.mdView file

181patternName = generic_password severity = medium line = 181 matchedText = password...rd',

Medium

Secret Pattern

Hardcoded password in content/extensions/helpers/kafka/schema-registry.md

content/extensions/helpers/kafka/schema-registry.mdView on unpkg · L181

content/extensions/helpers/kafka/index.mdView file

209patternName = generic_password severity = medium line = 209 matchedText = password...rd',

Medium

Secret Pattern

Hardcoded password in content/extensions/helpers/kafka/index.md

content/extensions/helpers/kafka/index.mdView on unpkg · L209

content/extensions/helpers/queue/index.mdView file

132patternName = generic_password severity = medium line = 132 matchedText = password...rd',

Medium

Secret Pattern

Hardcoded password in content/extensions/helpers/queue/index.md

content/extensions/helpers/queue/index.mdView on unpkg · L132

465patternName = generic_password severity = medium line = 465 matchedText = password...rd',

Medium

Secret Pattern

Hardcoded password in content/extensions/helpers/queue/index.md

content/extensions/helpers/queue/index.mdView on unpkg · L465

content/guides/tutorials/building-a-crud-api.mdView file

139patternName = generic_password severity = medium line = 139 matchedText = const pa...ver!

Medium

Secret Pattern

Hardcoded password in content/guides/tutorials/building-a-crud-api.md

content/guides/tutorials/building-a-crud-api.mdView on unpkg · L139

content/best-practices/testing-strategies.mdView file

171patternName = generic_password severity = medium line = 171 matchedText = const us...' };

Medium

Secret Pattern

Hardcoded password in content/best-practices/testing-strategies.md

content/best-practices/testing-strategies.mdView on unpkg · L171

376patternName = generic_password severity = medium line = 376 matchedText = password...3!',

Medium

Secret Pattern

Hardcoded password in content/best-practices/testing-strategies.md

content/best-practices/testing-strategies.mdView on unpkg · L376

392patternName = generic_password severity = medium line = 392 matchedText = password...3!',

Medium

Secret Pattern

Hardcoded password in content/best-practices/testing-strategies.md

content/best-practices/testing-strategies.mdView on unpkg · L392

404patternName = generic_password severity = medium line = 404 matchedText = json: { ...' },

Medium

content/best-practices/code-style-standards/documentation.mdView file

73patternName = generic_password severity = medium line = 73 matchedText = * pass...3!',

Medium

Secret Pattern

Hardcoded password in content/best-practices/code-style-standards/documentation.md

content/best-practices/code-style-standards/documentation.mdView on unpkg · L73