PortOne MCP Server
2025.04.11
14
Python开发辅助文档维护IDE集成开发效率
PortOne MCP Server是为使用PortOne的开发人员设计的MCP（Model Context Protocol）服务器。该服务器将PortOne开发者中心的文档内容提供给大型语言模型（LLM），以便开发人员能够轻松准确地查询相关信息。
View on GitHub
Overview
基本能力
产品定位
PortOne MCP Server旨在为开发人员提供一个便捷的工具，通过LLM快速访问和查询PortOne开发者中心的文档内容，从而提高开发效率。
核心功能
- 文档查询：将PortOne开发者中心的文档内容提供给LLM，支持快速查询。
- 开发工具集成：支持在Claude Desktop、Cursor、Windsurf等IDE中注册和使用。
- 文档更新：支持从本地developers.portone.io存储库更新文档内容。
适用场景
- 开发辅助：开发人员在编写代码时快速查询PortOne相关文档。
- 文档维护：维护和更新PortOne开发者中心的文档内容。
- IDE集成：在支持MCP的IDE中集成PortOne文档查询功能。
工具列表
- uv：Python包管理工具，用于安装和运行MCP服务器。
- Claude Desktop：支持MCP的IDE，可以注册和使用MCP服务器。
- Cursor/Windsurf：其他支持MCP的IDE，同样可以注册和使用MCP服务器。
常见问题解答
- 如何注册MCP服务器？
- 在Claude Desktop的设置中添加MCP服务器配置，并重启IDE。
- 如何更新文档？
- 运行
uv run update_docs.py脚本，从developers.portone.io存储库更新文档。 - 如何运行MCP服务器？
- 使用
uv run portone-mcp-server命令启动服务器。
使用教程
使用依赖
- 安装Python 3.12及以上版本。
- 安装uv（Python包管理工具）：
bash pip install uv
安装教程
- 克隆存储库并安装依赖：
bash uv venv uv sync --extra dev - 启动MCP服务器：
bash uv run portone-mcp-server
调试方式
- 运行测试：
bash uv run pytest - 代码检查：
bash uv run ruff check . uv run ruff format . - 发布：
bash rm -rf dist uv sync uv build uv publish