Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions product/mcp-gateway/authentication/oauth.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: OAuth
description: Portkey's built-in OAuth 2.1 authentication for MCP Gateway.

Check warning on line 3 in product/mcp-gateway/authentication/oauth.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/authentication/oauth.mdx#L3

Did you really mean 'Portkey's'?
---

Portkey provides built-in OAuth 2.1 authentication for MCP Gateway. When users access MCP servers without an API key, Portkey acts as the OAuth provider and handles the authentication flow.

Check warning on line 6 in product/mcp-gateway/authentication/oauth.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/authentication/oauth.mdx#L6

Did you really mean 'Portkey'?

Check warning on line 6 in product/mcp-gateway/authentication/oauth.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/authentication/oauth.mdx#L6

Did you really mean 'Portkey'?

## When to use

Use Portkey's OAuth when:

Check warning on line 10 in product/mcp-gateway/authentication/oauth.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/authentication/oauth.mdx#L10

Did you really mean 'Portkey's'?

- Building browser-based applications where users authenticate interactively
- Using MCP clients like Claude Desktop or Cursor without API keys
Expand All @@ -29,9 +29,9 @@

## Configuration

Portkey's OAuth is enabled by default. No configuration required.

Check warning on line 32 in product/mcp-gateway/authentication/oauth.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/authentication/oauth.mdx#L32

Did you really mean 'Portkey's'?

When a request arrives without an API key or bearer token, Portkey automatically initiates the OAuth flow.

Check warning on line 34 in product/mcp-gateway/authentication/oauth.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/authentication/oauth.mdx#L34

Did you really mean 'Portkey'?

## Client integration

Expand Down Expand Up @@ -77,7 +77,7 @@

## Token management

Portkey handles token lifecycle:

Check warning on line 80 in product/mcp-gateway/authentication/oauth.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/authentication/oauth.mdx#L80

Did you really mean 'Portkey'?

- **Access tokens**: Short-lived, used for MCP requests
- **Refresh tokens**: Long-lived, used to obtain new access tokens
Expand All @@ -93,17 +93,14 @@

## Combining with external OAuth

Portkey's OAuth works alongside external OAuth. Portkey determines the authentication method based on what's in the request:

Check warning on line 96 in product/mcp-gateway/authentication/oauth.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/authentication/oauth.mdx#L96

Did you really mean 'Portkey's'?

Check warning on line 96 in product/mcp-gateway/authentication/oauth.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/authentication/oauth.mdx#L96

Did you really mean 'Portkey'?

| Request contains | Authentication method |
|------------------|----------------------|
| Portkey API key | API key authentication |

Check warning on line 100 in product/mcp-gateway/authentication/oauth.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/authentication/oauth.mdx#L100

Did you really mean 'Portkey'?
| External IdP token | External OAuth 2.0 validation |
| Nothing | Portkey OAuth 2.1 flow |

Check warning on line 102 in product/mcp-gateway/authentication/oauth.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/authentication/oauth.mdx#L102

Did you really mean 'Portkey'?

<Warning>
When using API key authentication, only **user API keys** work with MCP Gateway. Service API keys are not supported.
</Warning>

## Security considerations

Expand Down
3 changes: 0 additions & 3 deletions product/mcp-gateway/internal-mcp-servers.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
---
title: Add Internal MCP Servers
description: Add your internal MCP servers to Portkey. Get enterprise-grade auth, access control, and logging without building it.

Check warning on line 3 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L3

Did you really mean 'Portkey'?
---

Your team has built MCP servers for internal docs, proprietary APIs, databases. Now you need authentication, access control, and logging for each one. Building that infrastructure is expensive. Maintaining it is harder.

**Add your internal servers to Portkey.** Get enterprise-grade infrastructure without writing a line of auth code.

Check warning on line 8 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L8

Did you really mean 'Portkey'?

---

## Why Use Portkey's MCP Gateway

Check warning on line 12 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L12

Did you really mean 'Portkey's'?

- **Authentication without building auth.** Every MCP server needs it. Without Portkey, you build OAuth flows, validate tokens, manage sessions—for every server. With Portkey, authentication happens once at the gateway. Your servers receive authenticated requests.

Check warning on line 14 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L14

Did you really mean 'Portkey'?

Check warning on line 14 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L14

Did you really mean 'Portkey'?

- **User identity forwarding.** Your server often needs to know *who* is making a request. Portkey forwards user claims (email, team, roles) automatically. No OAuth implementation required.

Check warning on line 16 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L16

Did you really mean 'Portkey'?

- **Access control without deployments.** Control who accesses which servers and tools. When someone leaves a team, revoke access in Portkey. No code changes.

Check warning on line 18 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L18

Did you really mean 'Portkey'?

- **Full observability.** Every tool call logged—who called what, with what parameters, what was returned. Debug issues in minutes.

Expand All @@ -41,16 +41,16 @@

| Layer | Purpose | Options |
|-------|---------|---------|
| **Gateway** | User proves identity to Portkey | API Key, OAuth, External IdP |

Check warning on line 44 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L44

Did you really mean 'Portkey'?
| **Server** | Portkey authenticates to your server | OAuth Auto, API Key None, Headers |

Check warning on line 45 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L45

Did you really mean 'Portkey'?

Users authenticate to Portkey with SSO. Portkey authenticates to your server with an API key. Users never see your server's credentials.

Check warning on line 47 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L47

Did you really mean 'Portkey'?

Check warning on line 47 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L47

Did you really mean 'Portkey'?

---

## Setup

Your MCP server must be accessible over HTTP and implement MCP protocol over Streamable HTTP transport.

Check warning on line 53 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L53

Did you really mean 'Streamable'?

<Note>
Using STDIO transport? Expose it as an HTTP endpoint first.
Expand All @@ -65,7 +65,7 @@
| **Name** | Display name (e.g., "Internal Documentation") |
| **Slug** | URL identifier (e.g., `internal-docs`) |
| **Server URL** | Your server's MCP endpoint |
| **Auth Type** | How Portkey authenticates to your server |

Check warning on line 68 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L68

Did you really mean 'Portkey'?

For **Auth Type**: use `None` if your server is in a private network, `Headers` for API keys, or `OAuth Auto` for servers supporting OAuth 2.1.

Expand All @@ -75,7 +75,7 @@

<Tabs>
<Tab title="JWT Header">
Portkey generates a signed JWT with user claims. Your server verifies using Portkey's public keys.

Check warning on line 78 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L78

Did you really mean 'Portkey'?

Check warning on line 78 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L78

Did you really mean 'Portkey's'?

```json
{
Expand All @@ -91,7 +91,7 @@
</Tab>

<Tab title="Claims Header">
Portkey sends user claims as JSON. Simpler, no cryptographic verification.

Check warning on line 94 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L94

Did you really mean 'Portkey'?

```json
{
Expand Down Expand Up @@ -123,7 +123,7 @@

### Connect

Users connect through Portkey:

Check warning on line 126 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L126

Did you really mean 'Portkey'?

```json
{
Expand Down Expand Up @@ -152,9 +152,6 @@

**Portkey API Key** — Create keys in **Settings → API Keys**. Keys are scoped to workspaces.

<Warning>
When using API key authentication, only **user API keys** work with MCP Gateway. Service API keys are not supported.
</Warning>

```json
{
Expand Down Expand Up @@ -201,7 +198,7 @@
}
```

Developers use their Portkey API key. Your server receives user identity. Every query appears in Portkey logs. Access control managed centrally—no server changes needed.

Check warning on line 201 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L201

Did you really mean 'Portkey'?

Check warning on line 201 in product/mcp-gateway/internal-mcp-servers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/internal-mcp-servers.mdx#L201

Did you really mean 'Portkey'?

---

Expand Down
4 changes: 0 additions & 4 deletions product/mcp-gateway/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Quickstart
description: Add DeepWiki to Portkey MCP Gateway and connect it to Claude.

Check warning on line 3 in product/mcp-gateway/quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/quickstart.mdx#L3

Did you really mean 'Portkey'?
---

This quickstart covers:
Expand Down Expand Up @@ -74,7 +74,7 @@

## 3) Use the URL in Claude (Desktop / Code)

Add a new MCP server that points to the Portkey URL. You have two authentication options:

Check warning on line 77 in product/mcp-gateway/quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/quickstart.mdx#L77

Did you really mean 'Portkey'?

<Tabs>
<Tab title="OAuth (Recommended)">
Expand Down Expand Up @@ -118,10 +118,6 @@
When creating your workspace API key, ensure it has **MCP Invoke** permissions enabled.
</Note>

<Warning>
Only **user API keys** work with MCP Gateway. Service API keys are not supported.
</Warning>

<Info>
**Best for:** CI/CD pipelines, backend services, or automated agents where interactive OAuth isn't possible.
</Info>
Expand All @@ -129,7 +125,7 @@
</Tabs>

<Note>
Even though DeepWiki doesn't require authentication to the upstream server, you still need to authenticate with Portkey (via OAuth or API key) to access the server through the gateway.

Check warning on line 128 in product/mcp-gateway/quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (portkey-docs) - vale-spellcheck

product/mcp-gateway/quickstart.mdx#L128

Did you really mean 'Portkey'?
</Note>

---
Expand Down