MCP Server Portone

PortOne MCP服务器

用于端口1用户的模型上下文协议（MCP）服务器。向大型语言模型（LLM）提供正式文档内容，如端口一号开发中心、帮助中心等，以帮助用户根据准确的信息进行协作和查询。

此外，您还可以执行端口一控制台提供的一些功能。

• 查看频道列表
• 添加测试通道
• 查看子商店
• 查看付款历史记录

使用控制台功能时，需要通过浏览器登录控制台。

使用DXT安装

DXT（桌面扩展）可以使用一键安装MCP服务器。

1. 最新 portone-mcp-server.dxt 下载文件。

1. 从支持的AI工具（Claude Desktop等）下载的 .dxt 拖放或通过打开安装文件。

1. 安装后重新启动工具，确保MCP服务器已正常注册。

\[！警告\] 在Claude Desktop中使用DXT文件时的注意事项 当前 已知问题因此，在Claude桌面上安装DXT后，MCP服务器可能无法正常工作。 在这种情况下，请安装Node.js 22.6.0或更高版本，并在Claude Desktop设置中 “使用MCP的内置Node.js” 禁用选项后重新启动时，该选项将正常工作。

注册MCP服务器

1. 必须安装Node.js 22.6.0或更高版本。

1. 在您使用的AI工具的MCP设置中，添加以下内容： (Cursor, Windsurf, Claude Desktop, etc...)

   "mcpServers": {

     // 기존 설정

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

1. 重新启动工具，验证portone-mcp-server及其服务器提供的工具是否已注册。

\[！小心\] 如果使用第三方AI服务，API响应（查询的数据等）可能会传递到AI服务端进行存储，或根据该服务的策略用于模型学习。 MCP服务器正在制定保护措施，首先识别和删除API响应中包含的个人信息，以避免将其传递到外部。 不过，请注意，其他信息可能会根据AI服务的操作策略暂时存储或处理。

开发

要求

• Node.js 22.6.0或更高版本
• pnpm（建议）或npm

1. 克隆存储库并安装所需的软件包

   pnpm install

1. 运行MCP服务器（开发模式）

   pnpm dev

1. 代码打印和格式化

   pnpm lint
   pnpm format

1. 类型检查

   pnpm typecheck

1. 构建和发布

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

1. 在本地环境中注册MCP服务器

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

1. 更新文档

要求：

- 必须在本地克隆developers.portone.io和help.portone.io存储库。 - 必须安装nvm（节点版本管理器）和节点20,23版本。 - 必须安装corepack。

要在MCP服务器上更新developers.portone.io存储库中创建的文档，请执行以下操作：

   # 환경 변수를 사용하는 방법
   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 执行命令（根据本地设置的分支创建文档） 1. 用新创建的内容替换MCP服务器的docs目录 1. 下载并替换开发人员中心、帮助中心以外的部分文档

从Python版本迁移

如果您以前使用的是Python版本（\<0.13.0）的MCP服务器，我们建议您迁移到TypeScript版本。

迁移方法

1. 更改MCP设置

设置现有的python版本：

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

新的TypeScript版本设置：

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

1. 环境变量和API秘密设置相同保持。

1. 安装Node.js：需要Node.js 22.6.0或更高版本。

1. 重新启动AI工具：更改设置后，重新启动正在使用的AI工具。

许可证

Apache许可证2.0 或 MIT许可证