fastmcp 1.27.0 → 1.27.1

package/.github/workflows/feature.yaml

@@ -33,5 +33,7 @@ jobs:
           cache-dependency-path: "**/pnpm-lock.yaml"
       - name: Install dependencies
         run: pnpm install
+      - name: Run lint
+        run: pnpm lint
       - name: Run tests
         run: pnpm test

package/.github/workflows/main.yaml

@@ -37,6 +37,8 @@ jobs:
           cache-dependency-path: "**/pnpm-lock.yaml"
       - name: Install dependencies
         run: pnpm install
+      - name: Run lint
+        run: pnpm lint
       - name: Run tests
         run: pnpm test
       - name: Build

package/README.md

@@ -81,6 +81,8 @@ npx fastmcp dev src/examples/addition.ts
 npx fastmcp inspect src/examples/addition.ts
 ```
 
+If you are looking for a boilerplate repository to build your own MCP server, check out [fastmcp-boilerplate](https://github.com/punkpeye/fastmcp-boilerplate).
+
 ### Remote Server Options
 
 FastMCP supports multiple transport options for remote communication, allowing an MCP hosted on a remote machine to be accessed over the network.
@@ -158,7 +160,9 @@ const client = new Client(
   },
 );
 
-const transport = new StreamableHTTPClientTransport(new URL(`http://localhost:8080/stream`));
+const transport = new StreamableHTTPClientTransport(
+  new URL(`http://localhost:8080/stream`),
+);
 
 await client.connect(transport);
 ```
@@ -368,12 +372,13 @@ const server = new FastMCP({
     // Configure ping interval in milliseconds (default: 5000ms)
     intervalMs: 10000,
     // Set log level for ping-related messages (default: 'debug')
-    logLevel: 'debug'
-  }
+    logLevel: "debug",
+  },
 });
 ```
 
 By default, ping behavior is optimized for each transport type:
+
 - Enabled for SSE and HTTP streaming connections (which benefit from keep-alive)
 - Disabled for `stdio` connections (where pings are typically unnecessary)
 
@@ -391,11 +396,12 @@ const server = new FastMCP({
     // Set to false to explicitly disable roots support
     enabled: false,
     // By default, roots support is enabled (true)
-  }
+  },
 });
 ```
 
 This provides the following benefits:
+
 - Better compatibility with different clients that may not support Roots
 - Reduced error logs when connecting to clients that don't implement roots capability
 - More explicit control over MCP server capabilities
@@ -406,10 +412,10 @@ You can listen for root changes in your server:
 ```ts
 server.on("connect", (event) => {
   const session = event.session;
-  
+
   // Access the current roots
   console.log("Initial roots:", session.roots);
-  
+
   // Listen for changes to the roots
   session.on("rootsChanged", (event) => {
     console.log("Roots changed:", event.roots);
@@ -1041,6 +1047,10 @@ Follow the guide https://modelcontextprotocol.io/quickstart/user and add the fol
 >
 > If you've developed a server using FastMCP, please [submit a PR](https://github.com/punkpeye/fastmcp) to showcase it here!
 
+> [!NOTE]
+>
+> If you are looking for a boilerplate repository to build your own MCP server, check out [fastmcp-boilerplate](https://github.com/punkpeye/fastmcp-boilerplate).
+
 - [apinetwork/piapi-mcp-server](https://github.com/apinetwork/piapi-mcp-server) - generate media using Midjourney/Flux/Kling/LumaLabs/Udio/Chrip/Trellis
 - [domdomegg/computer-use-mcp](https://github.com/domdomegg/computer-use-mcp) - controls your computer
 - [LiterallyBlah/Dradis-MCP](https://github.com/LiterallyBlah/Dradis-MCP) – manages projects and vulnerabilities in Dradis

package/dist/bin/fastmcp.js

@@ -20,7 +20,7 @@ await yargs(hideBin(process.argv)).scriptName("fastmcp").command(
         stderr: "inherit",
         stdin: "inherit",
         stdout: "inherit"
-      })`npx @wong2/mcp-cli npx tsx ${argv.file}`;
+      })`npx -y @wong2/mcp-cli npx -y tsx ${argv.file}`;
     } catch (error) {
       console.error(
         "[FastMCP Error] Failed to start development server:",
@@ -44,7 +44,7 @@ await yargs(hideBin(process.argv)).scriptName("fastmcp").command(
       await execa({
         stderr: "inherit",
         stdout: "inherit"
-      })`npx @modelcontextprotocol/inspector npx tsx ${argv.file}`;
+      })`npx -y @modelcontextprotocol/inspector npx -y tsx ${argv.file}`;
     } catch (error) {
       console.error(
         "[FastMCP Error] Failed to inspect server:",

package/dist/bin/fastmcp.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/bin/fastmcp.ts"],"sourcesContent":["#!/usr/bin/env node\n\nimport { execa } from \"execa\";\nimport yargs from \"yargs\";\nimport { hideBin } from \"yargs/helpers\";\n\nawait yargs(hideBin(process.argv))\n  .scriptName(\"fastmcp\")\n  .command(\n    \"dev <file>\",\n    \"Start a development server\",\n    (yargs) => {\n      return yargs.positional(\"file\", {\n        demandOption: true,\n        describe: \"The path to the server file\",\n        type: \"string\",\n      });\n    },\n    async (argv) => {\n      try {\n        await execa({\n          stderr: \"inherit\",\n          stdin: \"inherit\",\n          stdout: \"inherit\",\n        })`npx @wong2/mcp-cli npx tsx ${argv.file}`;\n      } catch (error) {\n        console.error(\n          \"[FastMCP Error] Failed to start development server:\",\n          error instanceof Error ? error.message : String(error),\n        );\n        process.exit(1);\n      }\n    },\n  )\n  .command(\n    \"inspect <file>\",\n    \"Inspect a server file\",\n    (yargs) => {\n      return yargs.positional(\"file\", {\n        demandOption: true,\n        describe: \"The path to the server file\",\n        type: \"string\",\n      });\n    },\n    async (argv) => {\n      try {\n        await execa({\n          stderr: \"inherit\",\n          stdout: \"inherit\",\n        })`npx @modelcontextprotocol/inspector npx tsx ${argv.file}`;\n      } catch (error) {\n        console.error(\n          \"[FastMCP Error] Failed to inspect server:\",\n          error instanceof Error ? error.message : String(error),\n        );\n        process.exit(1);\n      }\n    },\n  )\n  .help()\n  .parseAsync();\n"],"mappings":";;;AAEA,SAAS,aAAa;AACtB,OAAO,WAAW;AAClB,SAAS,eAAe;AAExB,MAAM,MAAM,QAAQ,QAAQ,IAAI,CAAC,EAC9B,WAAW,SAAS,EACpB;AAAA,EACC;AAAA,EACA;AAAA,EACA,CAACA,WAAU;AACT,WAAOA,OAAM,WAAW,QAAQ;AAAA,MAC9B,cAAc;AAAA,MACd,UAAU;AAAA,MACV,MAAM;AAAA,IACR,CAAC;AAAA,EACH;AAAA,EACA,OAAO,SAAS;AACd,QAAI;AACF,YAAM,MAAM;AAAA,QACV,QAAQ;AAAA,QACR,OAAO;AAAA,QACP,QAAQ;AAAA,MACV,CAAC,+BAA+B,KAAK,IAAI;AAAA,IAC3C,SAAS,OAAO;AACd,cAAQ;AAAA,QACN;AAAA,QACA,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;AAAA,MACvD;AACA,cAAQ,KAAK,CAAC;AAAA,IAChB;AAAA,EACF;AACF,EACC;AAAA,EACC;AAAA,EACA;AAAA,EACA,CAACA,WAAU;AACT,WAAOA,OAAM,WAAW,QAAQ;AAAA,MAC9B,cAAc;AAAA,MACd,UAAU;AAAA,MACV,MAAM;AAAA,IACR,CAAC;AAAA,EACH;AAAA,EACA,OAAO,SAAS;AACd,QAAI;AACF,YAAM,MAAM;AAAA,QACV,QAAQ;AAAA,QACR,QAAQ;AAAA,MACV,CAAC,gDAAgD,KAAK,IAAI;AAAA,IAC5D,SAAS,OAAO;AACd,cAAQ;AAAA,QACN;AAAA,QACA,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;AAAA,MACvD;AACA,cAAQ,KAAK,CAAC;AAAA,IAChB;AAAA,EACF;AACF,EACC,KAAK,EACL,WAAW;","names":["yargs"]}
+{"version":3,"sources":["../../src/bin/fastmcp.ts"],"sourcesContent":["#!/usr/bin/env node\n\nimport { execa } from \"execa\";\nimport yargs from \"yargs\";\nimport { hideBin } from \"yargs/helpers\";\n\nawait yargs(hideBin(process.argv))\n  .scriptName(\"fastmcp\")\n  .command(\n    \"dev <file>\",\n    \"Start a development server\",\n    (yargs) => {\n      return yargs.positional(\"file\", {\n        demandOption: true,\n        describe: \"The path to the server file\",\n        type: \"string\",\n      });\n    },\n    async (argv) => {\n      try {\n        await execa({\n          stderr: \"inherit\",\n          stdin: \"inherit\",\n          stdout: \"inherit\",\n        })`npx -y @wong2/mcp-cli npx -y tsx ${argv.file}`;\n      } catch (error) {\n        console.error(\n          \"[FastMCP Error] Failed to start development server:\",\n          error instanceof Error ? error.message : String(error),\n        );\n        process.exit(1);\n      }\n    },\n  )\n  .command(\n    \"inspect <file>\",\n    \"Inspect a server file\",\n    (yargs) => {\n      return yargs.positional(\"file\", {\n        demandOption: true,\n        describe: \"The path to the server file\",\n        type: \"string\",\n      });\n    },\n    async (argv) => {\n      try {\n        await execa({\n          stderr: \"inherit\",\n          stdout: \"inherit\",\n        })`npx -y @modelcontextprotocol/inspector npx -y tsx ${argv.file}`;\n      } catch (error) {\n        console.error(\n          \"[FastMCP Error] Failed to inspect server:\",\n          error instanceof Error ? error.message : String(error),\n        );\n        process.exit(1);\n      }\n    },\n  )\n  .help()\n  .parseAsync();\n"],"mappings":";;;AAEA,SAAS,aAAa;AACtB,OAAO,WAAW;AAClB,SAAS,eAAe;AAExB,MAAM,MAAM,QAAQ,QAAQ,IAAI,CAAC,EAC9B,WAAW,SAAS,EACpB;AAAA,EACC;AAAA,EACA;AAAA,EACA,CAACA,WAAU;AACT,WAAOA,OAAM,WAAW,QAAQ;AAAA,MAC9B,cAAc;AAAA,MACd,UAAU;AAAA,MACV,MAAM;AAAA,IACR,CAAC;AAAA,EACH;AAAA,EACA,OAAO,SAAS;AACd,QAAI;AACF,YAAM,MAAM;AAAA,QACV,QAAQ;AAAA,QACR,OAAO;AAAA,QACP,QAAQ;AAAA,MACV,CAAC,qCAAqC,KAAK,IAAI;AAAA,IACjD,SAAS,OAAO;AACd,cAAQ;AAAA,QACN;AAAA,QACA,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;AAAA,MACvD;AACA,cAAQ,KAAK,CAAC;AAAA,IAChB;AAAA,EACF;AACF,EACC;AAAA,EACC;AAAA,EACA;AAAA,EACA,CAACA,WAAU;AACT,WAAOA,OAAM,WAAW,QAAQ;AAAA,MAC9B,cAAc;AAAA,MACd,UAAU;AAAA,MACV,MAAM;AAAA,IACR,CAAC;AAAA,EACH;AAAA,EACA,OAAO,SAAS;AACd,QAAI;AACF,YAAM,MAAM;AAAA,QACV,QAAQ;AAAA,QACR,QAAQ;AAAA,MACV,CAAC,sDAAsD,KAAK,IAAI;AAAA,IAClE,SAAS,OAAO;AACd,cAAQ;AAAA,QACN;AAAA,QACA,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;AAAA,MACvD;AACA,cAAQ,KAAK,CAAC;AAAA,IAChB;AAAA,EACF;AACF,EACC,KAAK,EACL,WAAW;","names":["yargs"]}

package/eslint.config.ts

@@ -1,7 +1,7 @@
-import eslint from '@eslint/js';
+import eslint from "@eslint/js";
 import eslintConfigPrettier from "eslint-config-prettier/flat";
 import perfectionist from "eslint-plugin-perfectionist";
-import tseslint from 'typescript-eslint';
+import tseslint from "typescript-eslint";
 
 export default tseslint.config(
   eslint.configs.recommended,
@@ -10,5 +10,5 @@ export default tseslint.config(
   eslintConfigPrettier,
   {
     ignores: ["**/*.js"],
-  }
+  },
 );

package/jsr.json

@@ -1,6 +1,6 @@
 {
   "name": "@glama/fastmcp",
-  "version": "1.27.0",
+  "version": "1.27.1",
   "exports": "./src/FastMCP.ts",
   "include": ["src/FastMCP.ts", "src/bin/fastmcp.ts"]
 }

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "fastmcp",
-  "version": "1.27.0",
+  "version": "1.27.1",
   "main": "dist/FastMCP.js",
   "scripts": {
     "build": "tsup",
-    "test": "vitest run && tsc && jsr publish --dry-run",
+    "lint": "prettier --check . && eslint . && tsc --noEmit && jsr publish --dry-run",
+    "test": "vitest run",
     "format": "prettier --write . && eslint --fix ."
   },
   "bin": {

package/src/FastMCP.test.ts

@@ -17,12 +17,12 @@ import { expect, test, vi } from "vitest";
 import { z } from "zod";
 
 import {
+  type ContentResult,
   FastMCP,
   FastMCPSession,
   imageContent,
-  UserError,
   type TextContent,
-  type ContentResult,
+  UserError,
 } from "./FastMCP.js";
 
 const runWithTestServer = async ({
@@ -1004,17 +1004,6 @@ test("session listens to roots changes", async () => {
 
 test("session sends pings to the client", async () => {
   await runWithTestServer({
-    server: async () => {
-      const server = new FastMCP({
-        name: "Test",
-        version: "1.0.0",
-        ping: {
-          enabled: true,
-          intervalMs: 1000,
-        },
-      });
-      return server;
-    },
     run: async ({ client }) => {
       const onPing = vi.fn().mockReturnValue({});
 
@@ -1025,6 +1014,17 @@ test("session sends pings to the client", async () => {
       expect(onPing.mock.calls.length).toBeGreaterThanOrEqual(1);
       expect(onPing.mock.calls.length).toBeLessThanOrEqual(3);
     },
+    server: async () => {
+      const server = new FastMCP({
+        name: "Test",
+        ping: {
+          enabled: true,
+          intervalMs: 1000,
+        },
+        version: "1.0.0",
+      });
+      return server;
+    },
   });
 });
 

package/src/bin/fastmcp.ts

@@ -22,7 +22,7 @@ await yargs(hideBin(process.argv))
           stderr: "inherit",
           stdin: "inherit",
           stdout: "inherit",
-        })`npx @wong2/mcp-cli npx tsx ${argv.file}`;
+        })`npx -y @wong2/mcp-cli npx -y tsx ${argv.file}`;
       } catch (error) {
         console.error(
           "[FastMCP Error] Failed to start development server:",
@@ -47,7 +47,7 @@ await yargs(hideBin(process.argv))
         await execa({
           stderr: "inherit",
           stdout: "inherit",
-        })`npx @modelcontextprotocol/inspector npx tsx ${argv.file}`;
+        })`npx -y @modelcontextprotocol/inspector npx -y tsx ${argv.file}`;
       } catch (error) {
         console.error(
           "[FastMCP Error] Failed to inspect server:",

package/src/examples/addition.ts

@@ -1,3 +1,9 @@
+/**
+ * This is an example of a FastMCP server that adds two numbers.
+ *
+ * If you are looking for a complete example of an MCP server repository,
+ * see https://github.com/punkpeye/fastmcp-boilerplate
+ */
 import { type } from "arktype";
 import * as v from "valibot";
 import { z } from "zod";