article
README
🚀 堡狮网 MCP 服务器
堡狮网 MCP 服务器是一个用于与堡狮网帮助台 API 进行交互的工具。它提供了一系列功能,可用于管理票务、客户等堡狮网相关业务,为用户提供便捷的操作体验。
🚀 快速开始
安装指南
- 克隆此仓库。
- 安装依赖:
npm install
- 基于
.env.example创建一个.env文件,并输入您的堡狮网凭证。
- 若使用 API Key 认证:
GORGIAS_DOMAIN=your-domain.gorgias.com
GORGIAS_USERNAME=your-username
GORGIAS_API_KEY=your-api-key
- 若使用 OAuth 应用程序:
GORGIAS_DOMAIN=your-domain.gorgias.com
GORGIAS_ACCESS_TOKEN=your-oauth-access-token
启动服务器
启动服务器:
npm run dev
使用 MCP Inspector 测试
使用 MCP Inspector 测试服务器:
npm run inspect
这将打开一个 Web 界面,您可以在其中测试所有可用工具和资源。
✨ 主要特性
可用工具
票务
list_tickets:列出堡狮网帮助台中的票务。get_ticket:通过 ID 获取特定票务。create_ticket:在堡狮网中创建新票务。add_message_to_ticket:向现有票务添加消息。
客户
list_customers:列出堡狮网中的客户。get_customer:通过 ID 获取特定客户。
可用资源
gorgias://tickets:列出所有票务。gorgias://ticket/{id}:通过 ID 获取特定票务。
认证方法
该服务器支持两种认证方式:
- API Key 认证(用户名/API 密钥)
- OAuth 令牌认证
您可以在 .env 文件中配置您偏好的认证方法。
微信扫一扫