tmcp 1.10.3 → 1.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tmcp",
-  "version": "1.10.3",
+  "version": "1.12.0",
   "description": "The main tmcp library",
   "main": "src/index.js",
   "type": "module",

package/src/index.js

@@ -1,3 +1,4 @@
+/* eslint-disable jsdoc/no-undefined-types */
 /**
  * @import { StandardSchemaV1 } from "@standard-schema/spec";
  * @import SqidsType from "sqids";
@@ -43,9 +44,11 @@ import { should_version_negotiation_fail } from './validation/version.js';
  */
 
 /**
+ * @template {Record<string, unknown> | undefined} [TCustom=undefined]
  * @typedef {Object} Context
  * @property {string} [sessionId]
  * @property {AuthInfo} [auth]
+ * @property {TCustom} [custom]
  */
 
 /**
@@ -93,7 +96,8 @@ async function safe_enabled(enabled) {
  */
 
 /**
- * @template {StandardSchemaV1} StandardSchema
+ * @template {StandardSchemaV1 | undefined} [StandardSchema=undefined]
+ * @template {Record<string, unknown> | undefined} [CustomContext=undefined]
  */
 export class McpServer {
 	#server = new JSONRPCServer();
@@ -140,7 +144,7 @@ export class McpServer {
 	};
 
 	/**
-	 * @type {AsyncLocalStorage<Context & { progress_token?: string }>}
+	 * @type {AsyncLocalStorage<Context<CustomContext> & { progress_token?: string }>}
 	 */
 	#ctx_storage = new AsyncLocalStorage();
 
@@ -276,6 +280,19 @@ export class McpServer {
 		this.#init_logging();
 	}
 
+	/**
+	 * Utility method to specify the type of the custom context for this server instance without the need to specify the standard schema type.
+	 * @example
+	 * const server = new McpServer({ ... }, { ... }).withContext<{ name: string }>();
+	 * @template {Record<string, unknown>} TCustom
+	 * @returns {McpServer<StandardSchema, TCustom>}
+	 */
+	withContext() {
+		return /** @type {McpServer<StandardSchema, TCustom>} */ (
+			/** @type {unknown} */ (this)
+		);
+	}
+
 	get #session_id() {
 		return this.#ctx_storage.getStore()?.sessionId;
 	}
@@ -285,8 +302,8 @@ export class McpServer {
 	}
 
 	/**
-	 * The context of the current request, include the session ID and any auth information.
-	 * @type {Context}
+	 * The context of the current request, include the session ID, any auth information, and custom data.
+	 * @type {Context<CustomContext>}
 	 */
 	get ctx() {
 		// eslint-disable-next-line no-unused-vars
@@ -877,7 +894,7 @@ export class McpServer {
 	 * The main function that receive a JSONRpc message and either dispatch a `send` event or process the request.
 	 *
 	 * @param {JSONRPCResponse | JSONRPCRequest} message
-	 * @param {Context} [ctx]
+	 * @param {Context<CustomContext>} [ctx]
 	 * @returns {ReturnType<JSONRPCServer['receive']> | ReturnType<JSONRPCClient['receive'] | undefined>}
 	 */
 	receive(message, ctx) {
@@ -955,11 +972,12 @@ export class McpServer {
 	 *
 	 * If the client doesn't support elicitation, it will throw an error.
 	 *
-	 * @template {StandardSchema} TSchema
+	 * @template {StandardSchema extends undefined ? never : StandardSchema} TSchema
+	 * @param {string} message
 	 * @param {TSchema} schema
 	 * @returns {Promise<StandardSchemaV1.InferOutput<TSchema>>}
 	 */
-	async elicitation(schema) {
+	async elicitation(message, schema) {
 		if (!this.#client_capabilities?.elicitation)
 			throw new McpError(-32601, "Client doesn't support elicitation");
 
@@ -968,7 +986,9 @@ export class McpServer {
 			await this.#client?.request(
 				'elicitation/create',
 				{
-					params: await this.#options.adapter.toJsonSchema(schema),
+					message,
+					requestedSchema:
+						await this.#options.adapter.toJsonSchema(schema),
 				},
 				{
 					sessions: [this.#session_id],

package/src/internal/internal.d.ts

@@ -66,7 +66,7 @@ export type StoredResource =
 			) => Promise<ReadResourceResult> | ReadResourceResult;
 	  };
 
-export type ServerOptions<TSchema extends StandardSchemaV1> = {
+export type ServerOptions<TSchema extends StandardSchemaV1 | undefined> = {
 	capabilities?: ServerCapabilities;
 	instructions?: string;
 	adapter: JsonSchemaAdapter<TSchema>;

package/src/types/index.d.ts

@@ -3,7 +3,7 @@ declare module 'tmcp' {
 	import type { JSONRPCRequest, JSONRPCServer, JSONRPCClient } from 'json-rpc-2.0';
 	import type { JSONSchema7 } from 'json-schema';
 	import * as v from 'valibot';
-	export class McpServer<StandardSchema extends StandardSchemaV1> {
+	export class McpServer<StandardSchema extends StandardSchemaV1 | undefined = undefined, CustomContext extends Record<string, unknown> | undefined = undefined> {
 		
 		constructor(server_info: ServerInfo, options: ServerOptions<StandardSchema>);
 		
@@ -12,9 +12,15 @@ declare module 'tmcp' {
 			name?: string;
 		}>;
 		/**
-		 * The context of the current request, include the session ID and any auth information.
+		 * Utility method to specify the type of the custom context for this server instance without the need to specify the standard schema type.
+		 * @example
+		 * const server = new McpServer({ ... }, { ... }).withContext<{ name: string }>();
 		 * */
-		get ctx(): Context;
+		withContext<TCustom extends Record<string, unknown>>(): McpServer<StandardSchema, TCustom>;
+		/**
+		 * The context of the current request, include the session ID, any auth information, and custom data.
+		 * */
+		get ctx(): Context<CustomContext>;
 		/**
 		 * Get the client information (name, version, etc.) of the client that initiated the current request...useful if you want to do something different based on the client.
 		 */
@@ -97,7 +103,7 @@ declare module 'tmcp' {
 		 * The main function that receive a JSONRpc message and either dispatch a `send` event or process the request.
 		 *
 		 * */
-		receive(message: JSONRPCResponse | JSONRPCRequest, ctx?: Context): ReturnType<JSONRPCServer["receive"]> | ReturnType<JSONRPCClient["receive"] | undefined>;
+		receive(message: JSONRPCResponse | JSONRPCRequest, ctx?: Context<CustomContext>): ReturnType<JSONRPCServer["receive"]> | ReturnType<JSONRPCClient["receive"] | undefined>;
 		/**
 		 * Send a notification for subscriptions
 		 * */
@@ -114,7 +120,7 @@ declare module 'tmcp' {
 		 * If the client doesn't support elicitation, it will throw an error.
 		 *
 		 * */
-		elicitation<TSchema extends StandardSchema>(schema: TSchema): Promise<StandardSchemaV1.InferOutput<TSchema>>;
+		elicitation<TSchema extends StandardSchema extends undefined ? never : StandardSchema>(message: string, schema: TSchema): Promise<StandardSchemaV1.InferOutput<TSchema>>;
 		/**
 		 * Request language model sampling from the client
 		 * */
@@ -166,9 +172,10 @@ declare module 'tmcp' {
 		 */
 		extra?: Record<string, unknown> | undefined;
 	};
-	export type Context = {
+	export type Context<TCustom extends Record<string, unknown> | undefined = undefined> = {
 		sessionId?: string | undefined;
 		auth?: AuthInfo | undefined;
+		custom?: TCustom | undefined;
 	};
 	export type ClientCapabilities = ClientCapabilities_1;
 	type Completion = (
@@ -176,7 +183,7 @@ declare module 'tmcp' {
 		context: { arguments: Record<string, string> },
 	) => CompleteResult | Promise<CompleteResult>;
 
-	type ServerOptions<TSchema extends StandardSchemaV1> = {
+	type ServerOptions<TSchema extends StandardSchemaV1 | undefined> = {
 		capabilities?: ServerCapabilities;
 		instructions?: string;
 		adapter: JsonSchemaAdapter<TSchema>;

package/src/types/index.d.ts.map

@@ -55,6 +55,6 @@
 		null,
 		null
 	],
-	"mappings": ";;;;;cAiGaA,SAASA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aCs2CsCC,kBAAkBA;MC56ClEC,UAAUA;;;;;MAyCVC,aAAaA;;;;;;;;;;;;;MAabC,UAAUA;;;;;;MAMVC,iBAAiBA;;MAEjBC,SAASA;;;;;;;;;;;;ODWRC,qBAAqBA;;;;;;;;;;;;;;OAuGrBC,wBAAwBA;;;;;;;;;;;;;;;;;;;;;;;OA6BxBC,6BAA6BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuB7BC,wBAAwBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmMxBC,cAAcA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4GdC,wBAAwBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8PxBC,qBAAqBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BrBC,qBAAqBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2GrBC,oBAAoBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoEpBC,kBAAkBA;OAuGlBC,gCAAgCA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8ChCC,yBAAyBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+LzBC,oBAAoBA;;;;;;;;;;;;;;;;;;;;;;MA8H2BC,kBAAkBA;MASbC,uBAAuBA;;;;;;MAO5BC,kBAAkBA;MAGrBC,eAAeA;MAGhBC,cAAcA;MAGFC,0BAA0BA;MAGjCC,mBAAmBA;MAY9BC,QAAQA;MAMDC,eAAeA;MAGlBC,YAAYA;MAGTC,eAAeA;;ME7/CnEC,IAAIA;;;;;;;MAOJC,cAAcA;;;;;;;MAOdC,cAAcA;;;;;MAKdC,qBAAqBA;;;;;;;;;;;;;;;;;MAiBrBC,4BAA4BA;;;;;;MAMrBC,2BAA2BA;;;;;;;OCjC1BC,iBAAiBA;;;;;;;;;;;;;;;;cAAjBA,iBAAiBA",
+	"mappings": ";;;;;cAqGaA,SAASA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aCk2CsCC,kBAAkBA;MC56ClEC,UAAUA;;;;;MAyCVC,aAAaA;;;;;;;;;;;;;MAabC,UAAUA;;;;;;MAMVC,iBAAiBA;;MAEjBC,SAASA;;;;;;;;;;;;ODWRC,qBAAqBA;;;;;;;;;;;;;;OAuGrBC,wBAAwBA;;;;;;;;;;;;;;;;;;;;;;;OA6BxBC,6BAA6BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuB7BC,wBAAwBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmMxBC,cAAcA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4GdC,wBAAwBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8PxBC,qBAAqBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BrBC,qBAAqBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2GrBC,oBAAoBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoEpBC,kBAAkBA;OAuGlBC,gCAAgCA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8ChCC,yBAAyBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+LzBC,oBAAoBA;;;;;;;;;;;;;;;;;;;;;;MA8H2BC,kBAAkBA;MASbC,uBAAuBA;;;;;;MAO5BC,kBAAkBA;MAGrBC,eAAeA;MAGhBC,cAAcA;MAGFC,0BAA0BA;MAGjCC,mBAAmBA;MAY9BC,QAAQA;MAMDC,eAAeA;MAGlBC,YAAYA;MAGTC,eAAeA;;ME7/CnEC,IAAIA;;;;;;;MAOJC,cAAcA;;;;;;;MAOdC,cAAcA;;;;;MAKdC,qBAAqBA;;;;;;;;;;;;;;;;;MAiBrBC,4BAA4BA;;;;;;MAMrBC,2BAA2BA;;;;;;;OCjC1BC,iBAAiBA;;;;;;;;;;;;;;;;cAAjBA,iBAAiBA",
 	"ignoreList": []
 }