@reapi/mcp-openapi

LLM 기반 IDE 통합을 지원하기 위해 여러 OpenAPI 사양을 로드하고 제공하는 모델 컨텍스트 프로토콜(MCP) 서버입니다. 이 서버는 OpenAPI 사양과 Cursor 및 기타 코드 편집기와 같은 LLM 기반 개발 도구를 연결하는 다리 역할을 합니다.

특징

• 디렉토리에서 여러 OpenAPI 사양을 로드합니다.
• MCP 프로토콜을 통해 API 작업 및 스키마를 공개합니다.
• LLM이 IDE에서 직접 API를 이해하고 작업할 수 있도록 합니다.
• 완전한 API 컨텍스트에 대한 참조 해제된 스키마를 지원합니다.
• 사용 가능한 모든 API의 카탈로그를 유지합니다.

ReAPI 기반

이 오픈소스 MCP 서버는 API 설계 및 테스트를 간소화하는 차세대 API 플랫폼인 ReAPI 의 지원을 받습니다. 이 서버는 개발을 위한 로컬 OpenAPI 통합을 제공하는 반면, ReAPI는 두 가지 강력한 모듈을 제공합니다.

🎨 API CMS

• 직관적인 무코드 편집기를 사용하여 API 디자인
• OpenAPI 사양을 자동으로 생성하고 게시합니다.
• 실시간으로 팀원들과 협업하세요
• 버전 제어 및 변경 관리

🧪 API 테스트

• 개발자에게 가장 친화적인 무코드 API 테스트 솔루션
• 직관적인 인터페이스로 테스트 케이스를 생성하고 관리하세요
• 강력한 주장 및 검증 기능
• 서버리스 클라우드 테스트 실행기
• QA 팀과 개발자 모두에게 적합합니다.
• CI/CD 통합 준비 완료

reapi.com 에서 ReAPI를 무료로 사용해보고 API 개발의 미래를 경험해 보세요.

커서 구성

MCP OpenAPI 서버를 Cursor IDE와 통합하려면 구성 위치에 대한 두 가지 옵션이 있습니다.

옵션 1: 프로젝트별 구성(권장)

프로젝트 디렉터리에 .cursor/mcp.json 파일을 만드세요. 이 옵션을 사용하면 프로젝트별로 서로 다른 사양 세트를 관리할 수 있으므로 권장됩니다.

지엑스피1

팁 : ./specs 와 같은 상대 경로를 사용하면 구성을 이식할 수 있고 팀원들 사이에서 공유하기가 더 쉬워집니다.

참고사항 : 당사는 서버에 새로운 기능과 개선 사항을 자주 업데이트하므로 @latest 태그를 사용하는 것이 좋습니다.

중요 : 프로젝트별 구성은 LLM 컨텍스트 제한을 관리하는 데 도움이 됩니다. 모든 사양을 단일 폴더에 배치하면 결합된 메타데이터가 LLM 컨텍스트 창을 초과하여 오류가 발생할 수 있습니다. 프로젝트별로 사양을 구성하면 컨텍스트 크기를 효율적으로 관리할 수 있습니다.

옵션 2: 글로벌 구성

모든 프로젝트에서 서버를 사용할 수 있도록 홈 디렉토리에 ~/.cursor/mcp.json 만들거나 편집하세요.

커서 설정에서 활성화

구성을 추가한 후:

1. 커서 IDE 열기
2. 설정 > 커서 설정 > MCP로 이동하세요.
3. @reapi/mcp-openapi 서버 활성화
4. 변경 사항을 적용하려면 서버 옆에 있는 새로 고침 아이콘을 클릭하세요.

참고 : 기본적으로 커서는 MCP 도구를 실행할 때마다 확인 절차를 거쳐야 합니다. 확인 절차 없이 자동 실행되도록 하려면 커서 설정에서 Yolo 모드를 활성화하세요.

이제 서버를 사용할 준비가 되었습니다. 디렉토리에 새로운 OpenAPI 사양을 추가하면 다음과 같은 방법으로 카탈로그를 새로 고칠 수 있습니다.

1. 커서의 채팅 패널 열기
2. 다음 프롬프트 중 하나를 입력하세요.
   "Please refresh the API catalog" "Reload the OpenAPI specifications"

OpenAPI 사양 요구 사항

1. 대상 디렉토리에 OpenAPI 3.x 사양을 넣으세요.
   • JSON 및 YAML 형식을 모두 지원합니다
   • 파일 확장자는 .json , .yaml 또는 .yml 이어야 합니다.
   • 스캐너는 모든 사양 파일을 자동으로 검색하고 처리합니다.
2. 사양 ID 구성:
   • 기본적으로 파일 이름(확장자 없음)이 사양 ID로 사용됩니다.
   • 사용자 지정 ID를 지정하려면 OpenAPI 정보 개체에 x-spec-id 추가합니다.
   openapi: 3.0.0 info: title: My API version: 1.0.0 x-spec-id: my-custom-api-id # Custom specification ID

   중요 : 여러 사양을 작업할 때 사용자 지정 x-spec-id 설정하는 것은 매우 중요합니다.

   • 유사하거나 동일한 종료점 경로
   • 동일한 스키마 이름
   • 중복되는 작업 ID

   사양 ID는 이러한 유사한 리소스를 구분하고 이름 충돌을 방지하는 데 도움이 됩니다. 예:

   # user-service.yaml info: x-spec-id: user-service paths: /users: get: ... # admin-service.yaml info: x-spec-id: admin-service paths: /users: get: ...

   이제 이러한 엔드포인트를 구체적으로 user-service/users 및 admin-service/users 로 참조할 수 있습니다.

작동 원리

1. 서버는 지정된 디렉토리에서 OpenAPI 사양 파일을 스캔합니다.
2. 완전한 컨텍스트를 위해 사양을 처리하고 참조 해제합니다.
3. 모든 API 작업 및 스키마의 카탈로그를 생성하고 유지 관리합니다.
4. MCP 프로토콜을 통해 이 정보를 노출합니다.
5. IDE 통합은 이 정보를 사용하여 다음을 수행할 수 있습니다.
   • LLM에 API 컨텍스트 제공
   • 지능형 코드 완성을 활성화하세요
   • API 통합 지원
   • API 인식 코드 조각 생성

도구

1. refresh-api-catalog
   • API 카탈로그 새로 고침
   • 반환: 카탈로그가 새로 고쳐지면 성공 메시지가 표시됩니다.
2. get-api-catalog
   • API 카탈로그를 받으세요. 카탈로그에는 모든 OpenAPI 사양, 해당 작업 및 스키마에 대한 메타데이터가 포함되어 있습니다.
   • 반환: 모든 사양, 작업 및 스키마가 포함된 완전한 API 카탈로그
3. search-api-operations
   • 사양 전반에 걸쳐 작업 검색
   • 입력:
     • query (문자열): 검색 쿼리
     • specId (선택적 문자열): 검색할 특정 API 사양 ID
   • 반환: API 카탈로그에서 일치하는 작업
4. search-api-schemas
   • 사양 전반에 걸쳐 스키마 검색
   • 입력:
     • query (문자열): 검색 쿼리
     • specId (선택적 문자열): 검색할 특정 API 사양 ID
   • 반환: API 카탈로그에서 일치하는 스키마
5. load-api-operation-by-operationId
   • operationId로 작업 로드
   • 입력:
     • specId (문자열): API 사양 ID
     • operationId (문자열): 로드할 작업 ID
   • 반환: 전체 작업 세부 정보
6. load-api-operation-by-path-and-method
   • 경로 및 메서드로 작업 로드
   • 입력:
     • specId (문자열): API 사양 ID
     • path (문자열): API 엔드포인트 경로
     • method (문자열): HTTP 메서드
   • 반환: 전체 작업 세부 정보
7. load-api-schema-by-schemaName
   • schemaName으로 스키마 로드
   • 입력:
     • specId (문자열): API 사양 ID
     • schemaName (문자열): 로드할 스키마의 이름
   • 반환: 완전한 스키마 세부 정보

로드맵

1. 의미 검색
   • API 작업 및 스키마에 대한 자연어 쿼리 활성화
   • 의미적 이해를 통해 검색 정확도 향상
2. 원격 사양 동기화
   • 원격 소스에서 OpenAPI 사양 동기화 지원
3. 코드 템플릿
   • MCP 프로토콜을 통해 코드 템플릿 노출
   • LLM 코드 생성을 위한 참조 패턴 제공
4. 커뮤니티 기여
   • 기능 요청 및 버그 보고서 제출
   • 서버 개선에 기여하세요

커서의 예제 프롬프트

다음은 Cursor IDE에서 API와 상호 작용하는 데 사용할 수 있는 몇 가지 프롬프트 예입니다.

1. 사용 가능한 API 탐색
   "Show me all available APIs in the catalog with their operations" "List all API specifications and their endpoints"
2. API 작업 세부 정보
   "Show me the details of the create pet API endpoint" "What are the required parameters for creating a new pet?" "Explain the response schema for the pet creation endpoint"
3. 스키마 및 모의 데이터
   "Generate mock data for the Pet schema" "Create a valid request payload for the create pet endpoint" "Show me examples of valid pet objects based on the schema"
4. 코드 생성
   "Generate an Axios client for the create pet API" "Create a TypeScript interface for the Pet schema" "Write a React hook that calls the create pet endpoint"
5. API 통합 지원
   "Help me implement error handling for the pet API endpoints" "Generate unit tests for the pet API client" "Create a service class that encapsulates all pet-related API calls"
6. 문서 및 사용법
   "Show me example usage of the pet API with curl" "Generate JSDoc comments for the pet API client methods" "Create a README section explaining the pet API integration"
7. 검증 및 유형
   "Generate Zod validation schema for the Pet model" "Create TypeScript types for all pet-related API responses" "Help me implement request payload validation for the pet endpoints"
8. API 검색 및 발견
   "Find all endpoints related to pet management" "Show me all APIs that accept file uploads" "List all endpoints that return paginated responses"

이 프롬프트는 MCP 서버의 기능을 활용하여 API를 개발하는 방법을 보여줍니다. 특정 요구 사항에 맞게 수정하거나 더 복잡한 작업을 위해 여러 프롬프트를 결합할 수 있습니다.

기여하다

기여를 환영합니다! 풀 리퀘스트를 제출해 주세요.