Portkey MCP Server

🚀 Portkey-MCP-Server

Portkey-MCP-Server is a server that implements the Model Context Protocol (MCP) for Portkey. It serves as a bridge connecting various AI tools and services, supporting integration with multiple applications and platforms through a standard protocol.

🚀 Quick Start

Portkey-MCP-Server is a server designed to implement the Model Context Protocol (MCP) for Portkey. It acts as a bridge between various AI tools and services, enabling seamless integration with multiple applications and platforms via a standard protocol.

✨ Features

Portkey-MCP-Server supports the following features:

1. Protocol Support: Adheres to the MCP protocol to implement tool invocation and session management.
2. Tool Integration: Currently supports the prompt_render tool for handling prompt templates and variable substitution.
3. Multi-platform Compatibility: Can seamlessly integrate with applications such as Portkey CLI and Claude Desktop.

📦 Installation

Install via Docker

1. Pull the image:

docker pull ericmccaleb/portkey-mcp-server:latest

2. Start the container:

docker run -it --rm ericmccaleb/portkey-mcp-server:latest

Install using Binary File

1. Download the binary file suitable for your target operating system.
2. Unzip and grant execution permissions:

unzip portkey-mcp-server.zip && chmod +x portkey-mcp-server

3. Run the program:

./portkey-mcp-server

📚 Documentation

Environment Variable Configuration

When running the server, you can configure it through the following environment variables:

• PORTKEY_API_KEY: The API access key for the Portkey platform.
• TRANSPORT: The communication method, with optional values of stdio or sae.

Example:

PORTKEY_API_KEY="your-api-key" TRANSPORT="sae" ./portkey-mcp-server

💻 Usage Examples

Usage via Portkey CLI

Add the following configuration to ~/.config/portkey/mcp-servers.json:

Using Docker:

{
  "mcpServers": {
    "Portkey": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e", "PORTKEY_API_KEY=your-api-key",
        "-e", "TRANSPORT=sae",
        "ericmccaleb/portkey-mcp-server:latest"
      ]
    }
  }
}

Using Binary File:

{
  "mcpServers": {
    "Portkey": {
      "command": "/path/to/portkey-mcp-server-binary",
      "env": {
        "PORTKEY_API_KEY": "your-api-key",
        "TRANSPORT": "sae"
      }
    }
  }
}

Usage via Claude Desktop

Claude Desktop supports the stdio mode. The configuration file path is as follows:

• macOS: ~/Library/Application Support/Claude/
• Windows: %APPDATA%\Claude\

Example configuration:

{
  "mcpServers": {
    "Portkey": {
      "command": "/path/to/portkey-mcp-server-binary",
      "env": {
        "PORTKEY_API_KEY": "your-api-key",
        "TRANSPORT": "stdio"
      }
    }
  }
}

Manual SSE Request

In sae mode, you can make HTTP requests through the following steps:

1. Establish an SSE connection:

curl http://localhost:8080/sae

Example response:

event: endpoint
data: /message?session=abc123

2. Send a request:

curl -X POST "http://localhost:8080/message" \
  -H "Content-Type: application/json" \
  -d '{"tool":"prompt_render","args":{"template":"hello_world","variables":{"name":"world"}}}'

3. Receive the response:

curl http://localhost:8080/stream?session=abc123

🔗 Contribution Guide

We welcome the community to contribute code and documentation. Please refer to the GitHub repository for the specific contribution process.

📄 License

Portkey-MCP-Server is licensed under the MIT license. See the LICENSE file for details.