convex
Version:
Client for the Convex Cloud
107 lines • 3.99 kB
TypeScript
import { BigBrainAuth, Context, ErrorType } from "../../../bundler/context.js";
import { Filesystem } from "../../../bundler/fs.js";
import { Ora } from "ora";
import { DeploymentSelectionWithinProject, DeploymentSelectionOptions } from "../api.js";
import { DeploymentSelection } from "../deploymentSelection.js";
export interface McpOptions extends DeploymentSelectionOptions {
projectDir?: string;
disableTools?: string;
dangerouslyEnableProductionDeployments?: boolean;
cautiouslyAllowProductionPii?: boolean;
}
export declare class RequestContext implements Context {
options: McpOptions;
fs: Filesystem;
deprecationMessagePrinted: boolean;
spinner: Ora | undefined;
_cleanupFns: Record<string, (exitCode: number, err?: any) => Promise<void>>;
_bigBrainAuth: BigBrainAuth | null;
constructor(options: McpOptions);
crash(args: {
exitCode: number;
errorType?: ErrorType;
errForSentry?: any;
printedMessage: string | null;
}): Promise<never>;
flushAndExit(): void;
registerCleanup(fn: (exitCode: number, err?: any) => Promise<void>): string;
removeCleanup(handle: string): (exitCode: number, err?: any) => Promise<void>;
bigBrainAuth(): BigBrainAuth | null;
_updateBigBrainAuth(auth: BigBrainAuth | null): void;
decodeDeploymentSelector(encoded: string): Promise<{
projectDir: string;
deployment: {
kind: "previewName";
previewName: string;
} | {
kind: "deploymentName";
deploymentName: string;
} | {
kind: "prod";
} | {
kind: "implicitProd";
} | {
kind: "ownDev";
} | {
kind: "deploymentSelector";
selector: string;
};
}>;
/** Decode a deployment selector without checking the production guard. Use for read-only tools that don't expose PII (e.g. insights). */
decodeDeploymentSelectorUnchecked(encoded: string): {
deployment: {
kind: "previewName";
previewName: string;
} | {
kind: "deploymentName";
deploymentName: string;
} | {
kind: "prod";
} | {
kind: "implicitProd";
} | {
kind: "ownDev";
} | {
kind: "deploymentSelector";
selector: string;
};
projectDir: string;
};
/** Decode a deployment selector for read-only tools that may expose PII (e.g. data, logs, queries). Requires --cautiously-allow-production-pii. */
decodeDeploymentSelectorReadOnly(encoded: string): Promise<{
projectDir: string;
deployment: {
kind: "previewName";
previewName: string;
} | {
kind: "deploymentName";
deploymentName: string;
} | {
kind: "prod";
} | {
kind: "implicitProd";
} | {
kind: "ownDev";
} | {
kind: "deploymentSelector";
selector: string;
};
}>;
get productionDeploymentsDisabled(): boolean;
get productionPiiAllowed(): boolean | undefined;
}
export declare class RequestCrash {
private exitCode;
private errorType;
printedMessage: string;
constructor(exitCode: number, errorType: ErrorType | undefined, printedMessage: string | null);
toString(): string;
}
export declare function encodeDeploymentSelector(projectDir: string, deployment: DeploymentSelectionWithinProject): string;
/**
* Get the deployment selection for MCP tools. The agent can pass different
* values of `selectionWithinProject` into a tool, so we overwrite the
* `selectionWithinProject` of the `DeploymentSelection` if it exists.
*/
export declare function getMcpDeploymentSelection(ctx: RequestContext, decodedDeploymentSelector: DeploymentSelectionWithinProject): Promise<DeploymentSelection>;
//# sourceMappingURL=requestContext.d.ts.map