OpenAPI MCP 서버

OpenAPI 엔드포인트를 MCP 리소스로 노출하는 모델 컨텍스트 프로토콜(MCP) 서버입니다. 이 서버를 통해 대규모 언어 모델(Large Language Models)이 MCP 프로토콜을 통해 OpenAPI 사양에 정의된 REST API를 검색하고 상호 작용할 수 있습니다.

빠른 시작

이 MCP 서버를 사용하기 위해 이 저장소를 복제할 필요는 없습니다. Claude Desktop에서 간단히 구성할 수 있습니다.

1. Claude Desktop 구성 파일을 찾거나 만드세요.
   • macOS의 경우: ~/Library/Application Support/Claude/claude_desktop_config.json
2. OpenAPI MCP 서버를 활성화하려면 다음 구성을 추가하세요.

지엑스피1

3. 환경 변수를 실제 API 구성으로 바꾸세요.
   • API_BASE_URL : API의 기본 URL
   • OPENAPI_SPEC_PATH : OpenAPI 사양에 대한 URL 또는 경로
   • API_HEADERS : API 인증 헤더에 대한 쉼표로 구분된 키:값 쌍

개발 도구

이 프로젝트에는 워크플로를 보다 쉽게 만들어주는 여러 가지 개발 도구가 포함되어 있습니다.

건물

• npm run build - TypeScript 소스를 빌드합니다.
• npm run clean - 빌드 아티팩트 제거
• npm run typecheck - TypeScript 유형 검사를 실행합니다.

개발 모드

• npm run dev - 소스 파일을 감시하고 변경 사항을 다시 빌드합니다.
• npm run inspect-watch - 변경 사항에 대한 자동 다시 로드와 함께 검사기를 실행합니다.

코드 품질

• npm run lint - ESLint 실행
• npm run typecheck - TypeScript 유형을 확인합니다.

구성

서버는 환경 변수나 명령줄 인수를 통해 구성할 수 있습니다.

환경 변수

• API_BASE_URL - API 엔드포인트의 기본 URL
• OPENAPI_SPEC_PATH - OpenAPI 사양에 대한 경로 또는 URL
• API_HEADERS - API 헤더에 대한 쉼표로 구분된 키:값 쌍
• SERVER_NAME - MCP 서버의 이름(기본값: "mcp-openapi-server")
• SERVER_VERSION - 서버 버전(기본값: "1.0.0")

명령줄 인수

개발 워크플로

1. 개발 환경 시작:

2. src/ 에 있는 TypeScript 파일을 변경하세요.
3. 서버가 자동으로 재구축되고 다시 시작됩니다.
4. MCP Inspector UI를 사용하여 변경 사항을 테스트하세요.

디버깅

서버는 디버그 로그를 stderr로 출력합니다. 이 로그를 보려면 다음을 수행하세요.

1. 개발 모드에서:
   • inspect-watch 실행하면 터미널에 로그가 나타납니다.
2. 직접 실행할 경우:
   npm run inspect 2>debug.log

기여하다

1. 저장소를 포크하세요
2. 기능 브랜치 생성
3. 변경 사항을 만드세요
4. 테스트 및 린팅 실행:
   npm run typecheck npm run lint
5. 풀 리퀘스트 제출

특허

MIT