PortOne MCP Server

What is PortOne MCP Server about?

Provides a locally hosted server that supplies official PortOne documentation and selected console functionalities to Large Language Models, allowing accurate, up‑to‑date responses for developers and end‑users.

How to use PortOne MCP Server?

Prerequisites: Install Node.js ≥ 22.6.0 and pnpm (or npm).
Installation – either:
- Download the latest .dxt file from the GitHub releases and install via a supported AI tool (e.g., Claude Desktop), or
- Register the server directly in the AI tool’s MCP settings using the npx command (see Server Configuration below).
Run: Execute pnpm dev for development mode or run the compiled binary (node dist/index.js).
Configure the AI tool to point to the server’s endpoint; restart the tool to apply changes.

Key Features

Access to PortOne developer‑center and help‑center docs, automatically refreshed.
Console capabilities:
- List channels
- Add test channels
- Retrieve sub‑store information
- Query payment history
Works with major AI tools that support MCP (Claude Desktop, Cursor, Windsurf, etc.).
Built‑in privacy measures to redact personal data before sending responses to external AI services.

Use Cases

Developer assistance: AI‑driven chatbots provide instant, accurate answers about PortOne APIs and integration steps.
Support automation: Customer‑service bots can fetch payment records or channel status without manual lookup.
Testing environments: Quickly create and manage test channels through AI commands.
Documentation sync: Keep LLMs up‑to‑date with the latest developers.portone.io and help.portone.io content.

FAQ

What Node version is required? Node.js 22.6.0 or newer.
Can I use npm instead of pnpm? Yes, but pnpm is recommended for faster installs.
Do I need to set any environment variables? Only if the underlying PortOne APIs require authentication (e.g., API_KEY). The server itself does not enforce any specific variables.
What if the DXT installation fails on Claude Desktop? Install Node ≥ 22.6.0, disable the "MCP용 내장 Node.js 사용" option in Claude Desktop settings, and restart.
How do I update the documentation used by the server? Run pnpm update-docs after setting DEVELOPERS_PORTONE_IO_PATH and HELP_PORTONE_IO_PATH environment variables, or follow the interactive prompts.
Is the server compatible with the older Python MCP implementation? Yes, but migration to the TypeScript version is recommended. Update the MCP configuration to use the npx command as shown below.

포트원 사용자를 위한 MCP (Model Context Protocol) 서버입니다. 포트원 개발자센터, 헬프센터 등 공식 문서 내용을 LLM(Large Language Model)에 제공해 정확한 정보를 바탕으로 사용자의 연동 및 질의를 돕도록 합니다.

이외에도 포트원 콘솔에서 제공하는 기능 중 일부를 수행할 수 있습니다.

채널 목록 조회
테스트 채널 추가
하위 상점 조회
결제 내역 조회

콘솔 기능 사용 시 브라우저를 통해 콘솔 로그인이 필요합니다.

DXT를 이용한 설치

DXT (Desktop Extensions)를 이용해 MCP 서버를 원클릭으로 설치할 수 있습니다.

GitHub Releases에서 최신 portone-mcp-server.dxt 파일을 다운로드합니다.
지원하는 AI 도구(Claude Desktop 등)에서 다운로드한 .dxt 파일을 드래그 앤 드롭하거나 열기를 통해 설치합니다.
설치 후 도구를 재시작하여 MCP 서버가 정상적으로 등록되었는지 확인합니다.

[!WARNING] Claude Desktop에서 DXT 파일 사용 시 주의사항

현재 알려진 이슈로 인해 Claude Desktop에서 DXT 설치 후 MCP 서버가 정상적으로 작동하지 않을 수 있습니다.

이 경우 Node.js 22.6.0 이상을 설치하고 Claude Desktop 설정에서 "MCP용 내장 Node.js 사용" 옵션을 비활성화한 후 재시작하면 정상적으로 작동합니다.

MCP 서버 등록하기

Node.js 22.6.0 이상이 설치되어 있어야 합니다.

사용하는 AI 도구의 MCP 설정에서 아래 내용을 추가합니다. (Cursor, Windsurf, Claude Desktop, etc...)

"mcpServers": {

  // 기존 설정

  "portone-mcp-server": {
    "command": "npx",
    "args": [
      "-y",
      "@portone/mcp-server@latest"
    ]
  }
}

도구를 재시작해 portone-mcp-server 및 해당 서버가 제공하는 도구들이 잘 등록되었는지 확인합니다.

[!CAUTION] 제3자 AI 서비스를 사용할 경우, API 응답(조회된 데이터 등)이 AI 서비스 측으로 전달되어 저장되거나 해당 서비스의 정책에 따라 모델 학습에 사용될 수 있습니다.

MCP 서버는 API 응답에 포함된 개인정보가 외부로 전달되지 않도록, 우선적으로 해당 정보를 식별 및 제거하는 보호 조치를 마련하고 있습니다. 다만, 그 외의 정보는 AI 서비스의 운영 정책에 따라 일시적으로 저장되거나 처리될 수 있는 점을 유의해야 합니다.

개발하기

요구사항

Node.js 22.6.0 이상
pnpm (권장) 또는 npm

저장소를 클론한 후 필요한 패키지 설치하기
```
pnpm install
```
MCP 서버 실행 (개발 모드)
```
pnpm dev
```
코드 린팅 및 포맷팅
```
pnpm lint
pnpm format
```
타입 체크
```
pnpm typecheck
```

빌드 및 퍼블리싱

# 먼저 package.json의 version을 변경합니다.
rm -rf dist
pnpm install
pnpm build
pnpm publish

로컬 환경의 MCP 서버 등록하기

"mcpServers": {
   "portone-mcp-server": {
     "command": "node",
     "args": [
       "/your/absolute/path/to/portone-mcp-server/dist/index.js"
     ]
   }
}

문서 업데이트하기

요구사항:
- 로컬에 developers.portone.io, help.portone.io 저장소가 클론되어 있어야 합니다.
- nvm (Node Version Manager) 및 노드 20, 23 버전이 설치되어 있어야 합니다.
- corepack이 설치되어 있어야 합니다.
developers.portone.io 저장소에서 생성된 문서를 MCP 서버에 업데이트하려면 다음과 같이 실행합니다:
```
# 환경 변수를 사용하는 방법
export DEVELOPERS_PORTONE_IO_PATH="/path/to/developers.portone.io"
export HELP_PORTONE_IO_PATH="/path/to/help.portone.io"
pnpm update-docs

# 또는 대화형으로 실행
pnpm update-docs
# 프롬프트가 표시되면 developers.portone.io, help.portone.io 저장소 경로 입력
```
이 스크립트는 다음을 수행합니다:
1. developers.portone.io, help.portone.io 저장소에서 pnpm docs-for-llms 명령을 실행 (로컬에 설정된 브랜치 기준으로 문서 생성)
2. MCP 서버의 docs 디렉토리를 새로 생성된 내용으로 교체
3. 개발자센터, 헬프센터 외 일부 문서 다운로드 및 교체

Python 버전에서 마이그레이션

기존에 Python 버전(<0.13.0)의 MCP 서버를 사용하고 계셨다면 TypeScript 버전으로 마이그레이션하는 것을 권장합니다.

마이그레이션 방법

MCP 설정 변경

기존 파이썬 버전 설정:

"mcpServers": {
  "portone-mcp-server": {
    "command": "uvx",
    "args": ["portone-mcp-server@latest"]
  }
}

새로운 TypeScript 버전 설정:

"mcpServers": {
  "portone-mcp-server": {
    "command": "npx",
    "args": ["-y", "@portone/mcp-server@latest"]
  }
}

환경 변수 및 API 시크릿 설정은 동일하게 유지됩니다.
Node.js 설치: Node.js 22.6.0 이상이 필요합니다.
AI 도구 재시작: 설정 변경 후 사용 중인 AI 도구를 재시작합니다.

라이선스

Apache License 2.0 OR MIT License

PortOne MCP Server