fastmcp 1.0.2 → 1.2.0

package/README.md

@@ -10,8 +10,9 @@ A TypeScript framework for building [MCP](https://modelcontextprotocol.io/) serv
 - Simple Tool, Resource, Prompt definition
 - Full TypeScript support
 - Built-in error handling
-- Built-in CLI for testing and debugging
-- Built-in support for SSE
+- Built-in CLI for [testing](#test-with-mcp-cli) and [debugging](#inspect-with-mcp-inspector)
+- Built-in support for [SSE](#sse)
+- Built-in [progress notifications](#progress)
 
 ## Installation
 
@@ -109,6 +110,58 @@ server.addTool({
 });
 ```
 
+#### Errors
+
+The errors that are meant to be shown to the user should be thrown as `UserError` instances:
+
+```js
+import { UserError } from "fastmcp";
+
+server.addTool({
+  name: "download",
+  description: "Download a file",
+  parameters: z.object({
+    url: z.string(),
+  }),
+  execute: async (args) => {
+    if (args.url.startsWith("https://example.com")) {
+      throw new UserError("This URL is not allowed");
+    }
+
+    return "done";
+  },
+});
+```
+
+#### Progress
+
+Tools can report progress by calling `reportProgress` in the context object:
+
+```js
+server.addTool({
+  name: "download",
+  description: "Download a file",
+  parameters: z.object({
+    url: z.string(),
+  }),
+  execute: async (args, { reportProgress }) => {
+    reportProgress({
+      progress: 0,
+      total: 100,
+    });
+
+    // ...
+
+    reportProgress({
+      progress: 100,
+      total: 100,
+    });
+
+    return "done";
+  },
+});
+```
+
 ### Resources
 
 [Resources](https://modelcontextprotocol.io/docs/concepts/resources) represent any kind of data that an MCP server wants to make available to clients. This can include:

package/dist/FastMCP.d.ts

@@ -1,11 +1,35 @@
 import { z } from 'zod';
 
+declare abstract class FastMCPError extends Error {
+    constructor(message?: string);
+}
+type Extra = unknown;
+type Extras = Record<string, Extra>;
+declare class UnexpectedStateError extends FastMCPError {
+    extras?: Extras;
+    constructor(message: string, extras?: Extras);
+}
+declare class UserError extends UnexpectedStateError {
+}
 type ToolParameters = z.ZodTypeAny;
+type Progress = {
+    /**
+     * The progress thus far. This should increase every time progress is made, even if the total is unknown.
+     */
+    progress: number;
+    /**
+     * Total number of items to process (or total progress required), if known.
+     */
+    total?: number;
+};
+type Context = {
+    reportProgress: (progress: Progress) => Promise<void>;
+};
 type Tool<Params extends ToolParameters = ToolParameters> = {
     name: string;
     description?: string;
     parameters?: Params;
-    execute: (args: z.infer<Params>) => Promise<unknown>;
+    execute: (args: z.infer<Params>, context: Context) => Promise<unknown>;
 };
 type Resource = {
     uri: string;
@@ -66,4 +90,4 @@ declare class FastMCP {
     stop(): Promise<void>;
 }
 
-export { FastMCP };
+export { FastMCP, UserError };

package/dist/FastMCP.js

@@ -14,6 +14,22 @@ import {
 } from "@modelcontextprotocol/sdk/types.js";
 import { zodToJsonSchema } from "zod-to-json-schema";
 import http from "http";
+var FastMCPError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = new.target.name;
+  }
+};
+var UnexpectedStateError = class extends FastMCPError {
+  extras;
+  constructor(message, extras) {
+    super(message);
+    this.name = new.target.name;
+    this.extras = extras;
+  }
+};
+var UserError = class extends UnexpectedStateError {
+};
 var FastMCP = class {
   constructor(options) {
     this.options = options;
@@ -60,45 +76,66 @@ var FastMCP = class {
         })
       };
     });
-    server.setRequestHandler(CallToolRequestSchema, async (request) => {
-      const tool = this.#tools.find(
-        (tool2) => tool2.name === request.params.name
-      );
-      if (!tool) {
-        throw new McpError(
-          ErrorCode.MethodNotFound,
-          `Unknown tool: ${request.params.name}`
+    server.setRequestHandler(
+      CallToolRequestSchema,
+      async (request, ...extra) => {
+        const tool = this.#tools.find(
+          (tool2) => tool2.name === request.params.name
         );
-      }
-      let args = void 0;
-      if (tool.parameters) {
-        const parsed = tool.parameters.safeParse(request.params.arguments);
-        if (!parsed.success) {
+        if (!tool) {
           throw new McpError(
-            ErrorCode.InvalidRequest,
-            `Invalid ${request.params.name} arguments`
+            ErrorCode.MethodNotFound,
+            `Unknown tool: ${request.params.name}`
           );
         }
-        args = parsed.data;
-      }
-      let result;
-      try {
-        result = await tool.execute(args);
-      } catch (error) {
-        return {
-          content: [{ type: "text", text: `Error: ${error}` }],
-          isError: true
-        };
-      }
-      if (typeof result === "string") {
+        let args = void 0;
+        if (tool.parameters) {
+          const parsed = tool.parameters.safeParse(request.params.arguments);
+          if (!parsed.success) {
+            throw new McpError(
+              ErrorCode.InvalidRequest,
+              `Invalid ${request.params.name} arguments`
+            );
+          }
+          args = parsed.data;
+        }
+        const progressToken = request.params?._meta?.progressToken;
+        let result;
+        try {
+          const reportProgress = async (progress) => {
+            await server.notification({
+              method: "notifications/progress",
+              params: {
+                ...progress,
+                progressToken
+              }
+            });
+          };
+          result = await tool.execute(args, {
+            reportProgress
+          });
+        } catch (error) {
+          if (error instanceof UserError) {
+            return {
+              content: [{ type: "text", text: error.message }],
+              isError: true
+            };
+          }
+          return {
+            content: [{ type: "text", text: `Error: ${error}` }],
+            isError: true
+          };
+        }
+        if (typeof result === "string") {
+          return {
+            content: [{ type: "text", text: result }]
+          };
+        }
         return {
-          content: [{ type: "text", text: result }]
+          content: [{ type: "text", text: JSON.stringify(result, null, 2) }]
         };
       }
-      return {
-        content: [{ type: "text", text: JSON.stringify(result, null, 2) }]
-      };
-    });
+    );
   }
   setupResourceHandlers(server) {
     server.setRequestHandler(ListResourcesRequestSchema, async () => {
@@ -313,6 +350,7 @@ var FastMCP = class {
   }
 };
 export {
-  FastMCP
+  FastMCP,
+  UserError
 };
 //# sourceMappingURL=FastMCP.js.map

package/dist/FastMCP.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/FastMCP.ts"],"sourcesContent":["import { Server } from \"@modelcontextprotocol/sdk/server/index.js\";\nimport { StdioServerTransport } from \"@modelcontextprotocol/sdk/server/stdio.js\";\nimport { SSEServerTransport } from \"@modelcontextprotocol/sdk/server/sse.js\";\nimport {\n  CallToolRequestSchema,\n  ErrorCode,\n  GetPromptRequestSchema,\n  ListPromptsRequestSchema,\n  ListResourcesRequestSchema,\n  ListToolsRequestSchema,\n  McpError,\n  ReadResourceRequestSchema,\n  ServerCapabilities,\n} from \"@modelcontextprotocol/sdk/types.js\";\nimport { zodToJsonSchema } from \"zod-to-json-schema\";\nimport type { z } from \"zod\";\nimport http from \"http\";\n\ntype ToolParameters = z.ZodTypeAny;\n\ntype Tool<Params extends ToolParameters = ToolParameters> = {\n  name: string;\n  description?: string;\n  parameters?: Params;\n  execute: (args: z.infer<Params>) => Promise<unknown>;\n};\n\ntype Resource = {\n  uri: string;\n  name: string;\n  description?: string;\n  mimeType?: string;\n  load: () => Promise<{ text: string } | { blob: string }>;\n};\n\ntype PromptArgument = Readonly<{\n  name: string;\n  description?: string;\n  required?: boolean;\n}>;\n\ntype ArgumentsToObject<T extends PromptArgument[]> = {\n  [K in T[number][\"name\"]]: Extract<\n    T[number],\n    { name: K }\n  >[\"required\"] extends true\n    ? string\n    : string | undefined;\n};\n\ntype Prompt<\n  Arguments extends PromptArgument[] = PromptArgument[],\n  Args = ArgumentsToObject<Arguments>,\n> = {\n  name: string;\n  description?: string;\n  arguments?: Arguments;\n  load: (args: Args) => Promise<string>;\n};\n\ntype ServerOptions = {\n  name: string;\n  version: `${number}.${number}.${number}`;\n};\n\nexport class FastMCP {\n  #tools: Tool[];\n  #resources: Resource[];\n  #prompts: Prompt[];\n  #server: Server | null = null;\n  #options: ServerOptions;\n\n  constructor(public options: ServerOptions) {\n    this.#options = options;\n    this.#tools = [];\n    this.#resources = [];\n    this.#prompts = [];\n  }\n\n  private setupHandlers(server: Server) {\n    this.setupErrorHandling(server);\n\n    if (this.#tools.length) {\n      this.setupToolHandlers(server);\n    }\n\n    if (this.#resources.length) {\n      this.setupResourceHandlers(server);\n    }\n\n    if (this.#prompts.length) {\n      this.setupPromptHandlers(server);\n    }\n  }\n\n  private setupErrorHandling(server: Server) {\n    server.onerror = (error) => {\n      console.error(\"[MCP Error]\", error);\n    };\n    process.on(\"SIGINT\", async () => {\n      await server.close();\n      process.exit(0);\n    });\n  }\n\n  private setupToolHandlers(server: Server) {\n    server.setRequestHandler(ListToolsRequestSchema, async () => {\n      return {\n        tools: this.#tools.map((tool) => {\n          return {\n            name: tool.name,\n            description: tool.description,\n            inputSchema: tool.parameters\n              ? zodToJsonSchema(tool.parameters)\n              : undefined,\n          };\n        }),\n      };\n    });\n\n    server.setRequestHandler(CallToolRequestSchema, async (request) => {\n      const tool = this.#tools.find(\n        (tool) => tool.name === request.params.name,\n      );\n\n      if (!tool) {\n        throw new McpError(\n          ErrorCode.MethodNotFound,\n          `Unknown tool: ${request.params.name}`,\n        );\n      }\n\n      let args: any = undefined;\n\n      if (tool.parameters) {\n        const parsed = tool.parameters.safeParse(request.params.arguments);\n\n        if (!parsed.success) {\n          throw new McpError(\n            ErrorCode.InvalidRequest,\n            `Invalid ${request.params.name} arguments`,\n          );\n        }\n\n        args = parsed.data;\n      }\n\n      let result: any;\n\n      try {\n        result = await tool.execute(args);\n      } catch (error) {\n        return {\n          content: [{ type: \"text\", text: `Error: ${error}` }],\n          isError: true,\n        };\n      }\n\n      if (typeof result === \"string\") {\n        return {\n          content: [{ type: \"text\", text: result }],\n        };\n      }\n\n      return {\n        content: [{ type: \"text\", text: JSON.stringify(result, null, 2) }],\n      };\n    });\n  }\n\n  private setupResourceHandlers(server: Server) {\n    server.setRequestHandler(ListResourcesRequestSchema, async () => {\n      return {\n        resources: this.#resources.map((resource) => {\n          return {\n            uri: resource.uri,\n            name: resource.name,\n            mimeType: resource.mimeType,\n          };\n        }),\n      };\n    });\n\n    server.setRequestHandler(ReadResourceRequestSchema, async (request) => {\n      const resource = this.#resources.find(\n        (resource) => resource.uri === request.params.uri,\n      );\n\n      if (!resource) {\n        throw new McpError(\n          ErrorCode.MethodNotFound,\n          `Unknown resource: ${request.params.uri}`,\n        );\n      }\n\n      let result: Awaited<ReturnType<Resource[\"load\"]>>;\n\n      try {\n        result = await resource.load();\n      } catch (error) {\n        throw new McpError(\n          ErrorCode.InternalError,\n          `Error reading resource: ${error}`,\n          {\n            uri: resource.uri,\n          },\n        );\n      }\n\n      return {\n        contents: [\n          {\n            uri: resource.uri,\n            mimeType: resource.mimeType,\n            ...result,\n          },\n        ],\n      };\n    });\n  }\n\n  private setupPromptHandlers(server: Server) {\n    server.setRequestHandler(ListPromptsRequestSchema, async () => {\n      return {\n        prompts: this.#prompts.map((prompt) => {\n          return {\n            name: prompt.name,\n            description: prompt.description,\n            arguments: prompt.arguments,\n          };\n        }),\n      };\n    });\n\n    server.setRequestHandler(GetPromptRequestSchema, async (request) => {\n      const prompt = this.#prompts.find(\n        (prompt) => prompt.name === request.params.name,\n      );\n\n      if (!prompt) {\n        throw new McpError(\n          ErrorCode.MethodNotFound,\n          `Unknown prompt: ${request.params.name}`,\n        );\n      }\n\n      const args = request.params.arguments;\n\n      if (prompt.arguments) {\n        for (const arg of prompt.arguments) {\n          if (arg.required && !(args && arg.name in args)) {\n            throw new McpError(\n              ErrorCode.InvalidRequest,\n              `Missing required argument: ${arg.name}`,\n            );\n          }\n        }\n      }\n\n      let result: Awaited<ReturnType<Prompt[\"load\"]>>;\n\n      try {\n        result = await prompt.load(args as Record<string, string | undefined>);\n      } catch (error) {\n        throw new McpError(\n          ErrorCode.InternalError,\n          `Error loading prompt: ${error}`,\n        );\n      }\n\n      return {\n        description: prompt.description,\n        messages: [\n          {\n            role: \"user\",\n            content: { type: \"text\", text: result },\n          },\n        ],\n      };\n    });\n  }\n\n  public addTool<Params extends ToolParameters>(tool: Tool<Params>) {\n    this.#tools.push(tool as unknown as Tool);\n  }\n\n  public addResource(resource: Resource) {\n    this.#resources.push(resource);\n  }\n\n  public addPrompt<const Args extends PromptArgument[]>(prompt: Prompt<Args>) {\n    this.#prompts.push(prompt);\n  }\n\n  #httpServer: http.Server | null = null;\n\n  public async start(\n    options:\n      | { transportType: \"stdio\" }\n      | {\n          transportType: \"sse\";\n          sse: { endpoint: `/${string}`; port: number };\n        } = {\n      transportType: \"stdio\",\n    },\n  ) {\n    const capabilities: ServerCapabilities = {};\n\n    if (this.#tools.length) {\n      capabilities.tools = {};\n    }\n\n    if (this.#resources.length) {\n      capabilities.resources = {};\n    }\n\n    if (this.#prompts.length) {\n      capabilities.prompts = {};\n    }\n\n    this.#server = new Server(\n      { name: this.#options.name, version: this.#options.version },\n      { capabilities },\n    );\n\n    this.setupHandlers(this.#server);\n\n    if (options.transportType === \"stdio\") {\n      const transport = new StdioServerTransport();\n\n      await this.#server.connect(transport);\n\n      console.error(`server is running on stdio`);\n    } else if (options.transportType === \"sse\") {\n      let activeTransport: SSEServerTransport | null = null;\n\n      /**\n       * Adopted from https://dev.classmethod.jp/articles/mcp-sse/\n       */\n      this.#httpServer = http.createServer(async (req, res) => {\n        if (req.method === \"GET\" && req.url === options.sse.endpoint) {\n          const transport = new SSEServerTransport(\"/messages\", res);\n\n          activeTransport = transport;\n\n          if (!this.#server) {\n            throw new Error(\"Server not initialized\");\n          }\n\n          await this.#server.connect(transport);\n\n          res.on(\"close\", () => {\n            console.log(\"SSE connection closed\");\n            if (activeTransport === transport) {\n              activeTransport = null;\n            }\n          });\n\n          this.startSending(transport);\n          return;\n        }\n\n        if (req.method === \"POST\" && req.url?.startsWith(\"/messages\")) {\n          if (!activeTransport) {\n            res.writeHead(400).end(\"No active transport\");\n            return;\n          }\n          await activeTransport.handlePostMessage(req, res);\n          return;\n        }\n\n        res.writeHead(404).end();\n      });\n\n      this.#httpServer.listen(options.sse.port, \"0.0.0.0\");\n\n      console.error(\n        `server is running on SSE at http://localhost:${options.sse.port}${options.sse.endpoint}`,\n      );\n    } else {\n      throw new Error(\"Invalid transport type\");\n    }\n  }\n\n  /**\n   * @see https://dev.classmethod.jp/articles/mcp-sse/\n   */\n  private async startSending(transport: SSEServerTransport) {\n    try {\n      await transport.send({\n        jsonrpc: \"2.0\",\n        method: \"sse/connection\",\n        params: { message: \"SSE Connection established\" },\n      });\n\n      let messageCount = 0;\n      const interval = setInterval(async () => {\n        messageCount++;\n\n        const message = `Message ${messageCount} at ${new Date().toISOString()}`;\n\n        try {\n          await transport.send({\n            jsonrpc: \"2.0\",\n            method: \"sse/message\",\n            params: { data: message },\n          });\n\n          console.log(`Sent: ${message}`);\n\n          if (messageCount === 10) {\n            clearInterval(interval);\n\n            await transport.send({\n              jsonrpc: \"2.0\",\n              method: \"sse/complete\",\n              params: { message: \"Stream completed\" },\n            });\n            console.log(\"Stream completed\");\n          }\n        } catch (error) {\n          console.error(\"Error sending message:\", error);\n          clearInterval(interval);\n        }\n      }, 1000);\n    } catch (error) {\n      console.error(\"Error in startSending:\", error);\n    }\n  }\n\n  public async stop() {\n    if (this.#httpServer) {\n      this.#httpServer.close();\n    }\n  }\n}\n"],"mappings":";AAAA,SAAS,cAAc;AACvB,SAAS,4BAA4B;AACrC,SAAS,0BAA0B;AACnC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AACP,SAAS,uBAAuB;AAEhC,OAAO,UAAU;AAiDV,IAAM,UAAN,MAAc;AAAA,EAOnB,YAAmB,SAAwB;AAAxB;AACjB,SAAK,WAAW;AAChB,SAAK,SAAS,CAAC;AACf,SAAK,aAAa,CAAC;AACnB,SAAK,WAAW,CAAC;AAAA,EACnB;AAAA,EAXA;AAAA,EACA;AAAA,EACA;AAAA,EACA,UAAyB;AAAA,EACzB;AAAA,EASQ,cAAc,QAAgB;AACpC,SAAK,mBAAmB,MAAM;AAE9B,QAAI,KAAK,OAAO,QAAQ;AACtB,WAAK,kBAAkB,MAAM;AAAA,IAC/B;AAEA,QAAI,KAAK,WAAW,QAAQ;AAC1B,WAAK,sBAAsB,MAAM;AAAA,IACnC;AAEA,QAAI,KAAK,SAAS,QAAQ;AACxB,WAAK,oBAAoB,MAAM;AAAA,IACjC;AAAA,EACF;AAAA,EAEQ,mBAAmB,QAAgB;AACzC,WAAO,UAAU,CAAC,UAAU;AAC1B,cAAQ,MAAM,eAAe,KAAK;AAAA,IACpC;AACA,YAAQ,GAAG,UAAU,YAAY;AAC/B,YAAM,OAAO,MAAM;AACnB,cAAQ,KAAK,CAAC;AAAA,IAChB,CAAC;AAAA,EACH;AAAA,EAEQ,kBAAkB,QAAgB;AACxC,WAAO,kBAAkB,wBAAwB,YAAY;AAC3D,aAAO;AAAA,QACL,OAAO,KAAK,OAAO,IAAI,CAAC,SAAS;AAC/B,iBAAO;AAAA,YACL,MAAM,KAAK;AAAA,YACX,aAAa,KAAK;AAAA,YAClB,aAAa,KAAK,aACd,gBAAgB,KAAK,UAAU,IAC/B;AAAA,UACN;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAED,WAAO,kBAAkB,uBAAuB,OAAO,YAAY;AACjE,YAAM,OAAO,KAAK,OAAO;AAAA,QACvB,CAACA,UAASA,MAAK,SAAS,QAAQ,OAAO;AAAA,MACzC;AAEA,UAAI,CAAC,MAAM;AACT,cAAM,IAAI;AAAA,UACR,UAAU;AAAA,UACV,iBAAiB,QAAQ,OAAO,IAAI;AAAA,QACtC;AAAA,MACF;AAEA,UAAI,OAAY;AAEhB,UAAI,KAAK,YAAY;AACnB,cAAM,SAAS,KAAK,WAAW,UAAU,QAAQ,OAAO,SAAS;AAEjE,YAAI,CAAC,OAAO,SAAS;AACnB,gBAAM,IAAI;AAAA,YACR,UAAU;AAAA,YACV,WAAW,QAAQ,OAAO,IAAI;AAAA,UAChC;AAAA,QACF;AAEA,eAAO,OAAO;AAAA,MAChB;AAEA,UAAI;AAEJ,UAAI;AACF,iBAAS,MAAM,KAAK,QAAQ,IAAI;AAAA,MAClC,SAAS,OAAO;AACd,eAAO;AAAA,UACL,SAAS,CAAC,EAAE,MAAM,QAAQ,MAAM,UAAU,KAAK,GAAG,CAAC;AAAA,UACnD,SAAS;AAAA,QACX;AAAA,MACF;AAEA,UAAI,OAAO,WAAW,UAAU;AAC9B,eAAO;AAAA,UACL,SAAS,CAAC,EAAE,MAAM,QAAQ,MAAM,OAAO,CAAC;AAAA,QAC1C;AAAA,MACF;AAEA,aAAO;AAAA,QACL,SAAS,CAAC,EAAE,MAAM,QAAQ,MAAM,KAAK,UAAU,QAAQ,MAAM,CAAC,EAAE,CAAC;AAAA,MACnE;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEQ,sBAAsB,QAAgB;AAC5C,WAAO,kBAAkB,4BAA4B,YAAY;AAC/D,aAAO;AAAA,QACL,WAAW,KAAK,WAAW,IAAI,CAAC,aAAa;AAC3C,iBAAO;AAAA,YACL,KAAK,SAAS;AAAA,YACd,MAAM,SAAS;AAAA,YACf,UAAU,SAAS;AAAA,UACrB;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAED,WAAO,kBAAkB,2BAA2B,OAAO,YAAY;AACrE,YAAM,WAAW,KAAK,WAAW;AAAA,QAC/B,CAACC,cAAaA,UAAS,QAAQ,QAAQ,OAAO;AAAA,MAChD;AAEA,UAAI,CAAC,UAAU;AACb,cAAM,IAAI;AAAA,UACR,UAAU;AAAA,UACV,qBAAqB,QAAQ,OAAO,GAAG;AAAA,QACzC;AAAA,MACF;AAEA,UAAI;AAEJ,UAAI;AACF,iBAAS,MAAM,SAAS,KAAK;AAAA,MAC/B,SAAS,OAAO;AACd,cAAM,IAAI;AAAA,UACR,UAAU;AAAA,UACV,2BAA2B,KAAK;AAAA,UAChC;AAAA,YACE,KAAK,SAAS;AAAA,UAChB;AAAA,QACF;AAAA,MACF;AAEA,aAAO;AAAA,QACL,UAAU;AAAA,UACR;AAAA,YACE,KAAK,SAAS;AAAA,YACd,UAAU,SAAS;AAAA,YACnB,GAAG;AAAA,UACL;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEQ,oBAAoB,QAAgB;AAC1C,WAAO,kBAAkB,0BAA0B,YAAY;AAC7D,aAAO;AAAA,QACL,SAAS,KAAK,SAAS,IAAI,CAAC,WAAW;AACrC,iBAAO;AAAA,YACL,MAAM,OAAO;AAAA,YACb,aAAa,OAAO;AAAA,YACpB,WAAW,OAAO;AAAA,UACpB;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAED,WAAO,kBAAkB,wBAAwB,OAAO,YAAY;AAClE,YAAM,SAAS,KAAK,SAAS;AAAA,QAC3B,CAACC,YAAWA,QAAO,SAAS,QAAQ,OAAO;AAAA,MAC7C;AAEA,UAAI,CAAC,QAAQ;AACX,cAAM,IAAI;AAAA,UACR,UAAU;AAAA,UACV,mBAAmB,QAAQ,OAAO,IAAI;AAAA,QACxC;AAAA,MACF;AAEA,YAAM,OAAO,QAAQ,OAAO;AAE5B,UAAI,OAAO,WAAW;AACpB,mBAAW,OAAO,OAAO,WAAW;AAClC,cAAI,IAAI,YAAY,EAAE,QAAQ,IAAI,QAAQ,OAAO;AAC/C,kBAAM,IAAI;AAAA,cACR,UAAU;AAAA,cACV,8BAA8B,IAAI,IAAI;AAAA,YACxC;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAEA,UAAI;AAEJ,UAAI;AACF,iBAAS,MAAM,OAAO,KAAK,IAA0C;AAAA,MACvE,SAAS,OAAO;AACd,cAAM,IAAI;AAAA,UACR,UAAU;AAAA,UACV,yBAAyB,KAAK;AAAA,QAChC;AAAA,MACF;AAEA,aAAO;AAAA,QACL,aAAa,OAAO;AAAA,QACpB,UAAU;AAAA,UACR;AAAA,YACE,MAAM;AAAA,YACN,SAAS,EAAE,MAAM,QAAQ,MAAM,OAAO;AAAA,UACxC;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEO,QAAuC,MAAoB;AAChE,SAAK,OAAO,KAAK,IAAuB;AAAA,EAC1C;AAAA,EAEO,YAAY,UAAoB;AACrC,SAAK,WAAW,KAAK,QAAQ;AAAA,EAC/B;AAAA,EAEO,UAA+C,QAAsB;AAC1E,SAAK,SAAS,KAAK,MAAM;AAAA,EAC3B;AAAA,EAEA,cAAkC;AAAA,EAElC,MAAa,MACX,UAKQ;AAAA,IACN,eAAe;AAAA,EACjB,GACA;AACA,UAAM,eAAmC,CAAC;AAE1C,QAAI,KAAK,OAAO,QAAQ;AACtB,mBAAa,QAAQ,CAAC;AAAA,IACxB;AAEA,QAAI,KAAK,WAAW,QAAQ;AAC1B,mBAAa,YAAY,CAAC;AAAA,IAC5B;AAEA,QAAI,KAAK,SAAS,QAAQ;AACxB,mBAAa,UAAU,CAAC;AAAA,IAC1B;AAEA,SAAK,UAAU,IAAI;AAAA,MACjB,EAAE,MAAM,KAAK,SAAS,MAAM,SAAS,KAAK,SAAS,QAAQ;AAAA,MAC3D,EAAE,aAAa;AAAA,IACjB;AAEA,SAAK,cAAc,KAAK,OAAO;AAE/B,QAAI,QAAQ,kBAAkB,SAAS;AACrC,YAAM,YAAY,IAAI,qBAAqB;AAE3C,YAAM,KAAK,QAAQ,QAAQ,SAAS;AAEpC,cAAQ,MAAM,4BAA4B;AAAA,IAC5C,WAAW,QAAQ,kBAAkB,OAAO;AAC1C,UAAI,kBAA6C;AAKjD,WAAK,cAAc,KAAK,aAAa,OAAO,KAAK,QAAQ;AACvD,YAAI,IAAI,WAAW,SAAS,IAAI,QAAQ,QAAQ,IAAI,UAAU;AAC5D,gBAAM,YAAY,IAAI,mBAAmB,aAAa,GAAG;AAEzD,4BAAkB;AAElB,cAAI,CAAC,KAAK,SAAS;AACjB,kBAAM,IAAI,MAAM,wBAAwB;AAAA,UAC1C;AAEA,gBAAM,KAAK,QAAQ,QAAQ,SAAS;AAEpC,cAAI,GAAG,SAAS,MAAM;AACpB,oBAAQ,IAAI,uBAAuB;AACnC,gBAAI,oBAAoB,WAAW;AACjC,gCAAkB;AAAA,YACpB;AAAA,UACF,CAAC;AAED,eAAK,aAAa,SAAS;AAC3B;AAAA,QACF;AAEA,YAAI,IAAI,WAAW,UAAU,IAAI,KAAK,WAAW,WAAW,GAAG;AAC7D,cAAI,CAAC,iBAAiB;AACpB,gBAAI,UAAU,GAAG,EAAE,IAAI,qBAAqB;AAC5C;AAAA,UACF;AACA,gBAAM,gBAAgB,kBAAkB,KAAK,GAAG;AAChD;AAAA,QACF;AAEA,YAAI,UAAU,GAAG,EAAE,IAAI;AAAA,MACzB,CAAC;AAED,WAAK,YAAY,OAAO,QAAQ,IAAI,MAAM,SAAS;AAEnD,cAAQ;AAAA,QACN,gDAAgD,QAAQ,IAAI,IAAI,GAAG,QAAQ,IAAI,QAAQ;AAAA,MACzF;AAAA,IACF,OAAO;AACL,YAAM,IAAI,MAAM,wBAAwB;AAAA,IAC1C;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAc,aAAa,WAA+B;AACxD,QAAI;AACF,YAAM,UAAU,KAAK;AAAA,QACnB,SAAS;AAAA,QACT,QAAQ;AAAA,QACR,QAAQ,EAAE,SAAS,6BAA6B;AAAA,MAClD,CAAC;AAED,UAAI,eAAe;AACnB,YAAM,WAAW,YAAY,YAAY;AACvC;AAEA,cAAM,UAAU,WAAW,YAAY,QAAO,oBAAI,KAAK,GAAE,YAAY,CAAC;AAEtE,YAAI;AACF,gBAAM,UAAU,KAAK;AAAA,YACnB,SAAS;AAAA,YACT,QAAQ;AAAA,YACR,QAAQ,EAAE,MAAM,QAAQ;AAAA,UAC1B,CAAC;AAED,kBAAQ,IAAI,SAAS,OAAO,EAAE;AAE9B,cAAI,iBAAiB,IAAI;AACvB,0BAAc,QAAQ;AAEtB,kBAAM,UAAU,KAAK;AAAA,cACnB,SAAS;AAAA,cACT,QAAQ;AAAA,cACR,QAAQ,EAAE,SAAS,mBAAmB;AAAA,YACxC,CAAC;AACD,oBAAQ,IAAI,kBAAkB;AAAA,UAChC;AAAA,QACF,SAAS,OAAO;AACd,kBAAQ,MAAM,0BAA0B,KAAK;AAC7C,wBAAc,QAAQ;AAAA,QACxB;AAAA,MACF,GAAG,GAAI;AAAA,IACT,SAAS,OAAO;AACd,cAAQ,MAAM,0BAA0B,KAAK;AAAA,IAC/C;AAAA,EACF;AAAA,EAEA,MAAa,OAAO;AAClB,QAAI,KAAK,aAAa;AACpB,WAAK,YAAY,MAAM;AAAA,IACzB;AAAA,EACF;AACF;","names":["tool","resource","prompt"]}
+{"version":3,"sources":["../src/FastMCP.ts"],"sourcesContent":["import { Server } from \"@modelcontextprotocol/sdk/server/index.js\";\nimport { StdioServerTransport } from \"@modelcontextprotocol/sdk/server/stdio.js\";\nimport { SSEServerTransport } from \"@modelcontextprotocol/sdk/server/sse.js\";\nimport {\n  CallToolRequestSchema,\n  ErrorCode,\n  GetPromptRequestSchema,\n  ListPromptsRequestSchema,\n  ListResourcesRequestSchema,\n  ListToolsRequestSchema,\n  McpError,\n  ReadResourceRequestSchema,\n  ServerCapabilities,\n} from \"@modelcontextprotocol/sdk/types.js\";\nimport { zodToJsonSchema } from \"zod-to-json-schema\";\nimport type { z } from \"zod\";\nimport http from \"http\";\n\nabstract class FastMCPError extends Error {\n  public constructor(message?: string) {\n    super(message);\n    this.name = new.target.name;\n  }\n}\n\ntype Extra = unknown;\n\ntype Extras = Record<string, Extra>;\n\nclass UnexpectedStateError extends FastMCPError {\n  public extras?: Extras;\n\n  public constructor(message: string, extras?: Extras) {\n    super(message);\n    this.name = new.target.name;\n    this.extras = extras;\n  }\n}\n\nexport class UserError extends UnexpectedStateError {}\n\ntype ToolParameters = z.ZodTypeAny;\n\ntype Progress = {\n  /**\n   * The progress thus far. This should increase every time progress is made, even if the total is unknown.\n   */\n  progress: number;\n  /**\n   * Total number of items to process (or total progress required), if known.\n   */\n  total?: number;\n};\n\ntype Context = {\n  reportProgress: (progress: Progress) => Promise<void>;\n};\n\ntype Tool<Params extends ToolParameters = ToolParameters> = {\n  name: string;\n  description?: string;\n  parameters?: Params;\n  execute: (args: z.infer<Params>, context: Context) => Promise<unknown>;\n};\n\ntype Resource = {\n  uri: string;\n  name: string;\n  description?: string;\n  mimeType?: string;\n  load: () => Promise<{ text: string } | { blob: string }>;\n};\n\ntype PromptArgument = Readonly<{\n  name: string;\n  description?: string;\n  required?: boolean;\n}>;\n\ntype ArgumentsToObject<T extends PromptArgument[]> = {\n  [K in T[number][\"name\"]]: Extract<\n    T[number],\n    { name: K }\n  >[\"required\"] extends true\n    ? string\n    : string | undefined;\n};\n\ntype Prompt<\n  Arguments extends PromptArgument[] = PromptArgument[],\n  Args = ArgumentsToObject<Arguments>,\n> = {\n  name: string;\n  description?: string;\n  arguments?: Arguments;\n  load: (args: Args) => Promise<string>;\n};\n\ntype ServerOptions = {\n  name: string;\n  version: `${number}.${number}.${number}`;\n};\n\nexport class FastMCP {\n  #tools: Tool[];\n  #resources: Resource[];\n  #prompts: Prompt[];\n  #server: Server | null = null;\n  #options: ServerOptions;\n\n  constructor(public options: ServerOptions) {\n    this.#options = options;\n    this.#tools = [];\n    this.#resources = [];\n    this.#prompts = [];\n  }\n\n  private setupHandlers(server: Server) {\n    this.setupErrorHandling(server);\n\n    if (this.#tools.length) {\n      this.setupToolHandlers(server);\n    }\n\n    if (this.#resources.length) {\n      this.setupResourceHandlers(server);\n    }\n\n    if (this.#prompts.length) {\n      this.setupPromptHandlers(server);\n    }\n  }\n\n  private setupErrorHandling(server: Server) {\n    server.onerror = (error) => {\n      console.error(\"[MCP Error]\", error);\n    };\n    process.on(\"SIGINT\", async () => {\n      await server.close();\n      process.exit(0);\n    });\n  }\n\n  private setupToolHandlers(server: Server) {\n    server.setRequestHandler(ListToolsRequestSchema, async () => {\n      return {\n        tools: this.#tools.map((tool) => {\n          return {\n            name: tool.name,\n            description: tool.description,\n            inputSchema: tool.parameters\n              ? zodToJsonSchema(tool.parameters)\n              : undefined,\n          };\n        }),\n      };\n    });\n\n    server.setRequestHandler(\n      CallToolRequestSchema,\n      async (request, ...extra) => {\n        const tool = this.#tools.find(\n          (tool) => tool.name === request.params.name,\n        );\n\n        if (!tool) {\n          throw new McpError(\n            ErrorCode.MethodNotFound,\n            `Unknown tool: ${request.params.name}`,\n          );\n        }\n\n        let args: any = undefined;\n\n        if (tool.parameters) {\n          const parsed = tool.parameters.safeParse(request.params.arguments);\n\n          if (!parsed.success) {\n            throw new McpError(\n              ErrorCode.InvalidRequest,\n              `Invalid ${request.params.name} arguments`,\n            );\n          }\n\n          args = parsed.data;\n        }\n\n        const progressToken = request.params?._meta?.progressToken;\n\n        let result: any;\n\n        try {\n          const reportProgress = async (progress: Progress) => {\n            await server.notification({\n              method: \"notifications/progress\",\n              params: {\n                ...progress,\n                progressToken,\n              },\n            });\n          };\n\n          result = await tool.execute(args, {\n            reportProgress,\n          });\n        } catch (error) {\n          if (error instanceof UserError) {\n            return {\n              content: [{ type: \"text\", text: error.message }],\n              isError: true,\n            };\n          }\n\n          return {\n            content: [{ type: \"text\", text: `Error: ${error}` }],\n            isError: true,\n          };\n        }\n\n        if (typeof result === \"string\") {\n          return {\n            content: [{ type: \"text\", text: result }],\n          };\n        }\n\n        return {\n          content: [{ type: \"text\", text: JSON.stringify(result, null, 2) }],\n        };\n      },\n    );\n  }\n\n  private setupResourceHandlers(server: Server) {\n    server.setRequestHandler(ListResourcesRequestSchema, async () => {\n      return {\n        resources: this.#resources.map((resource) => {\n          return {\n            uri: resource.uri,\n            name: resource.name,\n            mimeType: resource.mimeType,\n          };\n        }),\n      };\n    });\n\n    server.setRequestHandler(ReadResourceRequestSchema, async (request) => {\n      const resource = this.#resources.find(\n        (resource) => resource.uri === request.params.uri,\n      );\n\n      if (!resource) {\n        throw new McpError(\n          ErrorCode.MethodNotFound,\n          `Unknown resource: ${request.params.uri}`,\n        );\n      }\n\n      let result: Awaited<ReturnType<Resource[\"load\"]>>;\n\n      try {\n        result = await resource.load();\n      } catch (error) {\n        throw new McpError(\n          ErrorCode.InternalError,\n          `Error reading resource: ${error}`,\n          {\n            uri: resource.uri,\n          },\n        );\n      }\n\n      return {\n        contents: [\n          {\n            uri: resource.uri,\n            mimeType: resource.mimeType,\n            ...result,\n          },\n        ],\n      };\n    });\n  }\n\n  private setupPromptHandlers(server: Server) {\n    server.setRequestHandler(ListPromptsRequestSchema, async () => {\n      return {\n        prompts: this.#prompts.map((prompt) => {\n          return {\n            name: prompt.name,\n            description: prompt.description,\n            arguments: prompt.arguments,\n          };\n        }),\n      };\n    });\n\n    server.setRequestHandler(GetPromptRequestSchema, async (request) => {\n      const prompt = this.#prompts.find(\n        (prompt) => prompt.name === request.params.name,\n      );\n\n      if (!prompt) {\n        throw new McpError(\n          ErrorCode.MethodNotFound,\n          `Unknown prompt: ${request.params.name}`,\n        );\n      }\n\n      const args = request.params.arguments;\n\n      if (prompt.arguments) {\n        for (const arg of prompt.arguments) {\n          if (arg.required && !(args && arg.name in args)) {\n            throw new McpError(\n              ErrorCode.InvalidRequest,\n              `Missing required argument: ${arg.name}`,\n            );\n          }\n        }\n      }\n\n      let result: Awaited<ReturnType<Prompt[\"load\"]>>;\n\n      try {\n        result = await prompt.load(args as Record<string, string | undefined>);\n      } catch (error) {\n        throw new McpError(\n          ErrorCode.InternalError,\n          `Error loading prompt: ${error}`,\n        );\n      }\n\n      return {\n        description: prompt.description,\n        messages: [\n          {\n            role: \"user\",\n            content: { type: \"text\", text: result },\n          },\n        ],\n      };\n    });\n  }\n\n  public addTool<Params extends ToolParameters>(tool: Tool<Params>) {\n    this.#tools.push(tool as unknown as Tool);\n  }\n\n  public addResource(resource: Resource) {\n    this.#resources.push(resource);\n  }\n\n  public addPrompt<const Args extends PromptArgument[]>(prompt: Prompt<Args>) {\n    this.#prompts.push(prompt);\n  }\n\n  #httpServer: http.Server | null = null;\n\n  public async start(\n    options:\n      | { transportType: \"stdio\" }\n      | {\n          transportType: \"sse\";\n          sse: { endpoint: `/${string}`; port: number };\n        } = {\n      transportType: \"stdio\",\n    },\n  ) {\n    const capabilities: ServerCapabilities = {};\n\n    if (this.#tools.length) {\n      capabilities.tools = {};\n    }\n\n    if (this.#resources.length) {\n      capabilities.resources = {};\n    }\n\n    if (this.#prompts.length) {\n      capabilities.prompts = {};\n    }\n\n    this.#server = new Server(\n      { name: this.#options.name, version: this.#options.version },\n      { capabilities },\n    );\n\n    this.setupHandlers(this.#server);\n\n    if (options.transportType === \"stdio\") {\n      const transport = new StdioServerTransport();\n\n      await this.#server.connect(transport);\n\n      console.error(`server is running on stdio`);\n    } else if (options.transportType === \"sse\") {\n      let activeTransport: SSEServerTransport | null = null;\n\n      /**\n       * Adopted from https://dev.classmethod.jp/articles/mcp-sse/\n       */\n      this.#httpServer = http.createServer(async (req, res) => {\n        if (req.method === \"GET\" && req.url === options.sse.endpoint) {\n          const transport = new SSEServerTransport(\"/messages\", res);\n\n          activeTransport = transport;\n\n          if (!this.#server) {\n            throw new Error(\"Server not initialized\");\n          }\n\n          await this.#server.connect(transport);\n\n          res.on(\"close\", () => {\n            console.log(\"SSE connection closed\");\n            if (activeTransport === transport) {\n              activeTransport = null;\n            }\n          });\n\n          this.startSending(transport);\n          return;\n        }\n\n        if (req.method === \"POST\" && req.url?.startsWith(\"/messages\")) {\n          if (!activeTransport) {\n            res.writeHead(400).end(\"No active transport\");\n            return;\n          }\n          await activeTransport.handlePostMessage(req, res);\n          return;\n        }\n\n        res.writeHead(404).end();\n      });\n\n      this.#httpServer.listen(options.sse.port, \"0.0.0.0\");\n\n      console.error(\n        `server is running on SSE at http://localhost:${options.sse.port}${options.sse.endpoint}`,\n      );\n    } else {\n      throw new Error(\"Invalid transport type\");\n    }\n  }\n\n  /**\n   * @see https://dev.classmethod.jp/articles/mcp-sse/\n   */\n  private async startSending(transport: SSEServerTransport) {\n    try {\n      await transport.send({\n        jsonrpc: \"2.0\",\n        method: \"sse/connection\",\n        params: { message: \"SSE Connection established\" },\n      });\n\n      let messageCount = 0;\n      const interval = setInterval(async () => {\n        messageCount++;\n\n        const message = `Message ${messageCount} at ${new Date().toISOString()}`;\n\n        try {\n          await transport.send({\n            jsonrpc: \"2.0\",\n            method: \"sse/message\",\n            params: { data: message },\n          });\n\n          console.log(`Sent: ${message}`);\n\n          if (messageCount === 10) {\n            clearInterval(interval);\n\n            await transport.send({\n              jsonrpc: \"2.0\",\n              method: \"sse/complete\",\n              params: { message: \"Stream completed\" },\n            });\n            console.log(\"Stream completed\");\n          }\n        } catch (error) {\n          console.error(\"Error sending message:\", error);\n          clearInterval(interval);\n        }\n      }, 1000);\n    } catch (error) {\n      console.error(\"Error in startSending:\", error);\n    }\n  }\n\n  public async stop() {\n    if (this.#httpServer) {\n      this.#httpServer.close();\n    }\n  }\n}\n"],"mappings":";AAAA,SAAS,cAAc;AACvB,SAAS,4BAA4B;AACrC,SAAS,0BAA0B;AACnC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AACP,SAAS,uBAAuB;AAEhC,OAAO,UAAU;AAEjB,IAAe,eAAf,cAAoC,MAAM;AAAA,EACjC,YAAY,SAAkB;AACnC,UAAM,OAAO;AACb,SAAK,OAAO,WAAW;AAAA,EACzB;AACF;AAMA,IAAM,uBAAN,cAAmC,aAAa;AAAA,EACvC;AAAA,EAEA,YAAY,SAAiB,QAAiB;AACnD,UAAM,OAAO;AACb,SAAK,OAAO,WAAW;AACvB,SAAK,SAAS;AAAA,EAChB;AACF;AAEO,IAAM,YAAN,cAAwB,qBAAqB;AAAC;AAgE9C,IAAM,UAAN,MAAc;AAAA,EAOnB,YAAmB,SAAwB;AAAxB;AACjB,SAAK,WAAW;AAChB,SAAK,SAAS,CAAC;AACf,SAAK,aAAa,CAAC;AACnB,SAAK,WAAW,CAAC;AAAA,EACnB;AAAA,EAXA;AAAA,EACA;AAAA,EACA;AAAA,EACA,UAAyB;AAAA,EACzB;AAAA,EASQ,cAAc,QAAgB;AACpC,SAAK,mBAAmB,MAAM;AAE9B,QAAI,KAAK,OAAO,QAAQ;AACtB,WAAK,kBAAkB,MAAM;AAAA,IAC/B;AAEA,QAAI,KAAK,WAAW,QAAQ;AAC1B,WAAK,sBAAsB,MAAM;AAAA,IACnC;AAEA,QAAI,KAAK,SAAS,QAAQ;AACxB,WAAK,oBAAoB,MAAM;AAAA,IACjC;AAAA,EACF;AAAA,EAEQ,mBAAmB,QAAgB;AACzC,WAAO,UAAU,CAAC,UAAU;AAC1B,cAAQ,MAAM,eAAe,KAAK;AAAA,IACpC;AACA,YAAQ,GAAG,UAAU,YAAY;AAC/B,YAAM,OAAO,MAAM;AACnB,cAAQ,KAAK,CAAC;AAAA,IAChB,CAAC;AAAA,EACH;AAAA,EAEQ,kBAAkB,QAAgB;AACxC,WAAO,kBAAkB,wBAAwB,YAAY;AAC3D,aAAO;AAAA,QACL,OAAO,KAAK,OAAO,IAAI,CAAC,SAAS;AAC/B,iBAAO;AAAA,YACL,MAAM,KAAK;AAAA,YACX,aAAa,KAAK;AAAA,YAClB,aAAa,KAAK,aACd,gBAAgB,KAAK,UAAU,IAC/B;AAAA,UACN;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAED,WAAO;AAAA,MACL;AAAA,MACA,OAAO,YAAY,UAAU;AAC3B,cAAM,OAAO,KAAK,OAAO;AAAA,UACvB,CAACA,UAASA,MAAK,SAAS,QAAQ,OAAO;AAAA,QACzC;AAEA,YAAI,CAAC,MAAM;AACT,gBAAM,IAAI;AAAA,YACR,UAAU;AAAA,YACV,iBAAiB,QAAQ,OAAO,IAAI;AAAA,UACtC;AAAA,QACF;AAEA,YAAI,OAAY;AAEhB,YAAI,KAAK,YAAY;AACnB,gBAAM,SAAS,KAAK,WAAW,UAAU,QAAQ,OAAO,SAAS;AAEjE,cAAI,CAAC,OAAO,SAAS;AACnB,kBAAM,IAAI;AAAA,cACR,UAAU;AAAA,cACV,WAAW,QAAQ,OAAO,IAAI;AAAA,YAChC;AAAA,UACF;AAEA,iBAAO,OAAO;AAAA,QAChB;AAEA,cAAM,gBAAgB,QAAQ,QAAQ,OAAO;AAE7C,YAAI;AAEJ,YAAI;AACF,gBAAM,iBAAiB,OAAO,aAAuB;AACnD,kBAAM,OAAO,aAAa;AAAA,cACxB,QAAQ;AAAA,cACR,QAAQ;AAAA,gBACN,GAAG;AAAA,gBACH;AAAA,cACF;AAAA,YACF,CAAC;AAAA,UACH;AAEA,mBAAS,MAAM,KAAK,QAAQ,MAAM;AAAA,YAChC;AAAA,UACF,CAAC;AAAA,QACH,SAAS,OAAO;AACd,cAAI,iBAAiB,WAAW;AAC9B,mBAAO;AAAA,cACL,SAAS,CAAC,EAAE,MAAM,QAAQ,MAAM,MAAM,QAAQ,CAAC;AAAA,cAC/C,SAAS;AAAA,YACX;AAAA,UACF;AAEA,iBAAO;AAAA,YACL,SAAS,CAAC,EAAE,MAAM,QAAQ,MAAM,UAAU,KAAK,GAAG,CAAC;AAAA,YACnD,SAAS;AAAA,UACX;AAAA,QACF;AAEA,YAAI,OAAO,WAAW,UAAU;AAC9B,iBAAO;AAAA,YACL,SAAS,CAAC,EAAE,MAAM,QAAQ,MAAM,OAAO,CAAC;AAAA,UAC1C;AAAA,QACF;AAEA,eAAO;AAAA,UACL,SAAS,CAAC,EAAE,MAAM,QAAQ,MAAM,KAAK,UAAU,QAAQ,MAAM,CAAC,EAAE,CAAC;AAAA,QACnE;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEQ,sBAAsB,QAAgB;AAC5C,WAAO,kBAAkB,4BAA4B,YAAY;AAC/D,aAAO;AAAA,QACL,WAAW,KAAK,WAAW,IAAI,CAAC,aAAa;AAC3C,iBAAO;AAAA,YACL,KAAK,SAAS;AAAA,YACd,MAAM,SAAS;AAAA,YACf,UAAU,SAAS;AAAA,UACrB;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAED,WAAO,kBAAkB,2BAA2B,OAAO,YAAY;AACrE,YAAM,WAAW,KAAK,WAAW;AAAA,QAC/B,CAACC,cAAaA,UAAS,QAAQ,QAAQ,OAAO;AAAA,MAChD;AAEA,UAAI,CAAC,UAAU;AACb,cAAM,IAAI;AAAA,UACR,UAAU;AAAA,UACV,qBAAqB,QAAQ,OAAO,GAAG;AAAA,QACzC;AAAA,MACF;AAEA,UAAI;AAEJ,UAAI;AACF,iBAAS,MAAM,SAAS,KAAK;AAAA,MAC/B,SAAS,OAAO;AACd,cAAM,IAAI;AAAA,UACR,UAAU;AAAA,UACV,2BAA2B,KAAK;AAAA,UAChC;AAAA,YACE,KAAK,SAAS;AAAA,UAChB;AAAA,QACF;AAAA,MACF;AAEA,aAAO;AAAA,QACL,UAAU;AAAA,UACR;AAAA,YACE,KAAK,SAAS;AAAA,YACd,UAAU,SAAS;AAAA,YACnB,GAAG;AAAA,UACL;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEQ,oBAAoB,QAAgB;AAC1C,WAAO,kBAAkB,0BAA0B,YAAY;AAC7D,aAAO;AAAA,QACL,SAAS,KAAK,SAAS,IAAI,CAAC,WAAW;AACrC,iBAAO;AAAA,YACL,MAAM,OAAO;AAAA,YACb,aAAa,OAAO;AAAA,YACpB,WAAW,OAAO;AAAA,UACpB;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAED,WAAO,kBAAkB,wBAAwB,OAAO,YAAY;AAClE,YAAM,SAAS,KAAK,SAAS;AAAA,QAC3B,CAACC,YAAWA,QAAO,SAAS,QAAQ,OAAO;AAAA,MAC7C;AAEA,UAAI,CAAC,QAAQ;AACX,cAAM,IAAI;AAAA,UACR,UAAU;AAAA,UACV,mBAAmB,QAAQ,OAAO,IAAI;AAAA,QACxC;AAAA,MACF;AAEA,YAAM,OAAO,QAAQ,OAAO;AAE5B,UAAI,OAAO,WAAW;AACpB,mBAAW,OAAO,OAAO,WAAW;AAClC,cAAI,IAAI,YAAY,EAAE,QAAQ,IAAI,QAAQ,OAAO;AAC/C,kBAAM,IAAI;AAAA,cACR,UAAU;AAAA,cACV,8BAA8B,IAAI,IAAI;AAAA,YACxC;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAEA,UAAI;AAEJ,UAAI;AACF,iBAAS,MAAM,OAAO,KAAK,IAA0C;AAAA,MACvE,SAAS,OAAO;AACd,cAAM,IAAI;AAAA,UACR,UAAU;AAAA,UACV,yBAAyB,KAAK;AAAA,QAChC;AAAA,MACF;AAEA,aAAO;AAAA,QACL,aAAa,OAAO;AAAA,QACpB,UAAU;AAAA,UACR;AAAA,YACE,MAAM;AAAA,YACN,SAAS,EAAE,MAAM,QAAQ,MAAM,OAAO;AAAA,UACxC;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEO,QAAuC,MAAoB;AAChE,SAAK,OAAO,KAAK,IAAuB;AAAA,EAC1C;AAAA,EAEO,YAAY,UAAoB;AACrC,SAAK,WAAW,KAAK,QAAQ;AAAA,EAC/B;AAAA,EAEO,UAA+C,QAAsB;AAC1E,SAAK,SAAS,KAAK,MAAM;AAAA,EAC3B;AAAA,EAEA,cAAkC;AAAA,EAElC,MAAa,MACX,UAKQ;AAAA,IACN,eAAe;AAAA,EACjB,GACA;AACA,UAAM,eAAmC,CAAC;AAE1C,QAAI,KAAK,OAAO,QAAQ;AACtB,mBAAa,QAAQ,CAAC;AAAA,IACxB;AAEA,QAAI,KAAK,WAAW,QAAQ;AAC1B,mBAAa,YAAY,CAAC;AAAA,IAC5B;AAEA,QAAI,KAAK,SAAS,QAAQ;AACxB,mBAAa,UAAU,CAAC;AAAA,IAC1B;AAEA,SAAK,UAAU,IAAI;AAAA,MACjB,EAAE,MAAM,KAAK,SAAS,MAAM,SAAS,KAAK,SAAS,QAAQ;AAAA,MAC3D,EAAE,aAAa;AAAA,IACjB;AAEA,SAAK,cAAc,KAAK,OAAO;AAE/B,QAAI,QAAQ,kBAAkB,SAAS;AACrC,YAAM,YAAY,IAAI,qBAAqB;AAE3C,YAAM,KAAK,QAAQ,QAAQ,SAAS;AAEpC,cAAQ,MAAM,4BAA4B;AAAA,IAC5C,WAAW,QAAQ,kBAAkB,OAAO;AAC1C,UAAI,kBAA6C;AAKjD,WAAK,cAAc,KAAK,aAAa,OAAO,KAAK,QAAQ;AACvD,YAAI,IAAI,WAAW,SAAS,IAAI,QAAQ,QAAQ,IAAI,UAAU;AAC5D,gBAAM,YAAY,IAAI,mBAAmB,aAAa,GAAG;AAEzD,4BAAkB;AAElB,cAAI,CAAC,KAAK,SAAS;AACjB,kBAAM,IAAI,MAAM,wBAAwB;AAAA,UAC1C;AAEA,gBAAM,KAAK,QAAQ,QAAQ,SAAS;AAEpC,cAAI,GAAG,SAAS,MAAM;AACpB,oBAAQ,IAAI,uBAAuB;AACnC,gBAAI,oBAAoB,WAAW;AACjC,gCAAkB;AAAA,YACpB;AAAA,UACF,CAAC;AAED,eAAK,aAAa,SAAS;AAC3B;AAAA,QACF;AAEA,YAAI,IAAI,WAAW,UAAU,IAAI,KAAK,WAAW,WAAW,GAAG;AAC7D,cAAI,CAAC,iBAAiB;AACpB,gBAAI,UAAU,GAAG,EAAE,IAAI,qBAAqB;AAC5C;AAAA,UACF;AACA,gBAAM,gBAAgB,kBAAkB,KAAK,GAAG;AAChD;AAAA,QACF;AAEA,YAAI,UAAU,GAAG,EAAE,IAAI;AAAA,MACzB,CAAC;AAED,WAAK,YAAY,OAAO,QAAQ,IAAI,MAAM,SAAS;AAEnD,cAAQ;AAAA,QACN,gDAAgD,QAAQ,IAAI,IAAI,GAAG,QAAQ,IAAI,QAAQ;AAAA,MACzF;AAAA,IACF,OAAO;AACL,YAAM,IAAI,MAAM,wBAAwB;AAAA,IAC1C;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAc,aAAa,WAA+B;AACxD,QAAI;AACF,YAAM,UAAU,KAAK;AAAA,QACnB,SAAS;AAAA,QACT,QAAQ;AAAA,QACR,QAAQ,EAAE,SAAS,6BAA6B;AAAA,MAClD,CAAC;AAED,UAAI,eAAe;AACnB,YAAM,WAAW,YAAY,YAAY;AACvC;AAEA,cAAM,UAAU,WAAW,YAAY,QAAO,oBAAI,KAAK,GAAE,YAAY,CAAC;AAEtE,YAAI;AACF,gBAAM,UAAU,KAAK;AAAA,YACnB,SAAS;AAAA,YACT,QAAQ;AAAA,YACR,QAAQ,EAAE,MAAM,QAAQ;AAAA,UAC1B,CAAC;AAED,kBAAQ,IAAI,SAAS,OAAO,EAAE;AAE9B,cAAI,iBAAiB,IAAI;AACvB,0BAAc,QAAQ;AAEtB,kBAAM,UAAU,KAAK;AAAA,cACnB,SAAS;AAAA,cACT,QAAQ;AAAA,cACR,QAAQ,EAAE,SAAS,mBAAmB;AAAA,YACxC,CAAC;AACD,oBAAQ,IAAI,kBAAkB;AAAA,UAChC;AAAA,QACF,SAAS,OAAO;AACd,kBAAQ,MAAM,0BAA0B,KAAK;AAC7C,wBAAc,QAAQ;AAAA,QACxB;AAAA,MACF,GAAG,GAAI;AAAA,IACT,SAAS,OAAO;AACd,cAAQ,MAAM,0BAA0B,KAAK;AAAA,IAC/C;AAAA,EACF;AAAA,EAEA,MAAa,OAAO;AAClB,QAAI,KAAK,aAAa;AACpB,WAAK,YAAY,MAAM;AAAA,IACzB;AAAA,EACF;AACF;","names":["tool","resource","prompt"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastmcp",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "main": "dist/fastmcp.js",
   "scripts": {
     "build": "tsup",

package/src/FastMCP.test.ts

@@ -1,10 +1,12 @@
-import { FastMCP } from "./FastMCP.js";
+import { FastMCP, UserError } from "./FastMCP.js";
 import { z } from "zod";
-import { test, expect } from "vitest";
+import { test, expect, vi } from "vitest";
 import { Client } from "@modelcontextprotocol/sdk/client/index.js";
 import { SSEClientTransport } from "@modelcontextprotocol/sdk/client/sse.js";
 import { getRandomPort } from "get-port-please";
 import { EventSource } from "eventsource";
+import { setTimeout as delay } from "timers/promises";
+import { ErrorCode, McpError } from "@modelcontextprotocol/sdk/types.js";
 
 // @ts-expect-error - figure out how to use --experimental-eventsource with vitest
 global.EventSource = EventSource;
@@ -98,6 +100,167 @@ test("adds tools", async () => {
   });
 });
 
+test("calls a tool", async () => {
+  await runWithTestServer({
+    start: async () => {
+      const server = new FastMCP({
+        name: "Test",
+        version: "1.0.0",
+      });
+
+      server.addTool({
+        name: "add",
+        description: "Add two numbers",
+        parameters: z.object({
+          a: z.number(),
+          b: z.number(),
+        }),
+        execute: async (args) => {
+          return args.a + args.b;
+        },
+      });
+
+      return server;
+    },
+    run: async ({ client }) => {
+      expect(
+        await client.callTool({
+          name: "add",
+          arguments: {
+            a: 1,
+            b: 2,
+          },
+        }),
+      ).toEqual({
+        content: [{ type: "text", text: "3" }],
+      });
+    },
+  });
+});
+
+test("handles UserError errors", async () => {
+  await runWithTestServer({
+    start: async () => {
+      const server = new FastMCP({
+        name: "Test",
+        version: "1.0.0",
+      });
+
+      server.addTool({
+        name: "add",
+        description: "Add two numbers",
+        parameters: z.object({
+          a: z.number(),
+          b: z.number(),
+        }),
+        execute: async (args) => {
+          throw new UserError("Something went wrong");
+        },
+      });
+
+      return server;
+    },
+    run: async ({ client }) => {
+      expect(
+        await client.callTool({
+          name: "add",
+          arguments: {
+            a: 1,
+            b: 2,
+          },
+        }),
+      ).toEqual({
+        content: [{ type: "text", text: "Something went wrong" }],
+        isError: true,
+      });
+    },
+  });
+});
+
+test("calling an unknown tool throws McpError with MethodNotFound code", async () => {
+  await runWithTestServer({
+    start: async () => {
+      const server = new FastMCP({
+        name: "Test",
+        version: "1.0.0",
+      });
+
+      return server;
+    },
+    run: async ({ client }) => {
+      try {
+        await client.callTool({
+          name: "add",
+          arguments: {
+            a: 1,
+            b: 2,
+          },
+        });
+      } catch (error) {
+        expect(error).toBeInstanceOf(McpError);
+
+        // @ts-expect-error - we know that error is an McpError
+        expect(error.code).toBe(ErrorCode.MethodNotFound);
+      }
+    },
+  });
+});
+
+test("tracks tool progress", async () => {
+  await runWithTestServer({
+    start: async () => {
+      const server = new FastMCP({
+        name: "Test",
+        version: "1.0.0",
+      });
+
+      server.addTool({
+        name: "add",
+        description: "Add two numbers",
+        parameters: z.object({
+          a: z.number(),
+          b: z.number(),
+        }),
+        execute: async (args, { reportProgress }) => {
+          reportProgress({
+            progress: 0,
+            total: 10,
+          });
+
+          await delay(100);
+
+          return args.a + args.b;
+        },
+      });
+
+      return server;
+    },
+    run: async ({ client }) => {
+      const onProgress = vi.fn();
+
+      await client.callTool(
+        {
+          name: "add",
+          arguments: {
+            a: 1,
+            b: 2,
+          },
+        },
+        undefined,
+        {
+          onprogress: onProgress,
+        },
+      );
+
+      expect(onProgress).toHaveBeenCalledTimes(1);
+      expect(onProgress).toHaveBeenCalledWith({
+        progress: 0,
+        total: 10,
+      });
+    },
+  });
+});
+
 test("adds resources", async () => {
   await runWithTestServer({
     start: async () => {

package/src/FastMCP.ts

@@ -16,13 +16,51 @@ import { zodToJsonSchema } from "zod-to-json-schema";
 import type { z } from "zod";
 import http from "http";
 
+abstract class FastMCPError extends Error {
+  public constructor(message?: string) {
+    super(message);
+    this.name = new.target.name;
+  }
+}
+
+type Extra = unknown;
+
+type Extras = Record<string, Extra>;
+
+class UnexpectedStateError extends FastMCPError {
+  public extras?: Extras;
+
+  public constructor(message: string, extras?: Extras) {
+    super(message);
+    this.name = new.target.name;
+    this.extras = extras;
+  }
+}
+
+export class UserError extends UnexpectedStateError {}
+
 type ToolParameters = z.ZodTypeAny;
 
+type Progress = {
+  /**
+   * The progress thus far. This should increase every time progress is made, even if the total is unknown.
+   */
+  progress: number;
+  /**
+   * Total number of items to process (or total progress required), if known.
+   */
+  total?: number;
+};
+
+type Context = {
+  reportProgress: (progress: Progress) => Promise<void>;
+};
+
 type Tool<Params extends ToolParameters = ToolParameters> = {
   name: string;
   description?: string;
   parameters?: Params;
-  execute: (args: z.infer<Params>) => Promise<unknown>;
+  execute: (args: z.infer<Params>, context: Context) => Promise<unknown>;
 };
 
 type Resource = {
@@ -118,54 +156,78 @@ export class FastMCP {
       };
     });
 
-    server.setRequestHandler(CallToolRequestSchema, async (request) => {
-      const tool = this.#tools.find(
-        (tool) => tool.name === request.params.name,
-      );
-
-      if (!tool) {
-        throw new McpError(
-          ErrorCode.MethodNotFound,
-          `Unknown tool: ${request.params.name}`,
+    server.setRequestHandler(
+      CallToolRequestSchema,
+      async (request, ...extra) => {
+        const tool = this.#tools.find(
+          (tool) => tool.name === request.params.name,
         );
-      }
-
-      let args: any = undefined;
 
-      if (tool.parameters) {
-        const parsed = tool.parameters.safeParse(request.params.arguments);
-
-        if (!parsed.success) {
+        if (!tool) {
           throw new McpError(
-            ErrorCode.InvalidRequest,
-            `Invalid ${request.params.name} arguments`,
+            ErrorCode.MethodNotFound,
+            `Unknown tool: ${request.params.name}`,
           );
         }
 
-        args = parsed.data;
-      }
+        let args: any = undefined;
 
-      let result: any;
+        if (tool.parameters) {
+          const parsed = tool.parameters.safeParse(request.params.arguments);
 
-      try {
-        result = await tool.execute(args);
-      } catch (error) {
-        return {
-          content: [{ type: "text", text: `Error: ${error}` }],
-          isError: true,
-        };
-      }
+          if (!parsed.success) {
+            throw new McpError(
+              ErrorCode.InvalidRequest,
+              `Invalid ${request.params.name} arguments`,
+            );
+          }
+
+          args = parsed.data;
+        }
+
+        const progressToken = request.params?._meta?.progressToken;
+
+        let result: any;
+
+        try {
+          const reportProgress = async (progress: Progress) => {
+            await server.notification({
+              method: "notifications/progress",
+              params: {
+                ...progress,
+                progressToken,
+              },
+            });
+          };
+
+          result = await tool.execute(args, {
+            reportProgress,
+          });
+        } catch (error) {
+          if (error instanceof UserError) {
+            return {
+              content: [{ type: "text", text: error.message }],
+              isError: true,
+            };
+          }
+
+          return {
+            content: [{ type: "text", text: `Error: ${error}` }],
+            isError: true,
+          };
+        }
+
+        if (typeof result === "string") {
+          return {
+            content: [{ type: "text", text: result }],
+          };
+        }
 
-      if (typeof result === "string") {
         return {
-          content: [{ type: "text", text: result }],
+          content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
         };
-      }
-
-      return {
-        content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
-      };
-    });
+      },
+    );
   }
 
   private setupResourceHandlers(server: Server) {