Skip to main content

PortOne 개발자 문서를 위한 MCP(Model Context Protocol) 서버입니다. 이 서버는 PortOne 문서 내용을 LLM(Large Language Model)에 제공하여 PortOne 서비스 관련 정보를 쉽게 검색할 수 있도록 합니다.

Project description

PortOne MCP Server

포트원을 사용하는 개발자를 위한 MCP(Model Context Protocol) 서버입니다. 이 서버는 PortOne 개발자센터 문서 내용을 LLM(Large Language Model)에 제공하여 관련 정보를 쉽고 정확하게 조회할 수 있도록 합니다.

MCP 서버 등록하기

  1. uv 및 Python 3.12 이상이 설치되어 있어야 합니다.

  2. Claude Desktop -> Settings -> Developer -> Edit Config를 통해 아래 내용을 추가합니다.

    "mcpServers": {
    
      // 기존 설정
    
      "portone-mcp-server": {
        "command": "uvx",
        "args": [
          "portone-mcp-server@latest"
        ]
      }
    }
    
  3. Claude Desktop을 재시작해 portone-mcp-server 및 해당 서버가 제공하는 도구들이 잘 등록되었는지 확인합니다.

  4. Cursor, Windsurf 등 MCP를 지원하는 IDE에 대해서도 동일한 방식으로 MCP 서버를 등록할 수 있습니다.

개발하기

요구사항

  1. 저장소를 클론한 후 필요한 패키지 설치하기

    uv venv
    uv sync --extra dev
    
  2. MCP 서버 실행

    uv run portone-mcp-server
    
  3. 테스트

    uv run pytest
    
  4. 코드 린팅

    uv run ruff check .
    uv run ruff format .
    
  5. 퍼블리싱

    # 먼저 pyproject.toml의 version을 변경합니다.
    rm -rf dist
    uv sync
    uv build
    uv publish
    
  6. 로컬 환경의 MCP 서버 등록하기

    "mcpServers": {
       "portone-mcp-server": {
       "command": "uv",
       "args": [
          "--directory",
          "/your/absolute/path/to/portone-mcp-server",
          "run",
          "portone-mcp-server"
       ]
       }
    }
    
  7. 문서 업데이트하기

    요구사항: 로컬에 developers.portone.io 저장소가 클론되어 있어야 합니다.

    developers.portone.io 저장소에서 생성된 문서를 MCP 서버에 업데이트하려면 다음과 같이 실행합니다:

    # 환경 변수를 사용하는 방법
    export DEVELOPERS_PORTONE_IO_PATH="/path/to/developers.portone.io"
    uv run update_docs.py
    
    # 또는 대화형으로 실행
    uv run update_docs.py
    # 프롬프트가 표시되면 developers.portone.io 저장소 경로 입력
    

    이 스크립트는 다음을 수행합니다:

    1. developers.portone.io 저장소에서 pnpm docs-for-llms 명령을 실행 (로컬에 설정된 브랜치 기준으로 문서 생성)
    2. MCP 서버의 docs 디렉토리를 새로 생성된 내용으로 교체
    3. 개발자센터 외 문서 다운로드 및 교체

라이선스

Apache License 2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

portone_mcp_server-0.7.0.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

portone_mcp_server-0.7.0-py3-none-any.whl (1.8 MB view details)

Uploaded Python 3

File details

Details for the file portone_mcp_server-0.7.0.tar.gz.

File metadata

  • Download URL: portone_mcp_server-0.7.0.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.6

File hashes

Hashes for portone_mcp_server-0.7.0.tar.gz
Algorithm Hash digest
SHA256 1ee35707889c1cf4479b6526e47742ea2369dd1513da838ebcc002d48a7ad6b6
MD5 6e9d2b96477033e9bdf4018659673a2d
BLAKE2b-256 8d61a333e7e7b756bd8c1ad824b0f208b969319b923b95bccdc117afc9dd9ea1

See more details on using hashes here.

File details

Details for the file portone_mcp_server-0.7.0-py3-none-any.whl.

File metadata

File hashes

Hashes for portone_mcp_server-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 37646d6d60ce57cb8f79751c64f0cdb48968fa0b42086d04b4ced09e69f6e663
MD5 4ad8ccebaed210a0a217907f38364391
BLAKE2b-256 90934222f4f618b6554b171ed15da207f6aab44a535adc97b42e75efbc014924

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page