Skip to main content
Glama
EricSeokgon

egovframe-scaffold-mcp

by EricSeokgon

CI 워크플로 생성

generate_egovframe_ci

Generate complete CI pipelines for GitHub, GitLab, and Jenkins. Configure builds, tests, and supply chain security gates, including SBOM generation and vulnerability checks.

Instructions

프로젝트에 CI 설정을 생성합니다 — platform=github(.github/workflows/egovframe-ci.yml, 기본)·gitlab(.gitlab-ci.yml)·jenkins(Jenkinsfile, Declarative). 빌드도구(maven/gradle) 자동 감지, JDK 지정, 빌드·테스트(GitLab 은 JUnit 리포트). supplyChain=true 면 이 서버의 CLI(npx egovframe-scaffold-mcp)로 SBOM 생성 → 최소 요소 7종 점검(sbom-check --fail-on minimum) → 전환 준비도 평가서(failOn 기준, 기본 supplyChain:D)를 돌려 기준을 넘으면 실패하고 보고서·SBOM 을 아티팩트로 남기는 공급망 게이트를 추가합니다(GitHub 은 PR 요약에 등급, GitLab 은 CycloneDX 리포트). npmRegistry(사내 npm 레지스트리)·offlineBundle(러너에서 본 오프라인 번들 경로)은 환경 변수로 넣습니다. Maven 빌드 단계는 원격 저장소 일시 장애(5xx·연결 끊김)일 때만 -U 로 최대 3회 다시 실행하고, mavenMirror 로 사내 미러를 지정할 수 있습니다. dryRun으로 내용만 미리볼 수 있고, 실제 생성 시 기존 파일이 있으면 덮어쓰지 않고 거부합니다. delivery=true 면 게이트 끝에 납품 패키지 단계(deliver --write → egovframe-delivery/)를 더해 아티팩트로 남깁니다.

Input Schema

NameRequiredDescriptionDefault
jdkNoJDK 버전 (기본 17, 숫자·점만 허용)17
osvNo공급망 게이트에서 OSV 취약점 조회(--offline=false)
dryRunNotrue면 파일 생성 없이 내용만 반환
failOnNo공급망 게이트(평가서)의 --fail-on 식supplyChain:D
deliveryNov1.1: 게이트 끝에 납품 패키지 단계 추가(deliver --write → egovframe-delivery/ 를 아티팩트로 보관, 실패 항목이 있으면 단계 실패). supplyChain=true 필요
platformNoCI 플랫폼: github(GitHub Actions, 기본) | gitlab(.gitlab-ci.yml) | jenkins(Jenkinsfile, Declarative)github
supplierNoSBOM 공급자(pom <organization><name> 이 없으면 최소 요소 '공급자'가 빠져 게이트가 실패하므로 지정)
projectDirYes프로젝트 디렉터리(절대경로 권장)
mavenMirrorNov1.6: 사내 Maven 미러 URL(Nexus·Artifactory 프록시). 빌드 단계는 모든 저장소(*)를 이 미러로 보내는 settings 를 -gs 로 쓰고, 게이트의 CLI 단계는 EGOVFRAME_MAVEN_MIRROR 로 받습니다. Maven 빌드에만 적용
npmRegistryNo사내 npm 레지스트리 URL(NPM_CONFIG_REGISTRY 로 설정 — npx 가 이 서버를 받는 곳)
supplyChainNotrue 면 공급망 게이트 추가: SBOM 생성 → 최소 요소 점검(--fail-on minimum) → 전환 준비도 평가서(failOn) → 아티팩트
secureCodingNov0.44: 게이트에 보안약점 점검 단계 추가(secure --fail-on high, SARIF 를 GitHub code scanning 에 업로드·GitLab·Jenkins 는 보관)
offlineBundleNo폐쇄망 러너·에이전트에서 본 오프라인 번들 경로(EGOVFRAME_OFFLINE_BUNDLE 로 설정)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.6.0
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / mavenMirror
      Added value: +{
      +  "description": "v1.6: 사내 Maven 미러 URL(Nexus·Artifactory 프록시). 빌드 단계는 모든 저장소(*)를 이 미러로 보내는 settings 를 -gs 로 쓰고, 게이트의 CLI 단계는 EGOVFRAME_MAVEN_MIRROR 로 받습니다. Maven 빌드에만 적용",
      +  "pattern": "^https?:\\/\\/[A-Za-z0-9.\\-]+(?::\\d{1,5})?(?:\\/[A-Za-z0-9._~%\\-\\/]*)?$",
      +  "type": "string"
      +}
  2. Changed1 schema field changedv1.2.0
    • addedInput schema / properties / delivery
      Added value: +{
      +  "default": false,
      +  "description": "v1.1: 게이트 끝에 납품 패키지 단계 추가(deliver --write → egovframe-delivery/ 를 아티팩트로 보관, 실패 항목이 있으면 단계 실패). supplyChain=true 필요",
      +  "type": "boolean"
      +}
  3. Changed7 schema fields changedv0.45.0
    • changedInput schema / properties / failOn / description
      Previous value: -"공급망 게이트의 --fail-on 식"New value: +"공급망 게이트(평가서)의 --fail-on 식"
    • addedInput schema / properties / npmRegistry
      Added value: +{
      +  "description": "사내 npm 레지스트리 URL(NPM_CONFIG_REGISTRY 로 설정 — npx 가 이 서버를 받는 곳)",
      +  "pattern": "^https?:\\/\\/[A-Za-z0-9.\\-]+(?::\\d{1,5})?(?:\\/[A-Za-z0-9._~%\\-\\/]*)?$",
      +  "type": "string"
      +}
    • addedInput schema / properties / offlineBundle
      Added value: +{
      +  "description": "폐쇄망 러너·에이전트에서 본 오프라인 번들 경로(EGOVFRAME_OFFLINE_BUNDLE 로 설정)",
      +  "pattern": "^(?:\\/|[A-Za-z]:[\\\\/])[A-Za-z0-9_.\\/\\\\: -]{0,250}$",
      +  "type": "string"
      +}
    • addedInput schema / properties / platform
      Added value: +{
      +  "default": "github",
      +  "description": "CI 플랫폼: github(GitHub Actions, 기본) | gitlab(.gitlab-ci.yml) | jenkins(Jenkinsfile, Declarative)",
      +  "enum": [
      +    "github",
      +    "gitlab",
      +    "jenkins"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / secureCoding
      Added value: +{
      +  "default": false,
      +  "description": "v0.44: 게이트에 보안약점 점검 단계 추가(secure --fail-on high, SARIF 를 GitHub code scanning 에 업로드·GitLab·Jenkins 는 보관)",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / supplier
      Added value: +{
      +  "description": "SBOM 공급자(pom <organization><name> 이 없으면 최소 요소 '공급자'가 빠져 게이트가 실패하므로 지정)",
      +  "pattern": "^[\\p{L}\\p{N}][\\p{L}\\p{N} .,&()_-]{0,99}$",
      +  "type": "string"
      +}
    • changedInput schema / properties / supplyChain / description
      Previous value: -"true 면 공급망 게이트 job 추가(v0.39): SBOM 생성 → 전환 준비도 평가서(등급을 PR 요약에) → 아티팩트, failOn 기준 초과 시 실패"New value: +"true 면 공급망 게이트 추가: SBOM 생성 → 최소 요소 점검(--fail-on minimum) → 전환 준비도 평가서(failOn) → 아티팩트"
  4. Changed3 schema fields changedv0.40.0
    • addedInput schema / properties / failOn
      Added value: +{
      +  "default": "supplyChain:D",
      +  "description": "공급망 게이트의 --fail-on 식",
      +  "pattern": "^(?:(?:migration|supplyChain):[ABCD]|[A-Za-z]+(?:>=?\\d+)?)(?:,(?:(?:migration|supplyChain):[ABCD]|[A-Za-z]+(?:>=?\\d+)?))*$",
      +  "type": "string"
      +}
    • addedInput schema / properties / osv
      Added value: +{
      +  "default": true,
      +  "description": "공급망 게이트에서 OSV 취약점 조회(--offline=false)",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / supplyChain
      Added value: +{
      +  "default": false,
      +  "description": "true 면 공급망 게이트 job 추가(v0.39): SBOM 생성 → 전환 준비도 평가서(등급을 PR 요약에) → 아티팩트, failOn 기준 초과 시 실패",
      +  "type": "boolean"
      +}
  5. Changed2 schema fields changedv0.36.1
    • changedInput schema / properties / jdk / description
      Previous value: -"JDK 버전 (기본 17)"New value: +"JDK 버전 (기본 17, 숫자·점만 허용)"
    • addedInput schema / properties / jdk / pattern
      Added value: +"^[0-9]{1,2}(\\.[0-9]{1,3}){0,2}$"
  6. Addedv0.19.0

TDQS

A4.3/5.0
Behavior5/5

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

Goes well beyond the annotations (readOnly=false, destructive=false, idempotent=false): it discloses that existing files are refused rather than overwritten, that Maven builds retry up to 3 times with -U only on 5xx/connection drops, and that gate failures produce artifacts and a PR grade. These are exactly the side-effect nuances the hints cannot convey.

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

Conciseness3/5

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

The purpose is front-loaded and no sentence is pure filler, but the body is a single dense paragraph packing supply-chain, mirror, retry, dryRun and delivery branches together. It would read faster as short labeled clauses; as-is it demands re-reading.

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

Completeness5/5

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

For a 13-parameter mutating tool with no output schema, the description covers conditional interactions (delivery requires supplyChain), failure semantics, environment-variable plumbing, and overwrite refusal. An agent has enough to invoke it correctly in every mode.

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

Parameters3/5

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

Schema description coverage is 100%, so parameters are already documented; the description largely restates them. It does add a little meaning (npmRegistry/offlineBundle are injected as environment variables, mavenMirror applies only to Maven builds), but this duplicates what the schema descriptions already state.

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

Purpose5/5

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

Opens with a specific verb+resource ('프로젝트에 CI 설정을 생성합니다') and immediately enumerates the concrete artifacts per platform (.github/workflows/egovframe-ci.yml, .gitlab-ci.yml, Jenkinsfile). An agent can distinguish this from generate_egovframe_deploy or generate_egovframe_config without inspecting the schema.

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 clear conditional guidance: dryRun to preview, supplyChain=true to add the gate, delivery=true requires supplyChain. However, it never names an alternative sibling (e.g. when to prefer generate_egovframe_deploy for delivery vs. the delivery=true flag here), so routing is inferred rather than explicit.

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