Skip to main content
Glama
Sign In
Lex6won

vibecode-checker

by Lex6won
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

render_report

Converts scan_code/scan_path ScanReport JSON into Korean audit reports, saving Markdown, HTML, both, or SARIF to .check-reports for consistent security history.

Instructions

ScanReport(scan_code / scan_path 결과)를 한국어 보고서로 만들고 파일로 저장합니다.

⚠️ 중요 — 반환된 내용을 별도 파일로 다시 저장하지 마세요. 이 도구가 이미 표준 위치에 저장했습니다. 반환값의 saved 에 담긴 경로를 사용자에게 그대로 알려 주세요. 에이전트가 임의 위치·이름으로 다시 저장하면 조직의 점검 이력이 흩어져 나중에 찾을 수 없습니다.

저장 규약: <검사한 경로>/.check-reports/YYYY-MM-DD_HHMM_보안점검.{html,md,json} (기관 공용 폴더로 모으려면 환경변수 GVSKB_REPORT_DIR 을 설정합니다)

형식:

  • format="markdown": Markdown 본문(기본)

  • format="html": 자체 포함 단일 HTML(외부 CDN·JS 없음, 인쇄→PDF·이메일 가능)

  • format="both": Markdown + HTML 모두

  • format="sarif": SARIF 2.1.0 (CI·보안도구 연동, GitHub code scanning 업로드)

저장이 필요 없으면 save=False 로 문자열만 받습니다(파이프 연결 등). 출력은 자체 완결적이라 비전공 이해관계자 공유나 내부 승인 기록 첨부에 적합합니다.

Input Schema

NameRequiredDescriptionDefault
saveNo파일로도 저장할지(기본 True). False 면 문자열만 반환합니다
formatNomarkdown(기본) | html(자체 포함 단일 파일) | both | sarif(CI 연동용 SARIF 2.1.0)markdown
reportYesscan_code / scan_path 가 반환한 ScanReport JSON 을 그대로 전달 (필수 키: target, summary, findings — 직접 조립하지 말 것). scan_dependencies 결과가 있으면 dependency_audit 키에 넣어 병합 가능
output_dirNo저장 폴더 지정(선택). 미지정 시 <검사한 경로>/.check-reports/

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.5.4
    • addedInput schema / properties / format / description
      Added value: +"markdown(기본) | html(자체 포함 단일 파일) | both | sarif(CI 연동용 SARIF 2.1.0)"
    • addedInput schema / properties / output_dir
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "저장 폴더 지정(선택). 미지정 시 <검사한 경로>/.check-reports/"
+}
    • addedInput schema / properties / report / description
      Added value: +"scan_code / scan_path 가 반환한 ScanReport JSON 을 그대로 전달 (필수 키: target, summary, findings — 직접 조립하지 말 것). scan_dependencies 결과가 있으면 dependency_audit 키에 넣어 병합 가능"
    • addedInput schema / properties / save
      Added value: +{
+  "default": true,
+  "description": "파일로도 저장할지(기본 True). False 면 문자열만 반환합니다",
+  "type": "boolean"
+}
  2. Changed1 schema field changedv0.2.1
    • changedInput schema / properties / format / enum
      Previous value: -[
-  "markdown",
-  "html",
-  "both"
-]New value: +[
+  "markdown",
+  "html",
+  "both",
+  "sarif"
+]
  3. First observedv0.1.0

TDQS

A4.2/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations at all, the description carries the full load and does so well: it discloses the exact save location convention, the GVSKB_REPORT_DIR env override, that the HTML is self-contained with no CDN/JS, that output is self-contained enough for stakeholder sharing, and the side effect that files are written at a standard location rather than by the agent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose is front-loaded and the warning precedes the details, which is the right ordering. The format bullet list partially restates the schema enum descriptions, so a small amount of the text is redundant with structured data.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists and the description correctly leans on the returned 'saved' path rather than re-explaining return values, and it covers input provenance, formats, save behavior and location override. The remaining gap is the unaddressed relationship to the save_report sibling.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is already 100%, so the baseline is 3. The description goes beyond it by explaining what each format enum value is actually good for and by surfacing the GVSKB_REPORT_DIR environment variable, which appears nowhere in the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('ScanReport → Korean report, saved to file'), names the input-producing siblings (scan_code/scan_path), and enumerates output formats. It does not, however, differentiate itself from the sibling save_report, so an agent cannot tell the two apart from this text alone.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives concrete when-to-use guidance per format (html for print→PDF/email, sarif for CI/GitHub code scanning, save=False for piping) and a strong when-not-to-do ('do not re-save the returned content'). The one missing piece is that it never mentions the save_report sibling as an alternative, which matters given the overlapping purpose.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools