reverse-scan-interfaces

Identify external system integration points and generate Markdown Interface Definition Documents.

Updated Mar 27, 2026
One-click install
npx skills add https://github.com/bs-koo/gx-pm --skill reverse-scan-interfaces
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: reverse-scan-interfaces
Source: https://github.com/bs-koo/gx-pm/tree/main/plugins/gx-pm/skills/reverse-scan-interfaces
Command: npx skills add https://github.com/bs-koo/gx-pm --skill reverse-scan-interfaces

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

소스코드에서 외부 시스템 연동 지점을 식별하고 인터페이스 정의서를 역생성하는 자동화 도구입니다.

Core Features & Use Cases

  • 외부 연동 지점 탐지: REST/HTTP 클라이언트 호출 및 어노테이션을 식별
  • 인터페이스 정의 생성: 송신/수신 시스템, 엔드포인트, 메서드, 파라미터 등의 정의를 표로 생성
  • 그룹핑 및 관리: 연동 시스템별로 그룹화하고 요구사항 매핑
  • 산출물 자동화: Interface Definition Document를 MD로 출력

Quick Start

소스 코드를 스캔해 외부 인터페이스를 역생성한 인터페이스정의서를 출력한다.

Frequently Asked Questions about reverse-scan-interfaces

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I reverse-engineer external API interfaces from existing source code?

Reverse-engineering external API interfaces from source code involves scanning Java or TypeScript projects to identify HTTP client calls and integration annotations, then generating a Markdown interface definition document with endpoints, methods, and parameters.

Can I detect external system integration points in both Java and JavaScript projects?

Yes, external system integration points can be detected in both Java and JavaScript projects by identifying REST/HTTP client calls and integration annotations, grouping them by target systems to map requirements accurately.

How to generate an interface definition document from code automatically?

Generating an interface definition document automatically requires scanning source code for external integration points, extracting endpoint and parameter definitions, grouping by target system, and outputting the results as a Markdown file.

What's the best way to group external API calls by target system for documentation?

Grouping external API calls by target system for documentation is achieved by analyzing HTTP client integrations in the codebase, extracting transaction fields and traceability IDs, and organizing them into structured Markdown tables.

Does this code analysis tool require any specific dependencies to scan TypeScript projects?

No specific dependencies are required to scan TypeScript projects for interface definition generation. The tool analyzes source code directly to identify HTTP client calls and integration annotations without external library dependencies.

What limitations exist when reverse-engineering interfaces from code without explicit annotations?

When reverse-engineering interfaces from code without explicit annotations, detection relies on identifying HTTP client calls. The process is optimized for Java and JavaScript/TypeScript projects using standard REST integration patterns to ensure accurate interface definition extraction.