portone_io_mcp_server
by portone-ioPortOne MCP Server for Developers
Overview
The PortOne MCP Server is designed for developers using PortOne. This server provides PortOne Developer Center documentation to Large Language Models (LLMs), enabling easy and accurate access to relevant information.
Getting Started
Prerequisites
- Python 3.12 or higher
- uv (Python package manager)
Installation
-
Clone the repository and install required packages:
shell uv venv uv sync --extra dev -
Run the MCP server:
shell uv run portone-mcp-server -
Run tests:
shell uv run pytest -
Lint the code:
shell uv run ruff check . uv run ruff format . -
Publish the package:
shell # Update the version in pyproject.toml first rm -rf dist uv sync uv build uv publish
Registering the MCP Server
-
Ensure uv and Python 3.12 or higher are installed.
-
Add the following configuration to Claude Desktop:
json "mcpServers": { "portone-mcp-server": { "command": "uvx", "args": ["portone-mcp-server@latest"] } } -
Restart Claude Desktop to verify the server registration.
-
Register the MCP server in IDEs like Cursor or Windsurf using the same method.
Updating Documentation
Prerequisites
- The
developers.portone.iorepository must be cloned locally.
Steps
- Update the documentation:
```shell
# Using environment variables
export DEVELOPERS_PORTONE_IO_PATH="/path/to/developers.portone.io"
uv run update_docs.py
# Or interactively
uv run update_docs.py
# Enter the path to the developers.portone.io repository when prompted
```
This script performs the following:
1. Executes pnpm docs-for-llms in the developers.portone.io repository.
2. Replaces the MCP server's docs directory with the newly generated content.
3. Downloads and replaces external developer center documentation.
License
This project is licensed under the Apache License 2.0.
Invite Gmail Contacts
