Portkey MCP Server 使用说明

项目简介

Portkey MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器应用，旨在帮助用户通过支持 MCP 协议的 LLM 客户端（如 Claude）便捷地管理 Portkey.ai 平台。它将 Portkey.ai 的 API 功能封装成一系列易于 LLM 调用的工具，例如用户管理、访问控制、分析报告、工作区管理和配置管理等。

主要功能点

用户与访问管理：
- 列出和管理 Portkey 组织中的所有用户。
- 邀请新用户并分配组织和工作区角色。
- 管理用户在不同工作区中的访问权限。
分析与报告：
- 跟踪用户活动和请求模式。
- 监控和分析成本、请求指标和响应时间。
- 生成基于多种条件过滤的分析报告。
工作区管理：
- 列出和查看工作区的详细信息。
- 管理工作区配置和 API 密钥 (Virtual Keys)。
配置与 API 设置：
- 查看和检索组织中的所有配置信息。
- 获取配置的详细信息，如缓存设置、重试策略和路由策略。
- 管理和监控 Virtual Keys 的状态、使用限制和速率限制。

安装步骤

克隆仓库

git clone https://github.com/r-huijts/portkey-admin-mcp-server.git
cd portkey-admin-mcp-server

安装依赖
```
npm install
```
配置环境变量 复制 '.env.example' 文件并重命名为 '.env'，然后编辑 '.env' 文件，填入您的 Portkey API 密钥：
```
PORTKEY_API_KEY=your_portkey_api_key_here
```
构建项目
```
npm run build
```

服务器配置

要将 Portkey MCP Server 集成到 MCP 客户端（例如 Claude），您需要配置 MCP 客户端的服务器设置。以下是配置示例，您需要根据实际安装路径进行调整：

{
  "mcpServers": {
    "portkey-server": {
      "command": "node",
      "args": [
        "/path/to/portkey-admin-mcp-server/build/index.js"
      ],
      "env": {
        "PORTKEY_API_KEY": "your_portkey_api_key_here"
      }
    }
  }
}

配置参数说明:

'"portkey-server"': 服务器名称，您可以自定义。
'"command": "node"': 启动服务器的命令，这里使用 Node.js 运行时。
'"args": [...]'：传递给 'node' 命令的参数，指向编译后的 'index.js' 文件路径。 请将 '/path/to/portkey-admin-mcp-server' 替换为您的实际仓库安装路径。
'"env": {...}'：环境变量配置。
- '"PORTKEY_API_KEY": "your_portkey_api_key_here"': 请将 'your_portkey_api_key_here' 替换为您的 Portkey API 密钥。 虽然此处也配置了API Key，但更推荐在服务器的 '.env' 文件中配置，保持配置一致性。

完成配置后，重启您的 MCP 客户端 (如 Claude Desktop) 使配置生效。

基本使用方法

配置完成后，您可以在 MCP 客户端中通过自然语言指令调用 Portkey MCP Server 提供的工具，管理您的 Portkey.ai 平台。

使用示例 (在 Claude 中):

'列出我组织中的所有用户'
'邀请用户 [email protected] 成为成员'
'显示上个月的 API 使用统计'
'列出我的所有工作区'
'获取工作区 workspace-slug 的详细信息'
'查看所有配置'
'列出所有 API 密钥'
'获取配置 config-slug 的详细信息'

LLM 客户端会将您的自然语言指令转换为对 Portkey MCP Server 中工具的调用，并返回 Portkey.ai 平台的相关信息。

关键词