@webhooks-cc/mcp 1.14.0 → 1.15.0

package/dist/tools.d.mts

@@ -0,0 +1,171 @@
+import { z } from 'zod';
+import { WebhooksCC, Request, PayloadSchemaFormat } from '@webhooks-cc/sdk';
+
+declare const createEndpointShape: {
+    name: z.ZodOptional<z.ZodString>;
+    ephemeral: z.ZodOptional<z.ZodBoolean>;
+    expiresIn: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    mockResponse: z.ZodOptional<z.ZodObject<{
+        status: z.ZodNumber;
+        body: z.ZodDefault<z.ZodString>;
+        headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+        delay: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    responseRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        enabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        logic: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+            and: "and";
+            or: "or";
+        }>>>;
+        conditions: z.ZodArray<z.ZodObject<{
+            field: z.ZodEnum<{
+                body: "body";
+                method: "method";
+                path: "path";
+                header: "header";
+                query: "query";
+                body_contains: "body_contains";
+                body_path: "body_path";
+                content_type: "content_type";
+                size: "size";
+                kind: "kind";
+                email: "email";
+                email_field: "email_field";
+                spam_score: "spam_score";
+                email_auth: "email_auth";
+                signature: "signature";
+            }>;
+            op: z.ZodEnum<{
+                eq: "eq";
+                neq: "neq";
+                contains: "contains";
+                not_contains: "not_contains";
+                starts_with: "starts_with";
+                ends_with: "ends_with";
+                matches: "matches";
+                regex: "regex";
+                exists: "exists";
+                not_exists: "not_exists";
+                gt: "gt";
+                gte: "gte";
+                lt: "lt";
+                lte: "lte";
+            }>;
+            value: z.ZodOptional<z.ZodString>;
+            name: z.ZodOptional<z.ZodString>;
+            path: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        response: z.ZodLazy<z.ZodObject<{
+            status: z.ZodNumber;
+            body: z.ZodDefault<z.ZodString>;
+            headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+            delay: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    notificationUrl: z.ZodOptional<z.ZodString>;
+    signingProvider: z.ZodOptional<z.ZodString>;
+    signingSecret: z.ZodOptional<z.ZodString>;
+    signingHeader: z.ZodOptional<z.ZodString>;
+};
+declare const listEndpointsShape: {
+    team: z.ZodOptional<z.ZodString>;
+};
+declare const getEndpointShape: {
+    slug: z.ZodString;
+};
+declare const deleteEndpointShape: {
+    slug: z.ZodString;
+};
+declare const listRequestsShape: {
+    endpointSlug: z.ZodString;
+    limit: z.ZodDefault<z.ZodNumber>;
+    since: z.ZodOptional<z.ZodNumber>;
+    kind: z.ZodOptional<z.ZodEnum<{
+        email: "email";
+        http: "http";
+    }>>;
+};
+declare const getRequestShape: {
+    requestId: z.ZodString;
+};
+declare const waitForRequestShape: {
+    endpointSlug: z.ZodString;
+    timeout: z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    pollInterval: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+};
+declare const payloadSchemaShape: {
+    endpointSlug: z.ZodString;
+    format: z.ZodDefault<z.ZodEnum<{
+        typescript: "typescript";
+        zod: "zod";
+        pydantic: "pydantic";
+        "json-schema": "json-schema";
+    }>>;
+    name: z.ZodOptional<z.ZodString>;
+    event: z.ZodOptional<z.ZodString>;
+    method: z.ZodOptional<z.ZodString>;
+    path: z.ZodOptional<z.ZodString>;
+    requestIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    limit: z.ZodDefault<z.ZodNumber>;
+};
+type PayloadSchemaArgs = {
+    format: PayloadSchemaFormat;
+    name?: string;
+    event?: string;
+    method?: string;
+    path?: string;
+};
+/**
+ * generate_payload_schema for the full and the sandbox tools: filter the
+ * requests, learn one schema from their bodies, and say what it was built
+ * from, warning when several events were mixed.
+ */
+declare function payloadSchemaResult(requests: Request[], args: PayloadSchemaArgs): ToolResult;
+type TextContent = {
+    type: "text";
+    text: string;
+};
+type ToolResult = {
+    content: TextContent[];
+    isError?: boolean;
+};
+/** Create a text content response for MCP tools. */
+declare function textContent(text: string): ToolResult;
+declare function jsonContent(value: unknown): ToolResult;
+/** Wrap a tool handler with error handling that returns structured MCP errors. */
+declare function withErrorHandling<T>(handler: (args: T) => Promise<ToolResult>): (args: T) => Promise<ToolResult>;
+/** Register all webhook tools on an MCP server instance. */
+/**
+ * What registerTools needs from a server: the stdio server's McpServer has
+ * it, and the hosted server at webhooks.cc/mcp adapts its own to it, so both
+ * serve the same tools.
+ */
+interface ToolServer {
+    tool<Shape extends z.ZodRawShape>(name: string, description: string, shape: Shape, handler: (args: z.infer<z.ZodObject<Shape>>) => Promise<ToolResult>): RegisteredToolHandle;
+}
+/** A registered tool, removable when the tool set is swapped. */
+interface RegisteredToolHandle {
+    remove(): void;
+}
+interface RegisterToolsOptions {
+    /**
+     * The hosted server (webhooks.cc/mcp): leave out the tools that send to a
+     * URL the caller names, which would run from webhooks.cc's network and
+     * could never reach the caller's machine anyway, refuse targetUrl on the
+     * others, and cap waits below the proxy's timeout.
+     */
+    remote?: boolean;
+}
+/** Longest wait on the hosted server; Cloudflare ends a request after 100 seconds. */
+declare const REMOTE_MAX_WAIT_MS = 50000;
+/** Shortest poll interval on the hosted server: each poll is an API request. */
+declare const REMOTE_MIN_POLL_MS = 1000;
+/**
+ * Registers the webhooks.cc tools for an account client. Returns their
+ * handles, so a caller can swap the tool set later.
+ */
+declare function registerTools(target: ToolServer, client: WebhooksCC, options?: RegisterToolsOptions): RegisteredToolHandle[];
+
+export { REMOTE_MAX_WAIT_MS, REMOTE_MIN_POLL_MS, createEndpointShape, deleteEndpointShape, getEndpointShape, getRequestShape, jsonContent, listEndpointsShape, listRequestsShape, payloadSchemaResult, payloadSchemaShape, registerTools, textContent, waitForRequestShape, withErrorHandling };
+export type { RegisterToolsOptions, RegisteredToolHandle, ToolResult, ToolServer };

package/dist/tools.d.ts

@@ -0,0 +1,171 @@
+import { z } from 'zod';
+import { WebhooksCC, Request, PayloadSchemaFormat } from '@webhooks-cc/sdk';
+
+declare const createEndpointShape: {
+    name: z.ZodOptional<z.ZodString>;
+    ephemeral: z.ZodOptional<z.ZodBoolean>;
+    expiresIn: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    mockResponse: z.ZodOptional<z.ZodObject<{
+        status: z.ZodNumber;
+        body: z.ZodDefault<z.ZodString>;
+        headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+        delay: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    responseRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        enabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        logic: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+            and: "and";
+            or: "or";
+        }>>>;
+        conditions: z.ZodArray<z.ZodObject<{
+            field: z.ZodEnum<{
+                body: "body";
+                method: "method";
+                path: "path";
+                header: "header";
+                query: "query";
+                body_contains: "body_contains";
+                body_path: "body_path";
+                content_type: "content_type";
+                size: "size";
+                kind: "kind";
+                email: "email";
+                email_field: "email_field";
+                spam_score: "spam_score";
+                email_auth: "email_auth";
+                signature: "signature";
+            }>;
+            op: z.ZodEnum<{
+                eq: "eq";
+                neq: "neq";
+                contains: "contains";
+                not_contains: "not_contains";
+                starts_with: "starts_with";
+                ends_with: "ends_with";
+                matches: "matches";
+                regex: "regex";
+                exists: "exists";
+                not_exists: "not_exists";
+                gt: "gt";
+                gte: "gte";
+                lt: "lt";
+                lte: "lte";
+            }>;
+            value: z.ZodOptional<z.ZodString>;
+            name: z.ZodOptional<z.ZodString>;
+            path: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        response: z.ZodLazy<z.ZodObject<{
+            status: z.ZodNumber;
+            body: z.ZodDefault<z.ZodString>;
+            headers: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+            delay: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    notificationUrl: z.ZodOptional<z.ZodString>;
+    signingProvider: z.ZodOptional<z.ZodString>;
+    signingSecret: z.ZodOptional<z.ZodString>;
+    signingHeader: z.ZodOptional<z.ZodString>;
+};
+declare const listEndpointsShape: {
+    team: z.ZodOptional<z.ZodString>;
+};
+declare const getEndpointShape: {
+    slug: z.ZodString;
+};
+declare const deleteEndpointShape: {
+    slug: z.ZodString;
+};
+declare const listRequestsShape: {
+    endpointSlug: z.ZodString;
+    limit: z.ZodDefault<z.ZodNumber>;
+    since: z.ZodOptional<z.ZodNumber>;
+    kind: z.ZodOptional<z.ZodEnum<{
+        email: "email";
+        http: "http";
+    }>>;
+};
+declare const getRequestShape: {
+    requestId: z.ZodString;
+};
+declare const waitForRequestShape: {
+    endpointSlug: z.ZodString;
+    timeout: z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    pollInterval: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+};
+declare const payloadSchemaShape: {
+    endpointSlug: z.ZodString;
+    format: z.ZodDefault<z.ZodEnum<{
+        typescript: "typescript";
+        zod: "zod";
+        pydantic: "pydantic";
+        "json-schema": "json-schema";
+    }>>;
+    name: z.ZodOptional<z.ZodString>;
+    event: z.ZodOptional<z.ZodString>;
+    method: z.ZodOptional<z.ZodString>;
+    path: z.ZodOptional<z.ZodString>;
+    requestIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    limit: z.ZodDefault<z.ZodNumber>;
+};
+type PayloadSchemaArgs = {
+    format: PayloadSchemaFormat;
+    name?: string;
+    event?: string;
+    method?: string;
+    path?: string;
+};
+/**
+ * generate_payload_schema for the full and the sandbox tools: filter the
+ * requests, learn one schema from their bodies, and say what it was built
+ * from, warning when several events were mixed.
+ */
+declare function payloadSchemaResult(requests: Request[], args: PayloadSchemaArgs): ToolResult;
+type TextContent = {
+    type: "text";
+    text: string;
+};
+type ToolResult = {
+    content: TextContent[];
+    isError?: boolean;
+};
+/** Create a text content response for MCP tools. */
+declare function textContent(text: string): ToolResult;
+declare function jsonContent(value: unknown): ToolResult;
+/** Wrap a tool handler with error handling that returns structured MCP errors. */
+declare function withErrorHandling<T>(handler: (args: T) => Promise<ToolResult>): (args: T) => Promise<ToolResult>;
+/** Register all webhook tools on an MCP server instance. */
+/**
+ * What registerTools needs from a server: the stdio server's McpServer has
+ * it, and the hosted server at webhooks.cc/mcp adapts its own to it, so both
+ * serve the same tools.
+ */
+interface ToolServer {
+    tool<Shape extends z.ZodRawShape>(name: string, description: string, shape: Shape, handler: (args: z.infer<z.ZodObject<Shape>>) => Promise<ToolResult>): RegisteredToolHandle;
+}
+/** A registered tool, removable when the tool set is swapped. */
+interface RegisteredToolHandle {
+    remove(): void;
+}
+interface RegisterToolsOptions {
+    /**
+     * The hosted server (webhooks.cc/mcp): leave out the tools that send to a
+     * URL the caller names, which would run from webhooks.cc's network and
+     * could never reach the caller's machine anyway, refuse targetUrl on the
+     * others, and cap waits below the proxy's timeout.
+     */
+    remote?: boolean;
+}
+/** Longest wait on the hosted server; Cloudflare ends a request after 100 seconds. */
+declare const REMOTE_MAX_WAIT_MS = 50000;
+/** Shortest poll interval on the hosted server: each poll is an API request. */
+declare const REMOTE_MIN_POLL_MS = 1000;
+/**
+ * Registers the webhooks.cc tools for an account client. Returns their
+ * handles, so a caller can swap the tool set later.
+ */
+declare function registerTools(target: ToolServer, client: WebhooksCC, options?: RegisterToolsOptions): RegisteredToolHandle[];
+
+export { REMOTE_MAX_WAIT_MS, REMOTE_MIN_POLL_MS, createEndpointShape, deleteEndpointShape, getEndpointShape, getRequestShape, jsonContent, listEndpointsShape, listRequestsShape, payloadSchemaResult, payloadSchemaShape, registerTools, textContent, waitForRequestShape, withErrorHandling };
+export type { RegisterToolsOptions, RegisteredToolHandle, ToolResult, ToolServer };