Portkey Admin MCP Server

🚀 Portkey MCP Server

Transform your AI assistant into a Portkey platform expert! This MCP server connects Claude and Portkey's APIs, enabling comprehensive management of AI configurations, workspaces, analytics, and user access.

🚀 Quick Start

📦 Installation

Install from Source

1. Clone this repository.
2. Install dependencies:

npm install

3. Copy the example environment file:

cp .env.example .env

4. Add your Portkey API key to the .env file:

PORTKEY_API_KEY=your_portkey_api_key_here

5. Then update your Claude configuration file:

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

Please ensure:

• Replace /path/to/portkey-server with your actual installation path.
• Add your Portkey API key in the env section.

After updating the configuration, restart Claude Desktop to apply the changes.

Install using Smithery

To automatically install the Portkey MCP server via Smithery:

npx -y @smithery/cli install @r-huijts/portkey-admin-mcp-server --client claude

💻 Usage Examples

Basic Usage

Here are some practical application scenarios:

• "Show me my current API usage statistics?"
• "Display the performance metrics of different models"
• "Create a .workspace for a new team project"
• "Show me my current API key usage and remaining quota?"
• "Generate an analysis report of API calls from last month"
• "Set rate limits for my development environment"
• "Configure the fallback behavior of the production endpoint"
• "Add team members to my Portkey workspace"
• "Show me the latency statistics of my API calls"
• "Set custom headers for my API requests"

📚 Documentation

🔑 Environment Variables

✨ Features

This MCP server provides you with full access to the Portkey platform through the following features:

User and Access Management

• User Management: List and manage all users in your organization.
• User Invitation: Invite new users with customizable roles and permissions.
• Workspace Access Control: Configure user access levels for different workspaces.
• Role-based Control: Assign administrator, manager, or member roles at the organization and workspace levels.

Analytics and Reporting

• Usage Analytics: Track detailed user activities and request patterns.
• Cost Analysis: Monitor and analyze costs over different periods.
• Request Metrics: View the number of requests, token usage, and response time.
• Filtered Reports: Generate reports based on custom criteria, such as status codes, virtual keys, and time periods.

Workspace Management

• Workspace Overview: List and view detailed information about all workspaces.
• Workspace Templates: Configure workspaces to meet specific requirements.
• Resource Allocation: Allocate resources among different workspaces.
• Workspace Monitoring: Monitor the performance and usage of workspaces in real-time.

Configuration and Management

• Global Settings: Manage organization-wide default settings and policies.
• Logging: Capture and analyze logs of platform activities.
• Security Controls: Implement authentication, authorization, and encryption measures.
• Integration and Extension: Integrate with other tools and services to extend functionality.

💡 Usage Tip

This MCP server provides powerful extension capabilities for Claude, enabling it to seamlessly connect to the Portkey platform. By configuring environment variables and following the guide, you can easily integrate Claude into your Portkey workflow.

Example Configuration

Here is an example of a typical .env file:

PORTKEY_API_KEY=your_portkey_api_key_here

Then add the startup script for the MCP server in package.json:

{
  "scripts": {
    "start": "node build/index.js"
  }
}

Run the server:

npm start

⚠️ Important Note

• Ensure the security of your API key and avoid leakage.
• Regularly check for updates to maintain optimal performance and security.
• Refer to the full documentation to understand all features and configuration options.

With this MCP server, you can combine the powerful capabilities of Claude with the rich features of the Portkey platform to create an efficient, flexible, and secure working environment.