Skip to content

Add traffic control support #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joshmgross wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add traffic control support #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c55a35
Add traffic control support
joshmgross Mar 26, 2026
5298ddd
Rename `TrafficActor` to `Actor`
joshmgross Mar 26, 2026
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
2 changes: 1 addition & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion src/gram.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { executeWriteQueryGram } from "./tools/execute-write-query.ts";
import { getInsightsGram } from "./tools/get-insights.ts";
import { listClusterSizesGram } from "./tools/list-cluster-sizes.ts";
import { searchDocumentationGram } from "./tools/search-documentation.ts";
import { trafficControlGram } from "./tools/traffic-control.ts";

const gram = new Gram({
envSchema: {
Expand All @@ -25,6 +26,7 @@ const gram = new Gram({
.extend(executeWriteQueryGram)
.extend(getInsightsGram)
.extend(listClusterSizesGram)
.extend(searchDocumentationGram);
.extend(searchDocumentationGram)
.extend(trafficControlGram);

export default gram;
233 changes: 216 additions & 17 deletions src/lib/planetscale-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ export interface Branch {
has_replicas: boolean;
}

export interface Actor {
id: string;
display_name: string;
avatar_url: string;
}

export interface VitessCredentials {
id: string;
username: string;
Expand Down Expand Up @@ -74,7 +80,7 @@ export class PlanetScaleAPIError extends Error {
async function apiRequest<T>(
endpoint: string,
authHeader: string,
options: RequestInit = {}
options: RequestInit = {},
Copy link
Copy Markdown
Author

@joshmgross joshmgross Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My editor automatically applied some formatting, it doesn't look like we have any formatting specified so I don't know where it came from 😄

): Promise<T> {
const url = `${API_BASE}${endpoint}`;

Expand All @@ -99,22 +105,22 @@ async function apiRequest<T>(
throw new PlanetScaleAPIError(
"Resource not found. Please check your organization, database, and branch names.",
response.status,
details
details,
);
}

if (response.status === 401 || response.status === 403) {
throw new PlanetScaleAPIError(
"Permission denied. Please check your API token has the required permissions.",
response.status,
details
details,
);
}

throw new PlanetScaleAPIError(
`API request failed: ${response.statusText}`,
response.status,
details
details,
);
}

Expand All @@ -132,11 +138,11 @@ async function apiRequest<T>(
export async function getDatabase(
organization: string,
database: string,
authHeader: string
authHeader: string,
): Promise<Database> {
return apiRequest<Database>(
`/organizations/${encodeURIComponent(organization)}/databases/${encodeURIComponent(database)}`,
authHeader
authHeader,
);
}

Expand All @@ -147,11 +153,11 @@ export async function getBranch(
organization: string,
database: string,
branch: string,
authHeader: string
authHeader: string,
): Promise<Branch> {
return apiRequest<Branch>(
`/organizations/${encodeURIComponent(organization)}/databases/${encodeURIComponent(database)}/branches/${encodeURIComponent(branch)}`,
authHeader
authHeader,
);
}

Expand All @@ -164,7 +170,7 @@ export async function createVitessCredentials(
branch: string,
role: VitessRole,
authHeader: string,
replica?: boolean
replica?: boolean,
): Promise<VitessCredentials> {
const timestamp = Date.now();
const name = `mcp-query-${timestamp}`;
Expand All @@ -189,7 +195,7 @@ export async function createVitessCredentials(
ttl: 60, // 60 seconds TTL
replica: replica ?? false,
}),
}
},
);

return {
Expand All @@ -209,7 +215,7 @@ export async function createPostgresCredentials(
database: string,
branch: string,
inheritedRoles: PostgresInheritedRole[],
authHeader: string
authHeader: string,
): Promise<PostgresCredentials> {
const timestamp = Date.now();
const name = `mcp-query-${timestamp}`;
Expand All @@ -234,7 +240,7 @@ export async function createPostgresCredentials(
inherited_roles: inheritedRoles,
ttl: 60, // 60 seconds TTL
}),
}
},
);

return {
Expand All @@ -259,15 +265,17 @@ export async function deletePostgresRole(
branch: string,
roleId: string,
authHeader: string,
options?: { successor?: string }
options?: { successor?: string },
): Promise<void> {
await apiRequest<void>(
`/organizations/${encodeURIComponent(organization)}/databases/${encodeURIComponent(database)}/branches/${encodeURIComponent(branch)}/roles/${encodeURIComponent(roleId)}`,
authHeader,
{
method: "DELETE",
body: options?.successor ? JSON.stringify({ successor: options.successor }) : undefined,
}
body: options?.successor
? JSON.stringify({ successor: options.successor })
: undefined,
},
);
}

Expand All @@ -279,11 +287,202 @@ export async function deleteVitessPassword(
database: string,
branch: string,
passwordId: string,
authHeader: string
authHeader: string,
): Promise<void> {
await apiRequest<void>(
`/organizations/${encodeURIComponent(organization)}/databases/${encodeURIComponent(database)}/branches/${encodeURIComponent(branch)}/passwords/${encodeURIComponent(passwordId)}`,
authHeader,
{ method: "DELETE" }
{ method: "DELETE" },
);
}

// --- Traffic Control ---

export interface TrafficRuleTag {
key_id: string;
key: string;
value: string;
source: "sql" | "system";
}

export interface TrafficRule {
id: string;
kind: "match";
tags: TrafficRuleTag[];
fingerprint: string;
keyspace: string;
actor: Actor;
syntax_highlighted_sql: string;
created_at: string;
}

export type TrafficBudgetMode = "enforce" | "warn" | "off";

export interface TrafficBudget {
id: string;
name: string;
mode: TrafficBudgetMode;
capacity: number | null;
rate: number | null;
burst: number | null;
concurrency: number | null;
actor: Actor;
rules: TrafficRule[];
created_at: string;
updated_at: string;
}

export interface PaginatedResponse<T> {
current_page: number;
next_page: number | null;
next_page_url: string | null;
prev_page: number | null;
prev_page_url: string | null;
data: T[];
}

function branchPath(
organization: string,
database: string,
branch: string,
): string {
return `/organizations/${encodeURIComponent(organization)}/databases/${encodeURIComponent(database)}/branches/${encodeURIComponent(branch)}`;
}

export async function listTrafficBudgets(
organization: string,
database: string,
branch: string,
authHeader: string,
opts?: {
page?: number;
per_page?: number;
period?: string;
fingerprint?: string;
created_at?: string;
},
): Promise<PaginatedResponse<TrafficBudget>> {
const params = new URLSearchParams();
if (opts?.page) params.set("page", String(opts.page));
if (opts?.per_page) params.set("per_page", String(opts.per_page));
if (opts?.period) params.set("period", opts.period);
if (opts?.fingerprint) params.set("fingerprint", opts.fingerprint);
if (opts?.created_at) params.set("created_at", opts.created_at);
const qs = params.toString();
return apiRequest<PaginatedResponse<TrafficBudget>>(
`${branchPath(organization, database, branch)}/traffic/budgets${qs ? `?${qs}` : ""}`,
authHeader,
);
}

export async function getTrafficBudget(
organization: string,
database: string,
branch: string,
id: string,
authHeader: string,
): Promise<TrafficBudget> {
return apiRequest<TrafficBudget>(
`${branchPath(organization, database, branch)}/traffic/budgets/${encodeURIComponent(id)}`,
authHeader,
);
}

export interface CreateTrafficBudgetInput {
name: string;
mode: TrafficBudgetMode;
capacity?: number;
rate?: number;
burst?: number;
concurrency?: number;
rules?: string[];
}

export async function createTrafficBudget(
organization: string,
database: string,
branch: string,
body: CreateTrafficBudgetInput,
authHeader: string,
): Promise<TrafficBudget> {
return apiRequest<TrafficBudget>(
`${branchPath(organization, database, branch)}/traffic/budgets`,
authHeader,
{ method: "POST", body: JSON.stringify(body) },
);
}

export interface UpdateTrafficBudgetInput {
name?: string;
mode?: TrafficBudgetMode;
capacity?: number;
rate?: number;
burst?: number;
concurrency?: number;
rules?: string[];
}

export async function updateTrafficBudget(
organization: string,
database: string,
branch: string,
id: string,
body: UpdateTrafficBudgetInput,
authHeader: string,
): Promise<TrafficBudget> {
return apiRequest<TrafficBudget>(
`${branchPath(organization, database, branch)}/traffic/budgets/${encodeURIComponent(id)}`,
authHeader,
{ method: "PATCH", body: JSON.stringify(body) },
);
}

export async function deleteTrafficBudget(
organization: string,
database: string,
branch: string,
id: string,
authHeader: string,
): Promise<void> {
await apiRequest<void>(
`${branchPath(organization, database, branch)}/traffic/budgets/${encodeURIComponent(id)}`,
authHeader,
{ method: "DELETE" },
);
}

export interface CreateTrafficRuleInput {
kind: "match";
tags?: Array<{ key: string; value: string }>;
fingerprint?: string;
}

export async function createTrafficRule(
organization: string,
database: string,
branch: string,
budgetId: string,
body: CreateTrafficRuleInput,
authHeader: string,
): Promise<TrafficRule> {
return apiRequest<TrafficRule>(
`${branchPath(organization, database, branch)}/traffic/budgets/${encodeURIComponent(budgetId)}/rules`,
authHeader,
{ method: "POST", body: JSON.stringify(body) },
);
}

export async function deleteTrafficRule(
organization: string,
database: string,
branch: string,
budgetId: string,
ruleId: string,
authHeader: string,
): Promise<void> {
await apiRequest<void>(
`${branchPath(organization, database, branch)}/traffic/budgets/${encodeURIComponent(budgetId)}/rules/${encodeURIComponent(ruleId)}`,
authHeader,
{ method: "DELETE" },
);
}
Loading