프로젝트 소개

PortOne MCP 서버는 PortOne 개발자 센터 문서 내용을 LLM(Large Language Model) 클라이언트가 활용할 수 있도록 설계된 MCP(Model Context Protocol) 서버입니다. 이 서버를 통해 LLM은 PortOne API 및 서비스 관련 정보를 표준화된 방식으로 검색하고 활용하여, 더욱 정확하고 풍부한 답변을 생성할 수 있습니다.

주요 기능

PortOne 문서 검색 및 접근: PortOne 개발자 문서 (README, Markdown 문서) 를 서버에 로드하여, LLM 클라이언트가 문서 내용을 검색하고 조회할 수 있도록 합니다.
도구 제공: LLM 클라이언트가 'read_portone_doc' 도구를 사용하여 특정 문서의 내용을 읽어오거나, 'list_all_portone_docs' 도구를 사용하여 전체 문서 목록 및 메타 정보를 얻을 수 있도록 합니다.
표준 MCP 인터페이스: MCP 표준 프로토콜을 준수하여 LLM 클라이언트와의 호환성을 보장하며, 다양한 MCP 클라이언트 환경에서 활용 가능합니다.

설치 방법

필수 조건 확인: Python 3.12 이상 및 uv (Python 패키지 관리 도구)가 설치되어 있어야 합니다.

저장소 복제: GitHub 저장소를 로컬 환경에 복제합니다.

git clone https://github.com/portone-io/mcp-server.git portone-mcp-server

가상 환경 설정 및 패키지 설치: 복제한 디렉토리로 이동 후, 가상 환경을 생성하고 필요한 패키지를 설치합니다.
```
cd portone-mcp-server
uv venv
uv sync
```

서버 설정 (MCP 클라이언트 설정)

MCP 서버를 MCP 클라이언트 (예: Claude Desktop, Cursor, Windsurf)에 등록하려면, 클라이언트 설정에 다음 JSON 형식의 서버 정보를 추가해야 합니다. 'command' 와 'args' 는 MCP 서버를 실행하는 명령과 인수를 지정합니다.

"mcpServers": {
  // ... 기타 MCP 서버 설정 ...

  "portone-mcp-server": {  // 서버 이름 (클라이언트에서 사용할 식별자)
    "command": "uv",      // 실행할 명령어 (uv 패키지 관리자 사용)
    "args": [             // 명령어 인자 목록
      "--directory",      // 실행 디렉토리 지정
      "/your/absolute/path/to/portone-mcp-server", // PortOne MCP 서버를 복제한 절대 경로로 수정
      "run",              // uv run 명령어 실행
      "main.py"           // 서버 실행 파일
    ]
  }
}

주의: '/your/absolute/path/to/portone-mcp-server' 부분을 실제 'portone-mcp-server'를 복제한 절대 경로로 수정해야 합니다. MCP 클라이언트 설정 파일 경로는 클라이언트마다 다를 수 있으며, Claude Desktop의 경우 'Claude Desktop -> Settings -> Developer -> Edit Config' 에서 설정 파일을 수정할 수 있습니다.

기본 사용 방법

MCP 서버 실행: 터미널에서 'portone-mcp-server' 디렉토리로 이동하여 다음 명령어를 실행하여 MCP 서버를 시작합니다.
```
uv run main.py
```
MCP 클라이언트 실행 및 서버 등록: Claude Desktop, Cursor, Windsurf 와 같은 MCP 클라이언트를 실행하고, 위에 제시된 서버 설정 JSON 정보를 클라이언트 설정에 추가하여 'portone-mcp-server' 를 등록합니다.
도구 활용: LLM 클라이언트에서 PortOne 관련 질문을 할 때, 클라이언트는 자동으로 등록된 MCP 서버에 요청을 보내 도구를 활용하여 답변을 생성합니다. 예를 들어, "PortOne 문서에서 결제 관련 내용을 찾아줘" 와 같은 질문을 하면, 클라이언트는 'list_all_portone_docs' 도구를 통해 문서 목록을 확인하고, 'read_portone_doc' 도구를 사용하여 관련 문서 내용을 검색하여 답변을 제공할 수 있습니다.

팁: 'list_all_portone_docs' 도구를 먼저 사용하여 사용 가능한 PortOne 문서 목록과 경로를 확인한 후, 'read_portone_doc' 도구를 사용하여 특정 문서의 내용을 읽어보는 것을 권장합니다.

关键词

프로젝트 소개

주요 기능

설치 방법

서버 설정 (MCP 클라이언트 설정)

기본 사용 방법

信息