Skip to directory

About PortOne MCP

PortOne's local MCP server provides searchable developer/help documentation, OpenAPI schemas and integration code examples, plus selected PortOne Console lookups and test-channel configuration.

What you can use it for

  • Find and read PortOne developer documentation
  • Inspect V1/V2 OpenAPI schemas and payment integration examples
  • List stores, channels, payments, reconciliation, and settlement information
  • Add a shared test channel when explicitly requested
Connection and setup
Hosting
Local
Transport
stdio
Endpoint
Local process; no hosted endpoint documented
Authentication
Console features use interactive browser OAuth/PKCE; server deployments can inject PORTONE_ACCESS_TOKEN. Token refresh/expiry management is the caller’s responsibility in static-token mode.

Requirements

  • Node.js >=22.18.0 per current package.json (README says 22.6.0; discrepancy recorded)
  • PortOne account and Console access for store, payment, channel, reconciliation, and settlement tools
  • Browser for OAuth or a separately issued access token for headless use

Setup steps

  1. Add command npx with args ["-y", "@portone/mcp-server@latest"] to the client's local MCP config.
  2. Reload the client; when a Console-backed tool requests authentication, complete PortOne browser login and consent.
  3. For headless mode, set PORTONE_ACCESS_TOKEN securely in the server process environment and optionally PORTONE_TOKEN_TYPE.
  4. Verify safely by listing or reading PortOne documentation; do not use addTestChannel as a connection test.
  5. For Claude Desktop DXT, use the repository release instructions; README describes an embedded-Node workaround. The package engine requirement is stricter.
Tools 16

Current official repository registers 16 tools: eight developer-documentation/source tools and eight PortOne console/payment/reconciliation/settlement tools. Console tools use interactive browser OAuth or injected PORTONE_ACCESS_TOKEN; avoid exposing payment/customer data to unauthorized third-party clients.

  • listPortoneDocs

    List PortOne developer/help documentation paths and metadata.

    01
  • readPortoneDoc

    Read a PortOne documentation page by path, returning its content and public URL.

    02
  • regexSearchPortoneDocs

    Search PortOne documentation with a regular expression.

    03
  • getPortoneDocsUrl

    Get the public URL for a documentation page.

    04
  • readPortoneOpenapiSchema

    Read a selected PortOne OpenAPI schema.

    05
  • readPortoneOpenapiSchemaSummary

    Return a concise summary of a PortOne OpenAPI schema.

    06
  • readPortoneV2BackendCode

    Read relevant PortOne V2 backend integration code.

    07
  • readPortoneV2FrontendCode

    Read relevant PortOne V2 frontend integration code.

    08
  • listStores

    List sub-stores visible in the PortOne console.

    09
  • listSharedTestChannels

    List shared test channels.

    10
  • getChannelsOfStore

    List channels associated with a store.

    11
  • addTestChannel

    Add a test channel to a store.

    12
  • getPaymentsByFilter

    Query payment records with supported filters.

    13
  • getReconciliationsByFilter

    Query reconciliation records, including mismatches and details.

    14
  • getSettlementSummaries

    Read settlement summaries.

    15
  • getSettlementStatistics

    Read settlement statistics.

    16
Limitations and notes
  • Console access tools expose payment, reconciliation, settlement and store data. The maintainer notes some personal information in API responses is filtered, but other data may be processed by the AI client.
Source discrepancies
  • README Node version (>=22.6.0) conflicts with current package engines (>=22.18.0); preserve both and use >=22.18.0.
Original sources
  • official repository readme

    PortOne README documents local npx setup, Console OAuth/PKCE, headless token envs, DXT installation caveat, feature groups, privacy warning, and dual license.

  • official package metadata

    Current metadata declares @portone/mcp-server 0.20.1, MIT OR Apache-2.0, Node >=22.18.0.

  • official tool registration

    Entrypoint registers all tool modules and configures OAuth token provider.

  • official tool source

    Official source modules define tool names, schemas, and descriptions.

  • official tool source

    Source says test-channel addition is a Console write and requires a MID returned by listSharedTestChannels.

  • official tool source

    Source documents a maximum one-month query window limited to the recent six months.

  • official tool source

    Source defines payment filters and returned data fields.

  • package registry

    Registry URL matches the package name confirmed in current repository metadata.

  • official current tool registry

    Current maintainer registry imports and registers 16 exact tool handlers; README documents local setup, browser OAuth/PKCE and token injection.

Documentation checked 2026-10-28T00:00:00Z. Connection has not been runtime tested.

Similar tools