Portkey Admin

Exposes Portkey Admin API capabilities via MCP for prompts, configs, analytics, and governance.

javascript

1

GitHub Stars

javascript

Language

5 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "s-b-e-n-s-o-n-portkey-admin-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "portkey-admin-mcp"
      ],
      "env": {
        "PORTKEY_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}

The Portkey Admin MCP Server provides a centralized runtime to expose Portkey Admin API capabilities as an MCP (Managed Command Protocol) server. It enables you to manage prompts, workspaces, configs, API keys, analytics, governance, and more through a standardized interface that can be consumed by MCP clients and tools.

How to use

You run the MCP server locally or via a hosted runtime and connect to it using an MCP client. Start the server with the command that matches your environment, then invoke tools exposed by the server to manage users, workspaces, prompts, configurations, and analytics. You can run the server in stdio mode for local CLI-style access or in an HTTP-enabled workflow for remote clients.

Two common ways to run the Portkey Admin MCP Server are demonstrated below. Use the npx-based approach if you want a quick, in-context start without building, or run the compiled Node.js entry point after building from source for a production-style setup.

How to install

Prerequisites you need before installing the MCP server are Node.js and a JavaScript package manager. Ensure you have a recent Node.js version installed, and have either npm or npx available in your command path.

Option A: Quick start using npx (no local build required)

# Start the MCP server via npx
npx -y portkey-admin-mcp

Option B: Build from source and run the built index

git clone https://github.com/s-b-e-n-s-o-n/portkey-admin-mcp.git
cd portkey-admin-mcp
npm install
npm run build

After building, start the server using the Node.js runtime pointing to the built entry, with your API key configured via environment variables as needed.

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

Notes on deployment and environment

You can also run the server in Docker and provide the API key as an environment variable. The container exposes the MCP port for HTTP-based clients.

docker build -t portkey-admin-mcp .
docker run -e PORTKEY_API_KEY=your_key -p 3000:3000 portkey-admin-mcp

Available tools

list_all_users

List all users in the organization

get_user

Get user details

update_user

Update user information

delete_user

Remove a user from the organization

invite_user

Invite a new user to join the organization

list_workspaces

List all workspaces in the organization

get_workspace

Get details for a specific workspace

create_workspace

Create a new workspace

update_workspace

Update workspace details

delete_workspace

Delete a workspace