项目介绍
Gorgias MCP Server
与Gorgias帮助台API交互的MCP服务器。此服务器提供了管理和处理工单、客户以及其他Gorgias功能的工具和资源。
## 配置
1. 克隆此仓库
2. 安装依赖项:
```
npm install
```
3. 根据`.env.example`创建一个包含您的Gorgias凭证的`.env`文件:
```
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`: 列出Gorgias帮助台中的工单
- `get_ticket`: 通过ID获取特定工单
- `create_ticket`: 在Gorgias中创建新的工单
- `add_message_to_ticket`: 向现有工单添加消息
### 客户
- `list_customers`: 列出Gorgias中的客户
- `get_customer`: 通过ID获取特定客户
## 可用资源
- `gorgias://tickets`: 列出所有工单
- `gorgias://ticket/{id}`: 通过ID获取特定工单
## 认证
此服务器支持两种认证方法:
1. API密钥认证(用户名/ API密钥)
2. OAuth令牌认证
在`.env`文件中配置您偏好的方法。