@mcp-consultant-tools/rest-api 27.0.0 → 28.0.0-beta.10

package/build/tools/rest-tools.js

@@ -0,0 +1,166 @@
+/**
+ * REST API tool registrations
+ */
+import { z } from "zod";
+import { createErrorResponse, createSuccessResponse, } from "@mcp-consultant-tools/core";
+import { descWithExamples, ENDPOINT_EXAMPLES, METHOD_EXAMPLES, HOST_OVERRIDE_EXAMPLES, ENDPOINT_FILTER_EXAMPLES, ENTITY_EXAMPLES, } from "../tool-examples.js";
+export function registerRestTools(server, ctx) {
+    // Tool: rest-request
+    server.tool("rest-request", `Test a REST API endpoint with automatic authentication. Supports GET, POST, PUT, DELETE, PATCH methods. Authentication is handled automatically based on server configuration (OAuth2 client credentials, bearer token, basic auth, or API key). Returns detailed request/response information including timing, headers, and body.`, {
+        method: z
+            .enum(["GET", "POST", "PUT", "DELETE", "PATCH"])
+            .describe(descWithExamples("HTTP method to use", METHOD_EXAMPLES)),
+        endpoint: z
+            .string()
+            .describe(descWithExamples('Endpoint path. Do not include the full URL - only the path.', ENDPOINT_EXAMPLES)),
+        body: z
+            .any()
+            .optional()
+            .describe("Request body for POST/PUT/PATCH requests (object or string)"),
+        headers: z
+            .record(z.string())
+            .optional()
+            .describe("Additional headers for this request. Do not use for auth - configure auth via environment variables."),
+        host: z
+            .string()
+            .optional()
+            .describe(descWithExamples("Override base URL for this request only", HOST_OVERRIDE_EXAMPLES)),
+    }, async ({ method, endpoint, body, headers, host, }) => {
+        try {
+            // Validate endpoint doesn't contain full URL
+            const urlPattern = /^(https?:\/\/|www\.)/i;
+            if (urlPattern.test(endpoint)) {
+                return createErrorResponse(new Error(`Invalid endpoint format. Do not include full URLs. Use just the path (e.g., "/api/users") and optionally specify 'host' to override the base URL.`), "rest-request");
+            }
+            const options = {
+                method,
+                endpoint,
+                body,
+                headers,
+                host,
+            };
+            const result = await ctx.restApi.request(options);
+            return createSuccessResponse(result);
+        }
+        catch (error) {
+            return createErrorResponse(error, "rest-request");
+        }
+    });
+    // Tool: rest-config
+    server.tool("rest-config", "Get the current REST API service configuration summary, including base URL, authentication method, SSL settings, and custom headers count.", {}, async () => {
+        try {
+            const summary = ctx.restApi.getConfigSummary();
+            return createSuccessResponse(summary);
+        }
+        catch (error) {
+            return createErrorResponse(error, "rest-config");
+        }
+    });
+    // Tool: rest-refresh-token
+    server.tool("rest-refresh-token", "Force refresh the OAuth2 access token. Clears the token cache and acquires a new token on the next request. Only relevant when using OAuth2 authentication.", {}, async () => {
+        try {
+            const authMethod = ctx.restApi.getAuthMethod();
+            if (authMethod !== "oauth2") {
+                return createErrorResponse(new Error(`Token refresh only available for OAuth2 authentication. Current auth method: ${authMethod}`), "rest-refresh-token");
+            }
+            ctx.restApi.clearTokenCache();
+            return createSuccessResponse({
+                message: "OAuth2 token cache cleared. A new token will be acquired on the next request.",
+            });
+        }
+        catch (error) {
+            return createErrorResponse(error, "rest-refresh-token");
+        }
+    });
+    // Tool: rest-batch-request
+    server.tool("rest-batch-request", "Execute multiple REST API requests sequentially. Useful for testing a series of related endpoints or performing a workflow. Returns results for all requests.", {
+        requests: z.array(z.object({
+            method: z.enum(["GET", "POST", "PUT", "DELETE", "PATCH"]),
+            endpoint: z.string(),
+            body: z.any().optional(),
+            headers: z.record(z.string()).optional(),
+            host: z.string().optional(),
+        })).describe("Array of request configurations to execute sequentially"),
+        stopOnError: z
+            .boolean()
+            .optional()
+            .describe("Stop executing remaining requests if one fails (default: false)"),
+    }, async ({ requests, stopOnError = false, }) => {
+        try {
+            const results = [];
+            for (let i = 0; i < requests.length; i++) {
+                const req = requests[i];
+                try {
+                    const result = await ctx.restApi.request(req);
+                    results.push({
+                        index: i,
+                        endpoint: req.endpoint,
+                        success: !result.validation.isError,
+                        result,
+                    });
+                    if (stopOnError && result.validation.isError) {
+                        break;
+                    }
+                }
+                catch (error) {
+                    const errorMessage = error instanceof Error ? error.message : String(error);
+                    results.push({
+                        index: i,
+                        endpoint: req.endpoint,
+                        success: false,
+                        error: errorMessage,
+                    });
+                    if (stopOnError) {
+                        break;
+                    }
+                }
+            }
+            return createSuccessResponse({
+                totalRequests: requests.length,
+                executedRequests: results.length,
+                successfulRequests: results.filter((r) => r.success).length,
+                results,
+            });
+        }
+        catch (error) {
+            return createErrorResponse(error, "rest-batch-request");
+        }
+    });
+    // Tool: rest-list-endpoints
+    server.tool("rest-list-endpoints", "List all available REST API endpoints with their supported HTTP methods. Use this to discover what entities/resources are available in the API. Requires REST_OPENAPI_URL configuration pointing to your API's OpenAPI/Swagger spec.", {
+        filter: z
+            .string()
+            .optional()
+            .describe(descWithExamples("Optional filter to match endpoint paths (case-insensitive contains match)", ENDPOINT_FILTER_EXAMPLES)),
+    }, async ({ filter }) => {
+        try {
+            const result = await ctx.restApi.listEndpointsAsync(filter);
+            return createSuccessResponse(result);
+        }
+        catch (error) {
+            return createErrorResponse(error, "rest-list-endpoints");
+        }
+    });
+    // Tool: rest-get-schema
+    server.tool("rest-get-schema", "Get the schema/field definitions for a specific entity. Returns field names, types, whether they're required, and any validation rules. Use this before creating or updating records to understand the data structure. Requires REST_OPENAPI_URL configuration pointing to your API's OpenAPI/Swagger spec.", {
+        entity: z
+            .string()
+            .describe(descWithExamples("Entity name (singular or plural)", ENTITY_EXAMPLES)),
+    }, async ({ entity }) => {
+        try {
+            if (!ctx.restApi.hasOpenApiConfig()) {
+                return createErrorResponse(new Error("No schema configuration available. Configure REST_OPENAPI_URL pointing to your API's OpenAPI/Swagger spec."), "rest-get-schema");
+            }
+            const schema = await ctx.restApi.getSchemaAsync(entity);
+            if (!schema) {
+                return createErrorResponse(new Error(`Entity '${entity}' not found. Use rest-list-endpoints to see available entities.`), "rest-get-schema");
+            }
+            return createSuccessResponse(schema);
+        }
+        catch (error) {
+            return createErrorResponse(error, "rest-get-schema");
+        }
+    });
+    console.error("rest-api tools registered: 6 tools");
+}
+//# sourceMappingURL=rest-tools.js.map

package/build/tools/rest-tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest-tools.js","sourceRoot":"","sources":["../../src/tools/rest-tools.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,4BAA4B,CAAC;AAGpC,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,sBAAsB,EACtB,wBAAwB,EACxB,eAAe,GAChB,MAAM,qBAAqB,CAAC;AAE7B,MAAM,UAAU,iBAAiB,CAAC,MAAW,EAAE,GAAmB;IAChE,qBAAqB;IACrB,MAAM,CAAC,IAAI,CACT,cAAc,EACd,qUAAqU,EACrU;QACE,MAAM,EAAE,CAAC;aACN,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;aAC/C,QAAQ,CAAC,gBAAgB,CAAC,oBAAoB,EAAE,eAAe,CAAC,CAAC;QACpE,QAAQ,EAAE,CAAC;aACR,MAAM,EAAE;aACR,QAAQ,CACP,gBAAgB,CAAC,6DAA6D,EAAE,iBAAiB,CAAC,CACnG;QACH,IAAI,EAAE,CAAC;aACJ,GAAG,EAAE;aACL,QAAQ,EAAE;aACV,QAAQ,CAAC,6DAA6D,CAAC;QAC1E,OAAO,EAAE,CAAC;aACP,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;aAClB,QAAQ,EAAE;aACV,QAAQ,CACP,sGAAsG,CACvG;QACH,IAAI,EAAE,CAAC;aACJ,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,gBAAgB,CAAC,yCAAyC,EAAE,sBAAsB,CAAC,CACpF;KACJ,EACD,KAAK,EAAE,EACL,MAAM,EACN,QAAQ,EACR,IAAI,EACJ,OAAO,EACP,IAAI,GAOL,EAAE,EAAE;QACH,IAAI,CAAC;YACH,6CAA6C;YAC7C,MAAM,UAAU,GAAG,uBAAuB,CAAC;YAC3C,IAAI,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC9B,OAAO,mBAAmB,CACxB,IAAI,KAAK,CACP,mJAAmJ,CACpJ,EACD,cAAc,CACf,CAAC;YACJ,CAAC;YAED,MAAM,OAAO,GAAmB;gBAC9B,MAAM;gBACN,QAAQ;gBACR,IAAI;gBACJ,OAAO;gBACP,IAAI;aACL,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAClD,OAAO,qBAAqB,CAAC,MAAM,CAAC,CAAC;QACvC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,mBAAmB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QACpD,CAAC;IACH,CAAC,CACF,CAAC;IAEF,oBAAoB;IACpB,MAAM,CAAC,IAAI,CACT,aAAa,EACb,4IAA4I,EAC5I,EAAE,EACF,KAAK,IAAI,EAAE;QACT,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC/C,OAAO,qBAAqB,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,mBAAmB,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;QACnD,CAAC;IACH,CAAC,CACF,CAAC;IAEF,2BAA2B;IAC3B,MAAM,CAAC,IAAI,CACT,oBAAoB,EACpB,6JAA6J,EAC7J,EAAE,EACF,KAAK,IAAI,EAAE;QACT,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;YAE/C,IAAI,UAAU,KAAK,QAAQ,EAAE,CAAC;gBAC5B,OAAO,mBAAmB,CACxB,IAAI,KAAK,CACP,gFAAgF,UAAU,EAAE,CAC7F,EACD,oBAAoB,CACrB,CAAC;YACJ,CAAC;YAED,GAAG,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;YAC9B,OAAO,qBAAqB,CAAC;gBAC3B,OAAO,EAAE,+EAA+E;aACzF,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,mBAAmB,CAAC,KAAK,EAAE,oBAAoB,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC,CACF,CAAC;IAEF,2BAA2B;IAC3B,MAAM,CAAC,IAAI,CACT,oBAAoB,EACpB,+JAA+J,EAC/J;QACE,QAAQ,EAAE,CAAC,CAAC,KAAK,CACf,CAAC,CAAC,MAAM,CAAC;YACP,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;YACzD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;YACpB,IAAI,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;YACxB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;YACxC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAC5B,CAAC,CACH,CAAC,QAAQ,CAAC,yDAAyD,CAAC;QACrE,WAAW,EAAE,CAAC;aACX,OAAO,EAAE;aACT,QAAQ,EAAE;aACV,QAAQ,CAAC,iEAAiE,CAAC;KAC/E,EACD,KAAK,EAAE,EACL,QAAQ,EACR,WAAW,GAAG,KAAK,GAIpB,EAAE,EAAE;QACH,IAAI,CAAC;YACH,MAAM,OAAO,GAMP,EAAE,CAAC;YAET,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACzC,MAAM,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;gBAExB,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;oBAC9C,OAAO,CAAC,IAAI,CAAC;wBACX,KAAK,EAAE,CAAC;wBACR,QAAQ,EAAE,GAAG,CAAC,QAAQ;wBACtB,OAAO,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO;wBACnC,MAAM;qBACP,CAAC,CAAC;oBAEH,IAAI,WAAW,IAAI,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;wBAC7C,MAAM;oBACR,CAAC;gBACH,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,YAAY,GAChB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;oBACzD,OAAO,CAAC,IAAI,CAAC;wBACX,KAAK,EAAE,CAAC;wBACR,QAAQ,EAAE,GAAG,CAAC,QAAQ;wBACtB,OAAO,EAAE,KAAK;wBACd,KAAK,EAAE,YAAY;qBACpB,CAAC,CAAC;oBAEH,IAAI,WAAW,EAAE,CAAC;wBAChB,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;YAED,OAAO,qBAAqB,CAAC;gBAC3B,aAAa,EAAE,QAAQ,CAAC,MAAM;gBAC9B,gBAAgB,EAAE,OAAO,CAAC,MAAM;gBAChC,kBAAkB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM;gBAC3D,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,mBAAmB,CAAC,KAAK,EAAE,oBAAoB,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC,CACF,CAAC;IAEF,4BAA4B;IAC5B,MAAM,CAAC,IAAI,CACT,qBAAqB,EACrB,sOAAsO,EACtO;QACE,MAAM,EAAE,CAAC;aACN,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,gBAAgB,CAAC,2EAA2E,EAAE,wBAAwB,CAAC,CACxH;KACJ,EACD,KAAK,EAAE,EAAE,MAAM,EAAuB,EAAE,EAAE;QACxC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAC5D,OAAO,qBAAqB,CAAC,MAAM,CAAC,CAAC;QACvC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,mBAAmB,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC,CACF,CAAC;IAEF,wBAAwB;IACxB,MAAM,CAAC,IAAI,CACT,iBAAiB,EACjB,6SAA6S,EAC7S;QACE,MAAM,EAAE,CAAC;aACN,MAAM,EAAE;aACR,QAAQ,CACP,gBAAgB,CAAC,kCAAkC,EAAE,eAAe,CAAC,CACtE;KACJ,EACD,KAAK,EAAE,EAAE,MAAM,EAAsB,EAAE,EAAE;QACvC,IAAI,CAAC;YACH,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC;gBACpC,OAAO,mBAAmB,CACxB,IAAI,KAAK,CACP,4GAA4G,CAC7G,EACD,iBAAiB,CAClB,CAAC;YACJ,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YAExD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,mBAAmB,CACxB,IAAI,KAAK,CACP,WAAW,MAAM,iEAAiE,CACnF,EACD,iBAAiB,CAClB,CAAC;YACJ,CAAC;YAED,OAAO,qBAAqB,CAAC,MAAM,CAAC,CAAC;QACvC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,mBAAmB,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;QACvD,CAAC;IACH,CAAC,CACF,CAAC;IAEF,OAAO,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;AACtD,CAAC"}

package/build/types.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Service context shared between MCP server entry points.
+ * Uses lazy getters to initialize services on-demand.
+ */
+import type { RestApiService } from './services/rest-api-service.js';
+export interface ServiceContext {
+    readonly restApi: RestApiService;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAErE,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;CAClC"}

package/build/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mcp-consultant-tools/rest-api",
-  "version": "27.0.0",
+  "version": "28.0.0-beta.10",
   "description": "MCP server for REST API testing with OAuth2 client credentials support - test HTTP endpoints with automatic JWT token generation",
   "type": "module",
   "main": "./build/index.js",
@@ -45,8 +45,9 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@mcp-consultant-tools/core": "27.0.0-beta.1",
+    "@mcp-consultant-tools/core": "28.0.0-beta.10",
     "@modelcontextprotocol/sdk": "^1.0.4",
+    "commander": "^14.0.3",
     "zod": "^3.24.1"
   },
   "devDependencies": {
@@ -54,6 +55,7 @@
     "typescript": "^5.8.2"
   },
   "bin": {
-    "mcp-rest-api": "build/index.js"
+    "mcp-rest-api": "build/index.js",
+    "mcp-rest-api-cli": "build/cli.js"
   }
 }