@gremlin/mcp-server 2.2.1 → 2.3.0

package/Readme.md

@@ -18,6 +18,13 @@ This MCP server provides access to Gremlin's reliability testing and management
 - Node.js 18 or higher
 - A valid [Gremlin API key](https://app.gremlin.com/settings/api-keys)
 
+### Environment Variables
+
+| Variable | Required | Default | Description |
+| --- | --- | --- | --- |
+| `GREMLIN_API_KEY` | Yes | — | Your Gremlin API key. The server exits immediately if this is missing. |
+| `GREMLIN_SERVICE_URL` | No | `https://api.gremlin.com/v1` | Base URL for the Gremlin API, including the version prefix. Override to target a staging or self-hosted environment. |
+
 ### Claude Desktop
 
 Go to Claude Settings > Developer and add the following to your `claude_desktop_config.json`:
@@ -38,6 +45,19 @@ Go to Claude Settings > Developer and add the following to your `claude_desktop_
 
 ### VS Code / Cursor
 
+> Requires [VS Code 1.99](https://code.visualstudio.com/updates/v1_99) or higher (MCP support was added in the March 2025 release). See also: [Cursor MCP docs](https://cursor.com/docs/mcp).
+
+Open your MCP Settings:
+ - Cursor: `Cmd+Shift+P` → search "Cursor Settings" → Tools & Integrations → Add Custom MCP
+ - VSCode: `Cmd+Shift+P` → type "MCP: Open User Configuration"
+
+Or directly edit them:
+ - Cursor (Mac/Linux): `~/.cursor/mcp.json`
+ - Cursor (Win): `%USERPROFILE%\.cursor\mcp.json`
+ - VSCode (Mac): `~/Library/Application Support/Code/User/mcp.json`
+ - VSCode (Win): `%APPDATA%\Code\User\mcp.json`
+ - VSCode (Linux): `~/.config/Code/User/mcp.json`
+
 Add the following to your MCP settings:
 
 ```json
@@ -63,6 +83,7 @@ Add the following to your MCP settings:
 }
 ```
 
+
 ## Available Tools
 
 ### Service Management

package/build/client/gremlin.d.ts

@@ -0,0 +1,27 @@
+import type { GremlinClient } from './interface';
+import type { Page, PendingReliabilityTestRun, PricingReport, RecentRunResponse, ReliabilityReport, ReliabilityTestRun, ReliabilityTestRunParameters, ReliabilityTestSuite, ReportPeriod, Self, Service, Team, TrackingPeriod, User } from '../types';
+export declare class GremlinApi implements GremlinClient {
+    private baseUrl;
+    private userAgent;
+    private cache;
+    listUsers(): Promise<User[]>;
+    listTeams(): Promise<Team[]>;
+    getTeam(teamId: string): Promise<Team>;
+    listServicesForTeam(teamId: string): Promise<Page<Service>>;
+    getReliabilityReport(serviceId: string, teamId: string, date?: string): Promise<ReliabilityReport>;
+    getServiceDependencies(serviceId: string, teamId: string): Promise<ReliabilityReport>;
+    getServiceStatusChecks(serviceId: string, teamId: string): Promise<ReliabilityReport>;
+    getServiceRisks(serviceId: string, teamId: string): Promise<ReliabilityReport>;
+    getAllTestSuite(): Promise<ReliabilityTestSuite[]>;
+    getRecentReliabilityTests(teamId: string, limit?: number, pageToken?: string): Promise<Page<RecentRunResponse>>;
+    getReliabilityExperiment(serviceId: string, teamId: string, dependencyId?: string, testId?: string, limit?: number): Promise<Page<ReliabilityTestRun> | ReliabilityTestRun>;
+    runReliabilityTest(reliabilityTestId: string, teamId: string, params: ReliabilityTestRunParameters): Promise<ReliabilityTestRun>;
+    getPendingTestRuns(serviceId: string, teamId: string): Promise<PendingReliabilityTestRun[]>;
+    getService(serviceId: string, teamId: string): Promise<Page<Service>>;
+    getPricingReport(startDate: string, endDate: string, trackingPeriod?: TrackingPeriod): Promise<PricingReport>;
+    getClientSummary(teamId: string, start: string, end: string, period: ReportPeriod): Promise<unknown>;
+    getAttackSummary(teamId: string, start: string, end: string, period: ReportPeriod): Promise<unknown>;
+    getSelf(): Promise<Self>;
+    execute<T = unknown>(method: string, path: string, queryParams?: Record<string, string>, body?: Record<string, unknown>): Promise<T>;
+    private requestWithRetry;
+}

package/build/client/interface.d.ts

@@ -0,0 +1,22 @@
+import type { Page, PendingReliabilityTestRun, PricingReport, RecentRunResponse, ReliabilityReport, ReliabilityTestRun, ReliabilityTestRunParameters, ReliabilityTestSuite, ReportPeriod, Self, Service, Team, TrackingPeriod, User } from '../types';
+export interface GremlinClient {
+    listUsers(): Promise<User[]>;
+    listTeams(): Promise<Team[]>;
+    getTeam(teamId: string): Promise<Team>;
+    listServicesForTeam(teamId: string): Promise<Page<Service>>;
+    getService(serviceId: string, teamId: string): Promise<Page<Service>>;
+    getSelf(): Promise<Self>;
+    getReliabilityReport(serviceId: string, teamId: string, date?: string): Promise<ReliabilityReport>;
+    getServiceDependencies(serviceId: string, teamId: string): Promise<ReliabilityReport>;
+    getServiceStatusChecks(serviceId: string, teamId: string): Promise<ReliabilityReport>;
+    getServiceRisks(serviceId: string, teamId: string): Promise<ReliabilityReport>;
+    getAllTestSuite(): Promise<ReliabilityTestSuite[]>;
+    getRecentReliabilityTests(teamId: string, limit?: number, pageToken?: string): Promise<Page<RecentRunResponse>>;
+    getReliabilityExperiment(serviceId: string, teamId: string, dependencyId?: string, testId?: string, limit?: number): Promise<Page<ReliabilityTestRun> | ReliabilityTestRun>;
+    runReliabilityTest(reliabilityTestId: string, teamId: string, params: ReliabilityTestRunParameters): Promise<ReliabilityTestRun>;
+    getPendingTestRuns(serviceId: string, teamId: string): Promise<PendingReliabilityTestRun[]>;
+    getPricingReport(startDate: string, endDate: string, trackingPeriod?: TrackingPeriod): Promise<PricingReport>;
+    getClientSummary(teamId: string, start: string, end: string, period: ReportPeriod): Promise<unknown>;
+    getAttackSummary(teamId: string, start: string, end: string, period: ReportPeriod): Promise<unknown>;
+    execute<T = unknown>(method: string, path: string, queryParams?: Record<string, string>, body?: Record<string, unknown>): Promise<T>;
+}

package/build/elicitation.d.ts

@@ -0,0 +1,27 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+export interface ElicitationOption {
+    label: string;
+    value: string;
+    description?: string;
+}
+/**
+ * Abstracts over any mechanism that asks a user to pick from a set of options.
+ * Implement this to plug custom confirmation UIs into the Gremlin tools.
+ */
+export interface ElicitationClient {
+    /**
+     * Prompt the user to choose one of the provided options.
+     * Returns the `value` of the chosen option.
+     * Throw if the prompt cannot be shown (e.g. unsupported runtime).
+     */
+    confirm(prompt: string, options: ElicitationOption[]): Promise<string>;
+}
+/**
+ * Adapter that implements ElicitationClient on top of the MCP SDK's elicitInput.
+ * Treats the first option as "proceed" and everything else as "cancel".
+ */
+export declare class McpElicitationClient implements ElicitationClient {
+    private readonly server;
+    constructor(server: McpServer);
+    confirm(prompt: string, options: ElicitationOption[]): Promise<string>;
+}

package/build/index.d.ts

@@ -0,0 +1,11 @@
+export type { GremlinClient } from './client/interface';
+export type { ElicitationClient, ElicitationOption } from './elicitation';
+export { McpElicitationClient } from './elicitation';
+export type { Page, PendingReliabilityTestRun, PolicyEvaluation, PricingReport, PricingUsage, RecentRunResponse, ReliabilityCategorySummary, ReliabilityReport, ReliabilityTestRun, ReliabilityTestRunParameters, ReliabilityTestSuite, ReportPeriod, Self, Service, Team, TrackingPeriod, User, } from './types';
+export { createGetReliabilityExperimentTool, createGetReliabilityReportTool, createGetCurrentTestSuiteTool, createRunReliabilityTestTool, createGetPendingTestRunsTool, createGetRecentReliabilityTestsTool, } from './tools/reliability-management';
+export { createListServicesTool, createGetServiceDependenciesTool, createGetServiceStatusChecksTool, createListServiceRisksTool, } from './tools/services';
+export { createListTeamsTool } from './tools/teams';
+export { createGetPricingReportTool, createGetClientSummaryTool, createGetAttackSummaryTool, } from './tools/company';
+export { createSearchGremlinApiTool, createExecuteGremlinApiTool } from './tools/openapi';
+export { registerTools } from './tools/index';
+export { registerResources } from './resources/index';