基本能力
产品定位
PI API MCP Server 是一个为 PI Dashboard API 提供标准化交互接口的 MCP 服务器,旨在简化 AI 助手与 PI Dashboard 的集成和操作。
核心功能
- 连接管理:支持设置和检查 API URL 连接状态
- 认证管理:提供多种认证方式,包括令牌认证和凭据认证
- 类别管理:支持创建、读取、更新和删除类别
- 图表管理:支持获取、导出和删除图表
- 过滤属性发现:可获取可用于过滤的图表属性列表
- 数据分析:提供多种分析提示,如比较图表、分析类别使用情况等
适用场景
- AI 助手与 PI Dashboard 的集成
- 自动化管理 PI Dashboard 资源
- 批量导出和分析图表数据
- 开发基于 PI Dashboard 的自动化工具
工具列表
- 连接管理工具:check-connection, set-api-url
- 认证工具:authenticate, authenticate-with-credentials, keep-session-alive, logout
- 类别管理工具:list-categories, get-category, create-category, update-category, delete-category, list-category-objects
- 图表管理工具:list-charts, get-chart, delete-chart, export-chart
- 过滤属性工具:get-filterable-attributes
常见问题解答
- 如果未提供
--api-url
参数,服务器会提示使用set-api-url
工具配置 API URL - 认证状态可通过
auth://status
资源检查 - 图表导出支持多种格式,通过
charts://{id}/export/{format}
资源实现
使用教程
使用依赖
Node.js 环境
```bash
确保已安装 Node.js 和 npm
node --version
npm --version
```
Docker 环境
```bash
确保已安装 Docker
docker --version
```
安装教程
通过 Smithery 安装
bash
npx -y @smithery/cli install @mingzilla/pi-api-mcp-server --client claude
使用 Docker 安装(推荐)
bash
docker run -i --rm -e API_URL=http://localhost:8224/pi/api/v2 -e PI_API_KEY=XXXXXXXX mingzilla/pi-api-mcp-server
本地安装
```bash
克隆仓库
git clone git@github.com:mingzilla/pi-api-mcp-server.git
cd pi-api-mcp-server
安装依赖
npm install
./dependencies.sh
构建项目
npm run build
启动服务器
npm start
```
调试方式
检查连接状态
使用 check-connection 工具验证连接
设置 API URL
使用 set-api-url 工具设置 API URL
认证测试
使用 authenticate 工具进行认证
列出图表
使用 list-charts 工具列出所有图表