@greensecurity/javascript-sdk 0.18.2 → 0.21.1

package/src/mcp-server/prompts.ts

@@ -0,0 +1,110 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import { GetPromptResult } from "@modelcontextprotocol/sdk/types.js";
+import {
+  objectOutputType,
+  ZodOptional,
+  ZodType,
+  ZodTypeAny,
+  ZodTypeDef,
+} from "zod";
+import { GreenSecurityCore } from "../core.js";
+import { ConsoleLogger } from "./console-logger.js";
+import { MCPScope } from "./scopes.js";
+
+// '@modelcontextprotocol/sdk' currently does not export this type
+export type PromptArgsRawShape = {
+  [k: string]:
+    | ZodType<string, ZodTypeDef, string>
+    | ZodOptional<ZodType<string, ZodTypeDef, string>>;
+};
+
+export type PromptDefinition<
+  Args extends undefined | PromptArgsRawShape = undefined,
+> = Args extends PromptArgsRawShape ? {
+    name: string;
+    description?: string;
+    scopes?: MCPScope[];
+    args: Args;
+    prompt: (
+      client: GreenSecurityCore,
+      args: objectOutputType<Args, ZodTypeAny>,
+      extra: RequestHandlerExtra,
+    ) => GetPromptResult | Promise<GetPromptResult>;
+  }
+  : {
+    name: string;
+    description?: string;
+    scopes?: MCPScope[];
+    args?: undefined;
+    prompt: (
+      client: GreenSecurityCore,
+      extra: RequestHandlerExtra,
+    ) => GetPromptResult | Promise<GetPromptResult>;
+  };
+
+// Optional function to assist with formatting prompt results
+export async function formatResult(value: string): Promise<GetPromptResult> {
+  return {
+    messages: [
+      {
+        role: "user",
+        content: {
+          type: "text",
+          text: value,
+        },
+      },
+    ],
+  };
+}
+
+export function createRegisterPrompt(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: GreenSecurityCore,
+  allowedScopes: Set<MCPScope>,
+): <A extends PromptArgsRawShape | undefined>(
+  prompt: PromptDefinition<A>,
+) => void {
+  return <A extends PromptArgsRawShape | undefined>(
+    prompt: PromptDefinition<A>,
+  ): void => {
+    const scopes = prompt.scopes ?? [];
+    if (!scopes.every((s: MCPScope) => allowedScopes.has(s))) {
+      return;
+    }
+
+    if (prompt.args) {
+      if (prompt.description) {
+        server.prompt(
+          prompt.name,
+          prompt.description,
+          prompt.args,
+          async (args, ctx) => prompt.prompt(sdk, args, ctx),
+        );
+      } else {
+        server.prompt(
+          prompt.name,
+          prompt.args,
+          async (args, ctx) => prompt.prompt(sdk, args, ctx),
+        );
+      }
+    } else {
+      if (prompt.description) {
+        server.prompt(
+          prompt.name,
+          prompt.description,
+          async (ctx) => prompt.prompt(sdk, ctx),
+        );
+      } else {
+        server.prompt(prompt.name, async (ctx) => prompt.prompt(sdk, ctx));
+      }
+    }
+
+    logger.debug("Registered prompt", { name: prompt.name });
+  };
+}

package/src/mcp-server/resources.ts

@@ -46,6 +46,7 @@ export type ResourceTemplateDefinition = {
   read: ReadResourceTemplateCallback;
 };
 
+// Optional function to assist with formatting resource results
 export async function formatResult(
   value: unknown,
   uri: URL,

package/src/mcp-server/server.ts

@@ -6,6 +6,7 @@ import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { GreenSecurityCore } from "../core.js";
 import { SDKOptions } from "../lib/config.js";
 import type { ConsoleLogger } from "./console-logger.js";
+import { createRegisterPrompt } from "./prompts.js";
 import {
   createRegisterResource,
   createRegisterResourceTemplate,
@@ -22,12 +23,18 @@ import { tool$usersLogsUserIntoTheSystem } from "./tools/usersLogsUserIntoTheSys
 import { tool$usersMagiclink } from "./tools/usersMagiclink.js";
 import { tool$usersPassword } from "./tools/usersPassword.js";
 import { tool$usersPasswordResetRequest } from "./tools/usersPasswordResetRequest.js";
+import { tool$vendorScansVendorScanOut } from "./tools/vendorScansVendorScanOut.js";
 import { tool$vendorsCreateVendorRegistration } from "./tools/vendorsCreateVendorRegistration.js";
 import { tool$vendorsExpediteTimeRemaining } from "./tools/vendorsExpediteTimeRemaining.js";
 import { tool$vendorsGetVendorInvoiceDetails } from "./tools/vendorsGetVendorInvoiceDetails.js";
+import { tool$vendorsGetVendorsDetails } from "./tools/vendorsGetVendorsDetails.js";
 import { tool$vendorsListVendorCredentials } from "./tools/vendorsListVendorCredentials.js";
+import { tool$vendorsListVendorFacilityStatuses } from "./tools/vendorsListVendorFacilityStatuses.js";
 import { tool$vendorsListVendorInvoices } from "./tools/vendorsListVendorInvoices.js";
-import { tool$vendorsListVendorJobTitles } from "./tools/vendorsListVendorJobTitles.js";
+import { tool$vendorsListVendorScrubDetails } from "./tools/vendorsListVendorScrubDetails.js";
+import { tool$vendorsListVendorScrubPurchases } from "./tools/vendorsListVendorScrubPurchases.js";
+import { tool$webhooksGetWebhookEndpoint } from "./tools/webhooksGetWebhookEndpoint.js";
+import { tool$webhooksListAllWebhookEndpoints } from "./tools/webhooksListAllWebhookEndpoints.js";
 
 export function createMCPServer(deps: {
   logger: ConsoleLogger;
@@ -39,7 +46,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "GreenSecurity",
-    version: "0.18.2",
+    version: "0.21.1",
   });
 
   const client = new GreenSecurityCore({
@@ -65,15 +72,19 @@ export function createMCPServer(deps: {
     client,
     scopes,
   );
-  const register = { tool, resource, resourceTemplate };
+  const prompt = createRegisterPrompt(deps.logger, server, client, scopes);
+  const register = { tool, resource, resourceTemplate, prompt };
   void register; // suppress unused warnings
 
   tool(tool$vendorsCreateVendorRegistration);
-  tool(tool$vendorsListVendorJobTitles);
   tool(tool$vendorsListVendorCredentials);
   tool(tool$vendorsExpediteTimeRemaining);
   tool(tool$vendorsListVendorInvoices);
   tool(tool$vendorsGetVendorInvoiceDetails);
+  tool(tool$vendorsListVendorFacilityStatuses);
+  tool(tool$vendorsListVendorScrubPurchases);
+  tool(tool$vendorsListVendorScrubDetails);
+  tool(tool$vendorsGetVendorsDetails);
   tool(tool$usersGetCurrentUser);
   tool(tool$usersGetUserById);
   tool(tool$usersLogsUserIntoTheSystem);
@@ -84,6 +95,9 @@ export function createMCPServer(deps: {
   tool(tool$organizationsGetFacility);
   tool(tool$supportArticlesListOrSearchSupportArticles);
   tool(tool$supportArticlesGetSupportArticle);
+  tool(tool$webhooksListAllWebhookEndpoints);
+  tool(tool$webhooksGetWebhookEndpoint);
+  tool(tool$vendorScansVendorScanOut);
 
   return server;
 }

package/src/mcp-server/tools/organizationsGetFacility.ts

@@ -11,7 +11,7 @@ const args = {
 };
 
 export const tool$organizationsGetFacility: ToolDefinition<typeof args> = {
-  name: "organizations_get-facility",
+  name: "organizations-get-facility",
   description: `Get facility
 
 Retrieve an individual facility.`,

package/src/mcp-server/tools/organizationsListOrSearchFacilities.ts

@@ -13,7 +13,7 @@ const args = {
 export const tool$organizationsListOrSearchFacilities: ToolDefinition<
   typeof args
 > = {
-  name: "organizations_list-or-search-facilities",
+  name: "organizations-list-or-search-facilities",
   description: `List or search facilities
 
 List or search facilities.

package/src/mcp-server/tools/supportArticlesGetSupportArticle.ts

@@ -13,7 +13,7 @@ const args = {
 export const tool$supportArticlesGetSupportArticle: ToolDefinition<
   typeof args
 > = {
-  name: "support-articles_get-support-article",
+  name: "support-articles-get-support-article",
   description: `Get support article
 
 Retrieve an individual support article.

package/src/mcp-server/tools/supportArticlesListOrSearchSupportArticles.ts

@@ -13,7 +13,7 @@ const args = {
 export const tool$supportArticlesListOrSearchSupportArticles: ToolDefinition<
   typeof args
 > = {
-  name: "support-articles_list-or-search-support-articles",
+  name: "support-articles-list-or-search-support-articles",
   description: `List or search support articles
 
 List or search support articles for FAQ.`,

package/src/mcp-server/tools/usersGetCurrentUser.ts

@@ -6,7 +6,7 @@ import { usersGetCurrentUser } from "../../funcs/usersGetCurrentUser.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
 export const tool$usersGetCurrentUser: ToolDefinition = {
-  name: "users_get-current-user",
+  name: "users-get-current-user",
   description: `Get current user
 
 Returns a user object for the user represented by the authorization token`,

package/src/mcp-server/tools/usersGetUserById.ts

@@ -11,7 +11,7 @@ const args = {
 };
 
 export const tool$usersGetUserById: ToolDefinition<typeof args> = {
-  name: "users_get-user-by-id",
+  name: "users-get-user-by-id",
   description: `Get user by id
 
 Returns a user object for the user represented by the identifier in the path.`,

package/src/mcp-server/tools/usersLogsUserIntoTheSystem.ts

@@ -11,7 +11,7 @@ const args = {
 };
 
 export const tool$usersLogsUserIntoTheSystem: ToolDefinition<typeof args> = {
-  name: "users_logs-user-into-the-system",
+  name: "users-logs-user-into-the-system",
   description: `Logs user into the system
 
 This endpoint allows a user to authenticate themselves and retrieve a permanent token for access.

package/src/mcp-server/tools/usersMagiclink.ts

@@ -11,7 +11,7 @@ const args = {
 };
 
 export const tool$usersMagiclink: ToolDefinition<typeof args> = {
-  name: "users_magiclink",
+  name: "users-magiclink",
   description: `Magic link
 
 It sends an email with a magic link to allow the user to log in.`,

package/src/mcp-server/tools/usersPassword.ts

@@ -11,7 +11,7 @@ const args = {
 };
 
 export const tool$usersPassword: ToolDefinition<typeof args> = {
-  name: "users_password",
+  name: "users-password",
   description: `Password reset
 
 Resets the a user's password using a password_reset_id that was sent to them via email.

package/src/mcp-server/tools/usersPasswordResetRequest.ts

@@ -11,7 +11,7 @@ const args = {
 };
 
 export const tool$usersPasswordResetRequest: ToolDefinition<typeof args> = {
-  name: "users_password-reset-request",
+  name: "users-password-reset-request",
   description: `Password reset request
 
 It sends an email with a link for resetting a user's password.`,

package/src/mcp-server/tools/vendorScansVendorScanOut.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { vendorScansVendorScanOut } from "../../funcs/vendorScansVendorScanOut.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.VendorScanOutRequest$inboundSchema,
+};
+
+export const tool$vendorScansVendorScanOut: ToolDefinition<typeof args> = {
+  name: "vendor-scans-vendor-scan-out",
+  description: `Vendor scan out
+
+It scans out vendor from facility`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await vendorScansVendorScanOut(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/vendorsCreateVendorRegistration.ts

@@ -12,7 +12,7 @@ const args = {
 
 export const tool$vendorsCreateVendorRegistration: ToolDefinition<typeof args> =
   {
-    name: "vendors_create-vendor-registration",
+    name: "vendors-create-vendor-registration",
     description: `Create vendor registration
 
 Create an initial vendor registration. Once successful, the vendor will be able to continue to filling out the rest of their onboarding profile.`,

package/src/mcp-server/tools/vendorsExpediteTimeRemaining.ts

@@ -11,7 +11,7 @@ const args = {
 };
 
 export const tool$vendorsExpediteTimeRemaining: ToolDefinition<typeof args> = {
-  name: "vendors_expedite-time-remaining",
+  name: "vendors-expedite-time-remaining",
   description: `Expedite time remaining
 
 For vendors who have a paid 24-hour expedite credentials invoice, get the remaining time (in seconds) for which submitted credentials will be expedited.`,

package/src/mcp-server/tools/vendorsGetVendorInvoiceDetails.ts

@@ -12,7 +12,7 @@ const args = {
 
 export const tool$vendorsGetVendorInvoiceDetails: ToolDefinition<typeof args> =
   {
-    name: "vendors_get-vendor-invoice-details",
+    name: "vendors-get-vendor-invoice-details",
     description: `Get vendor invoice details
 
 Retrieve an individual vendor invoice detais. 

package/src/mcp-server/tools/vendorsGetVendorsDetails.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { vendorsGetVendorsDetails } from "../../funcs/vendorsGetVendorsDetails.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetVendorsDetailsRequest$inboundSchema,
+};
+
+export const tool$vendorsGetVendorsDetails: ToolDefinition<typeof args> = {
+  name: "vendors-get-vendors-details",
+  description: `Get vendors details
+
+Retrieve an individual vendor detais.
+
+Available \`expand\` scopes are:
+
+vendor.user
+vendor.vendor_type
+vendor.image_urls
+vendor.payment_profile
+vendor.primary_facility
+vendor.primary_department
+vendor.company
+vendor.credentialing_subscription
+vendor.scrubs_subscription
+vendor.payment_responsibility
+vendor.background_check_date_expires`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await vendorsGetVendorsDetails(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/vendorsListVendorCredentials.ts

@@ -11,7 +11,7 @@ const args = {
 };
 
 export const tool$vendorsListVendorCredentials: ToolDefinition<typeof args> = {
-  name: "vendors_list-vendor-credentials",
+  name: "vendors-list-vendor-credentials",
   description: `List Vendor Credentials
 
 Lists vendor credentials, required credentials, and company credentials. Utilized in Vendor Dashboard.`,
@@ -30,7 +30,7 @@ Lists vendor credentials, required credentials, and company credentials. Utilize
       };
     }
 
-    const value = result.value;
+    const value = result.value.result;
 
     return formatResult(value, apiCall);
   },

package/src/mcp-server/tools/{vendorsListVendorJobTitles.ts → vendorsListVendorFacilityStatuses.ts}

@@ -2,22 +2,24 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { vendorsListVendorJobTitles } from "../../funcs/vendorsListVendorJobTitles.js";
+import { vendorsListVendorFacilityStatuses } from "../../funcs/vendorsListVendorFacilityStatuses.js";
 import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
 const args = {
-  request: operations.ListVendorJobTitlesRequest$inboundSchema,
+  request: operations.ListVendorFacilityStatusesRequest$inboundSchema,
 };
 
-export const tool$vendorsListVendorJobTitles: ToolDefinition<typeof args> = {
-  name: "vendors_list-vendor-job-titles",
-  description: `List vendor job titles
+export const tool$vendorsListVendorFacilityStatuses: ToolDefinition<
+  typeof args
+> = {
+  name: "vendors-list-vendor-facility-statuses",
+  description: `List vendor facility statuses
 
-List valid job titles for Vendors. This can be used during sign up or in a filter.`,
+List the facilities for the vendor`,
   args,
   tool: async (client, args, ctx) => {
-    const [result, apiCall] = await vendorsListVendorJobTitles(
+    const [result, apiCall] = await vendorsListVendorFacilityStatuses(
       client,
       args.request,
       { fetchOptions: { signal: ctx.signal } },

package/src/mcp-server/tools/vendorsListVendorInvoices.ts

@@ -11,7 +11,7 @@ const args = {
 };
 
 export const tool$vendorsListVendorInvoices: ToolDefinition<typeof args> = {
-  name: "vendors_list-vendor-invoices",
+  name: "vendors-list-vendor-invoices",
   description: `List vendor invoices
 
 List invoices for Vendors

package/src/mcp-server/tools/vendorsListVendorScrubDetails.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { vendorsListVendorScrubDetails } from "../../funcs/vendorsListVendorScrubDetails.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListVendorScrubDetailsRequest$inboundSchema,
+};
+
+export const tool$vendorsListVendorScrubDetails: ToolDefinition<typeof args> = {
+  name: "vendors-list-vendor-scrub-details",
+  description: `List vendor scrub details
+
+List vendor scrub details`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await vendorsListVendorScrubDetails(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/vendorsListVendorScrubPurchases.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { vendorsListVendorScrubPurchases } from "../../funcs/vendorsListVendorScrubPurchases.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListVendorScrubPurchasesRequest$inboundSchema,
+};
+
+export const tool$vendorsListVendorScrubPurchases: ToolDefinition<typeof args> =
+  {
+    name: "vendors-list-vendor-scrub-purchases",
+    description: `List vendor scrub purchases
+
+List vendor scrub purchases`,
+    args,
+    tool: async (client, args, ctx) => {
+      const [result, apiCall] = await vendorsListVendorScrubPurchases(
+        client,
+        args.request,
+        { fetchOptions: { signal: ctx.signal } },
+      ).$inspect();
+
+      if (!result.ok) {
+        return {
+          content: [{ type: "text", text: result.error.message }],
+          isError: true,
+        };
+      }
+
+      const value = result.value.result;
+
+      return formatResult(value, apiCall);
+    },
+  };

package/src/mcp-server/tools/webhooksGetWebhookEndpoint.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { webhooksGetWebhookEndpoint } from "../../funcs/webhooksGetWebhookEndpoint.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetWebhookEndpointRequest$inboundSchema,
+};
+
+export const tool$webhooksGetWebhookEndpoint: ToolDefinition<typeof args> = {
+  name: "webhooks-get-webhook-endpoint",
+  description: `Retrieves the webhook endpoint with the given ID.
+
+Returns the definition of a webhook endpoint by ID.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await webhooksGetWebhookEndpoint(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/webhooksListAllWebhookEndpoints.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { webhooksListAllWebhookEndpoints } from "../../funcs/webhooksListAllWebhookEndpoints.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListAllWebhookEndpointsRequest$inboundSchema,
+};
+
+export const tool$webhooksListAllWebhookEndpoints: ToolDefinition<typeof args> =
+  {
+    name: "webhooks-list-all-webhook-endpoints",
+    description: `List all webhook endpoints 
+
+Returns a list of your webhook endpoints.`,
+    args,
+    tool: async (client, args, ctx) => {
+      const [result, apiCall] = await webhooksListAllWebhookEndpoints(
+        client,
+        args.request,
+        { fetchOptions: { signal: ctx.signal } },
+      ).$inspect();
+
+      if (!result.ok) {
+        return {
+          content: [{ type: "text", text: result.error.message }],
+          isError: true,
+        };
+      }
+
+      const value = result.value;
+
+      return formatResult(value, apiCall);
+    },
+  };

package/src/mcp-server/tools.ts

@@ -34,6 +34,7 @@ export type ToolDefinition<Args extends undefined | ZodRawShape = undefined> =
       ) => CallToolResult | Promise<CallToolResult>;
     };
 
+// Optional function to assist with formatting tool results
 export async function formatResult(
   value: unknown,
   init: { response?: Response | undefined },
@@ -102,6 +103,10 @@ export function createRegisterTool(
     }
 
     const toolScopes = tool.scopes ?? [];
+    if (allowedScopes.size > 0 && toolScopes.length === 0) {
+      return;
+    }
+
     if (!toolScopes.every((s) => allowedScopes.has(s))) {
       return;
     }