@tigerdata/mcp-boilerplate 0.1.6 → 0.1.7

package/dist/StatusError.d.ts

@@ -0,0 +1,4 @@
+export declare class StatusError extends Error {
+    status: number;
+    constructor(message: string, status?: number);
+}

package/dist/cliEntrypoint.d.ts

@@ -0,0 +1 @@
+export declare function cliEntrypoint(stdioEntrypoint: string, httpEntrypoint: string, instrumentation?: string): Promise<void>;

package/dist/http/api.d.ts

@@ -0,0 +1,5 @@
+/**
+ * REST API alternative to MCP for direct use of the same tools.
+ */
+import { ApiFactory, RouterFactoryResult } from '../types.js';
+export declare const apiRouterFactory: <Context extends Record<string, unknown>>(context: Context, apiFactories: readonly ApiFactory<Context, any, any>[]) => RouterFactoryResult;

package/dist/http/mcp.d.ts

@@ -0,0 +1,8 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { RouterFactoryResult } from '../types.js';
+export declare const mcpRouterFactory: <Context extends Record<string, unknown>>(context: Context, createServer: (context: Context) => {
+    server: McpServer;
+}, { name, stateful, }?: {
+    name?: string;
+    stateful?: boolean;
+}) => RouterFactoryResult;

package/dist/httpServer.d.ts

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+import express from 'express';
+import { ApiFactory, PromptFactory } from './types.js';
+import { AdditionalSetupArgs } from './mcpServer.js';
+import { Server } from 'node:http';
+export declare const httpServerFactory: <Context extends Record<string, unknown>>({ name, version, context, apiFactories, promptFactories, additionalSetup, cleanupFn, stateful, }: {
+    name: string;
+    version?: string;
+    context: Context;
+    apiFactories?: readonly ApiFactory<Context, any, any>[];
+    promptFactories?: readonly PromptFactory<Context, any>[];
+    additionalSetup?: (args: AdditionalSetupArgs<Context>) => void;
+    cleanupFn?: () => void | Promise<void>;
+    stateful?: boolean;
+}) => {
+    app: express.Express;
+    server: Server;
+    apiRouter: express.Router;
+    mcpRouter: express.Router;
+    registerCleanupFn: (fn: () => Promise<void>) => void;
+};

package/dist/instrumentation.d.ts

@@ -0,0 +1,3 @@
+import { NodeSDK } from '@opentelemetry/sdk-node';
+export declare const sdk: NodeSDK;
+export declare const cleanup: () => Promise<void>;

package/dist/logger.d.ts

@@ -0,0 +1,9 @@
+import { LogAttributes } from '@opentelemetry/api-logs';
+interface LogInterface {
+    debug: (body: string, attributes?: LogAttributes) => void;
+    info: (body: string, attributes?: LogAttributes) => void;
+    warn: (body: string, attributes?: LogAttributes) => void;
+    error: (body: string, error?: Error | null, attributes?: LogAttributes) => void;
+}
+export declare const log: LogInterface;
+export {};

package/dist/mcpServer.d.ts

@@ -0,0 +1,16 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { ApiFactory, PromptFactory } from './types.js';
+export interface AdditionalSetupArgs<Context extends Record<string, unknown>> {
+    context: Context;
+    server: McpServer;
+}
+export declare const mcpServerFactory: <Context extends Record<string, unknown>>({ name, version, context, apiFactories, promptFactories, additionalSetup, }: {
+    name: string;
+    version?: string;
+    context: Context;
+    apiFactories: readonly ApiFactory<Context, any, any>[];
+    promptFactories?: readonly PromptFactory<Context, any>[];
+    additionalSetup?: (args: AdditionalSetupArgs<Context>) => void;
+}) => {
+    server: McpServer;
+};

package/dist/registerExitHandlers.d.ts

@@ -0,0 +1 @@
+export declare const registerExitHandlers: (cleanupFns: (() => void | Promise<void>)[]) => ((code?: number) => void);

package/dist/stdio.d.ts

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+import { ApiFactory, PromptFactory } from './types.js';
+import { AdditionalSetupArgs } from './mcpServer.js';
+export declare const stdioServerFactory: <Context extends Record<string, unknown>>({ name, version, context, apiFactories, promptFactories, additionalSetup, cleanupFn, }: {
+    name: string;
+    version?: string;
+    context: Context;
+    apiFactories: readonly ApiFactory<Context, any, any>[];
+    promptFactories?: readonly PromptFactory<Context, any>[];
+    additionalSetup?: (args: AdditionalSetupArgs<Context>) => void;
+    cleanupFn?: () => Promise<void>;
+}) => Promise<void>;

package/dist/tracing.d.ts

@@ -0,0 +1,4 @@
+import type { Span, Tracer } from '@opentelemetry/api';
+import type { GenerateTextResult, ModelMessage } from 'ai';
+export declare const withSpan: <T>(tracer: Tracer, name: string, fn: (span: Span) => Promise<T>) => Promise<T>;
+export declare const addAiResultToSpan: (span: Span, aiResult: GenerateTextResult<any, unknown>, inputMessages: ModelMessage[]) => void;

package/dist/types.d.ts

@@ -0,0 +1,33 @@
+import { z } from 'zod';
+import type { ZodRawShape, ZodTypeAny } from 'zod';
+import type { ToolAnnotations, GetPromptResult } from '@modelcontextprotocol/sdk/types.js';
+import { Router } from 'express';
+export type ToolConfig<InputArgs extends ZodRawShape, OutputArgs extends ZodRawShape> = {
+    title?: string;
+    description?: string;
+    inputSchema: InputArgs;
+    outputSchema: OutputArgs;
+    annotations?: ToolAnnotations;
+};
+export interface ApiDefinition<InputArgs extends ZodRawShape, OutputArgs extends ZodRawShape, SimplifiedOutputArgs = OutputArgs> {
+    name: string;
+    method?: 'get' | 'post' | 'put' | 'delete';
+    route?: string | string[];
+    config: ToolConfig<InputArgs, OutputArgs>;
+    disabled?: boolean;
+    fn: (args: z.objectOutputType<InputArgs, ZodTypeAny>) => Promise<z.objectOutputType<OutputArgs, ZodTypeAny>>;
+    pickResult?: (result: z.objectOutputType<OutputArgs, ZodTypeAny>) => SimplifiedOutputArgs;
+}
+export type ApiFactory<Context extends Record<string, unknown>, Input extends ZodRawShape, Output extends ZodRawShape, RestOutput = Output> = (ctx: Context) => ApiDefinition<Input, Output, RestOutput>;
+export type RouterFactoryResult = [Router, () => void | Promise<void>];
+export type PromptConfig<InputArgs extends ZodRawShape> = {
+    title?: string;
+    description?: string;
+    inputSchema: InputArgs;
+};
+export interface PromptDefinition<InputArgs extends ZodRawShape> {
+    name: string;
+    config: PromptConfig<InputArgs>;
+    fn: (args: z.objectOutputType<InputArgs, ZodTypeAny>) => Promise<GetPromptResult>;
+}
+export type PromptFactory<Context extends Record<string, unknown>, Input extends ZodRawShape> = (ctx: Context) => PromptDefinition<Input>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tigerdata/mcp-boilerplate",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "MCP boilerplate code for Node.js",
   "license": "Apache-2.0",
   "author": "TigerData",